Web AI Search Q&A

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default value:

N/A

application_id

Yes

String

Definition:

Application ID. For details about how to obtain the application ID, see Obtaining an Application ID.

Constraints:

Character string

Value range:

The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default value:

N/A

Token

No

String

Definition:

After a user logs in, a token is created for authentication based on the user login information.

The user validity is verified through authentication.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

X-Auth-Token

Yes

String

Definition:

Token used for API authentication. For details about how to obtain the token, see Obtaining an IAM User Token.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

repo_id

No

String

Definition:

Knowledge base ID.

Constraints:

N/A

Value range:

The value can contain 1 to 64 characters. It can only contain letters, digits, underscores (_), and hyphens (-).

Default value:

N/A

chat_id

No

String

Definition:

Chat ID.

Constraints:

N/A

Value range:

The value can contain 1 to 64 characters. It can only contain letters, digits, underscores (_), and hyphens (-).

Default value:

N/A

query

Yes

String

Definition:

User question.

Constraints:

N/A

Value range:

The value cannot be empty. It can contain a maximum of 20,480 characters.

Default value:

N/A

history

No

Array of strings

Definition:

Chat history.

Implementation logic:

1. Only the last five rounds of dialogs are considered.

2. Only 300 to 500 characters are considered in a single round of dialog.

Constraints:

1. The number of elements must be an even number, for example, [Question1, Answer1, Question2, Answer2].

2. The chats are ordered from old to new.

3. Question is mandatory.

4. Answer can be an empty string but must be placed.

Value range:

The list length cannot exceed 40 characters.

Default value:

N/A

stream

No

Boolean

Definition:

Streaming output switch.

Constraints:

N/A

Value range:

• true: Enable streaming output.

• false: Disable streaming output.

Default value:

N/A

prompt_template

No

String

Definition:

Prompt template, which provides the query and docs context.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

file_ids

No

Array of strings

Definition:

File-based Q&A.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

thinking_enabled

No

Boolean

Definition:

Deep thinking.

Constraints:

N/A

Value range:

• true: deep thinking

• false: no deep thinking

Default value:

false

search_enabled

No

Boolean

Definition:

Online search.

Constraints:

N/A

Value range:

• true: Search the Internet.

• false: Do not search the Internet.

Default value:

false

model

No

String

Definition:

Model name

Constraints:

The mllm_plan model must have already been configured on the platform. You can check the models configured on the platform using the ListModels API.

Value range:

The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default value:

N/A

max_tokens

No

Integer

Definition:

Maximum number of tokens in the generated text.

The total length of the input text plus the generated text cannot exceed the maximum length that the model can process.

Constraints:

Value range:

1 to 131,072 characters

Default value:

4096

chat_temperature

No

Float

Definition:

Diversity of non-RAG model's output

temperature controls the probability distribution of each candidate word when the text is generated.

Constraints:

N/A

Value range:

0-1

Default value:

0.6

search_temperature

No

Float

Definition:

Diversity of the RAG model's output

temperature controls the probability distribution of each candidate word when the text is generated.

Constraints:

N/A

Value range:

0-1

Default value:

0.6

presence_penalty

No

Float

Definition:

Text repetition penalty.

Constraints:

N/A

Value range:

-2~2

Default value:

0

top_p

No

Float

Definition:

Probability threshold used by the sampling method during generation

Constraints:

N/A

Value range:

0~1

Default value:

0.1

chat_id

String

Definition:

Chat ID.

chat_result

ChatResult object

Definition:

Dialog result.

documents

Array of Document objects

Definition:

Web search result.

index

Integer

Definition:

No.

Value range:

N/A

message

String

Definition:

Text content.

Value range:

N/A

question_id

String

Definition:

Q&A ID.

Value range:

N/A

title

String

Definition:

Title. Use this name and URL to create a hyperlink. Clicking the hyperlink will take the user to the web page.

Value range:

N/A

content

String

Definition:

Content.

Value range:

N/A

url

String

Definition:

Hyperlink.

Value range:

N/A

timestamp

String

Definition:

Update time (time when the web page is captured last time). The date format is YYYY-MM-DDTHH:MM:SS.

Value range:

N/A

site_name

String

Definition:

Site name

Value range:

N/A

site_icon

String

Definition:

Site icon address.

Value range:

N/A

type

String

Definition:

Search type.

Value range:

N/A

id

String

Definition:

ID.

Value range:

N/A

size

Long

Definition:

Size.

Value range:

N/A

has_html

Boolean

Definition:

Whether HTML is used.

Value range:

• true: The result is in HTML.

• false: The result is not in HTML.

source

String

Definition:

Source

Value range:

N/A

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

200

AI search response.

400

Client error.

500

Server error.