Obtaining the Prompt List

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

page_num

No

Integer

Definition:

Page number of the current request, indicating the start page from data retrieval. The default value is 1, indicating to start from the first page.

Constraints:

N/A

Value range:

1-65535

Default value:

1

page_size

No

Integer

Definition:

Number of records displayed on each page, indicating the number of records returned per request. The default value is 10, indicating that 10 records are displayed on each page.

Constraints:

N/A

Value range:

1-65535

Default value:

10

name

No

String

Definition:

Prompt matching query.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

prompt_type

No

String

Definition:

Prompt type matching query, which will be discarded later.

Constraints:

N/A

Value range:

Prompt types

• DEFAULT_CHAT_PROMPT: default RAG prompt

• DEFAULT_QA_ANSWER_PROMPT: default QA answer generation prompt

• DEFAULT_QA_QUESTION_PROMPT: default QA question generation prompt

• CHAT_PROMPT: RAG prompt

• QA_QUESTION_PROMPT: QA answer generation prompt

• QA_ANSWER_PROMPT: QA question generation prompt

Default value:

N/A

prompt_types

No

Array of strings

Definition:

Prompt type list (new).

Constraints:

N/A

Value range:

Prompt types

• DEFAULT_CHAT_PROMPT: default RAG prompt

• DEFAULT_QA_ANSWER_PROMPT: default QA answer generation prompt

• DEFAULT_QA_QUESTION_PROMPT: default QA question generation prompt

• CHAT_PROMPT: RAG prompt

• QA_QUESTION_PROMPT: QA answer generation prompt

• QA_ANSWER_PROMPT: QA question generation prompt

Default value:

N/A

lod

No

String

Definition:

Level of details in the query result returned by the API. You can customize this to return more or less information.

Constraints:

N/A

Value range:

• simple

• detail: detailed

Default value:

detail

create_user

No

String

Definition:

Creator filter.

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

page_num

String

Definition:

Page turning flag.

Value range:

N/A

page_size

String

Definition:

Page turning size.

Value range:

N/A

total

String

Definition:

Data size

Value range:

N/A

data_list

Array of GetPromptResponseBody objects

Definition:

Prompt list.

Value range:

N/A

id

String

Definition:

Prompt ID.

Value range:

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

name

String

Definition:

Prompt name.

Value range:

The value contains a maximum of 64 characters.

detail

String

Definition:

Prompt description.

Value range:

The value contains a maximum of 64 characters.

type

String

Definition:

Prompt type.

Value range:

N/A

create_time

String

Definition:

Prompt creation time.

Value range:

N/A

update_time

String

Definition:

Prompt update time.

Value range:

N/A

prompts

Array of PromptItem objects

Definition:

Prompt language list.

Value range:

N/A

knowledge_repos

Array of KnowledgeRepoItem objects

Definition:

Knowledge base information.

Value range:

N/A

actions

Array of strings

Definition:

Permissions.

Value range:

N/A

freemarker_enabled

Boolean

Definition:

Whether to enable the FreeMarker template engine.

Constraints:

N/A

Value range:

• true: enable

• false: disable

Default value:

false

search_scope

String

Definition:

Search scope.

Value range:

• DOCUMENT: document library

• FAQ

• KEYWORD: search by keywords

• MIX: hybrid search

• PANGU_WIKI: built-in knowledge base

• WEB: web search engine

• TABLE: tabular data only

creator

String

Definition:

Prompt creator.

Value range:

N/A

language

String

Definition:

Language name.

Constraints:

N/A

Value range:

• zh==CHINESE

• en==ENGLISH

• th==THAI

• ar==ARABIC

• es==SPANISH

• pt==PORTUGUESE

Default value:

N/A

prompt

String

Definition:

Prompt.

Constraints:

N/A

Value range:

The value contains a maximum of 8,192 characters.

Default value:

N/A

attention

String

Definition:

Notes.

Constraints:

N/A

Value range:

The maximum length is 65,535 characters.

Default value:

N/A

id

String

Definition:

Knowledge base ID.

Value range:

N/A

name

String

Definition:

Knowledge base name.

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

Obtain the prompt list.

400

Incorrect request body parameter.

500

Internal error.