Data Types
Last updated: 2025-10-30 21:49:08
Data Types
Last updated: 2025-10-30 21:49:08
AICallConfig
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| EnableVoiceInteract | Boolean | No | |
| EnableVoiceCall | Boolean | No | |
| EnableDigitalHuman | Boolean | No | |
| Voice | VoiceConfig | No | |
| DigitalHuman | DigitalHumanConfig | No |
AgentDebugInfo
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Input | String | No | |
| Output | String | No |
AgentProcedure
Process information of the thought event.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Index | Integer | No | Index. |
| Name | String | No | English name of the execution process. |
| Title | String | No | Chinese name for display. |
| Status | String | No | Status constant: processing; success; failed. |
| Icon | String | No | Icon. |
| Debugging | AgentProcedureDebugging | No | Agent debugging information. |
| Switch | String | No | Whether to switch to Agent. The value can be "main" or "workflow". Leave it blank for no switch. |
| WorkflowName | String | No | Workflow name. |
| Elapsed | Integer | No | Current request execution time, in milliseconds. |
| NodeName | String | No | Workflow node name. |
| ReplyIndex | Integer | No | Used to display in which reply bubble the thoughts are placed. |
| SourceAgentName | String | No | Main agent. |
| TargetAgentName | String | No | Registration agent. |
| AgentIcon | String | No | Icon of Agent. |
AgentProcedureDebugging
Debugging information of the agent thinking process.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Content | String | No | Model thinking content. |
| DisplayContent | String | No | The specific text content to be displayed. |
| DisplayType | Integer | No | Display type. |
| QuoteInfos | Array of QuoteInfo | No | Index displayed by the search engine. |
| References | Array of AgentReference | No | Specific reference source. |
| DisplayStatus | String | No | Display the ongoing status. |
| SandboxUrl | String | No | URL of cloud desktop. |
| DisplayUrl | String | No | URL opened through the browser in cloud desktop. |
AgentReference
Reference source in agent.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| DocId | String | No | Source document ID. |
| Id | String | No | ID. |
| Name | String | No | Name. |
| Type | Integer | No | Type. |
| Url | String | No | URL. |
| DocBizId | String | No | Document business ID. |
| DocName | String | No | Document name. |
| QaBizId | String | No | Q&A business ID. |
| Index | Integer | No | Index of search engine. |
| Title | String | No | Title. |
AgentThought
The thinking process of Agent.
Used by actions: GetMsgRecord.
| Name | Type | Description |
|---|---|---|
| SessionId | String | Session ID. |
| RequestId | String | Request ID |
| RecordId | String | It corresponds to a session, session ID, used for message storage in answering. It can be generated in advance and used when saving messages. |
| Elapsed | Integer | Current request execution time, in milliseconds. |
| IsWorkflow | Boolean | Whether it is a workflow currently. |
| WorkflowName | String | If it is a workflow, workflow name. |
| Procedures | Array of AgentProcedure | Detailed thinking process. |
| TraceId | String | TraceId. |
| Files | Array of FileInfo | File information |
ApiVarAttrInfo
Data of custom variable and label relationship.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| ApiVarId | String | No | Custom variable ID. |
| AttrBizId | String | No | Label ID. |
AppConfig
Application configuration.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| KnowledgeQa | KnowledgeQaConfig | No | Knowledge Q&A management application configuration |
| Summary | SummaryConfig | No | Knowledge summary application configuration. |
| Classify | ClassifyConfig | No | Label extraction application configuration. |
AppInfo
Application details
Used by actions: ListApp.
| Name | Type | Required | Description |
|---|---|---|---|
| AppType | String | No | Application type; knowledge_qa - knowledge Q&A management; summary - knowledge summary; classifys - knowledge label extraction. |
| AppTypeDesc | String | No | Application type description. |
| AppBizId | String | No | Application ID. |
| Name | String | No | Application name. |
| Avatar | String | No | Application avatar. |
| Desc | String | No | Application description. |
| AppStatus | Integer | No | Application status. 1: offline; 2: running; 3: disabled. |
| AppStatusDesc | String | No | Status description. |
| UpdateTime | String | No | Update time. |
| Operator | String | No | Last modifier. |
| ModelName | String | No | Model name. |
| ModelAliasName | String | No | Alias of the generative model. |
| Pattern | String | No | Application mode: standard; agent; single_workflow. |
| ThoughtModelAliasName | String | No | Alias of the thought model. |
AppModel
Application model configuration.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Model name. |
| Desc | String | No | Model description. |
| ContextLimit | Integer | No | The round referenced by the context. |
| AliasName | String | No | Model alias. |
| TokenBalance | Float | No | Remaining token quota. |
| IsUseContext | Boolean | No | Whether to use the round referenced by the context. |
| HistoryLimit | Integer | No | The number of context memory rounds. |
| UsageType | String | No | Usage type. |
| Temperature | String | No | Model temperature. |
| TopP | String | No | Model TopP. |
| ResourceStatus | Integer | No | Model resource status: 1: available; 2: exhausted. |
AttrLabel
Label details.
Used by actions: DescribeDoc, DescribeQA, ListDoc, ListQA.
| Name | Type | Description |
|---|---|---|
| Source | Integer | Label source. |
| AttrBizId | String | Label ID. |
| AttrKey | String | Label identification. |
| AttrName | String | Label name. |
| Labels | Array of Label | Label value. |
AttrLabelDetail
Label details.
Used by actions: ListAttributeLabel.
| Name | Type | Description |
|---|---|---|
| AttrBizId | String | Label ID. |
| AttrKey | String | Label identification. |
| AttrName | String | Label name. |
| LabelNames | Array of String | Label value name. |
| IsUpdating | Boolean | Whether the label is being updated. |
| Status | Integer | Status. |
| StatusDesc | String | Status description. |
| LabelTotalCount | String | Total number of label values. |
AttrLabelRefer
Label reference information.
Used by actions: CreateQA, ModifyDoc, ModifyDocAttrRange, ModifyQA, ModifyQAAttrRange, SaveDoc.
| Name | Type | Required | Description |
|---|---|---|---|
| Source | Integer | No | Label source, 1: label. |
| AttributeBizId | String | No | Label ID. |
| LabelBizIds | Array of String | No | Label value ID. |
AttributeFilters
Export knowledge label filter.
Used by actions: ExportAttributeLabel.
| Name | Type | Required | Description |
|---|---|---|---|
| Query | String | No | Retrieve, attribute or label name. |
AttributeLabel
Label value.
Used by actions: CreateAttributeLabel, DescribeAttributeLabel, ModifyAttributeLabel.
| Name | Type | Required | Description |
|---|---|---|---|
| LabelBizId | String | No | Standard word ID. |
| LabelName | String | No | Standard word name. |
| SimilarLabels | Array of String | No | Synonym name. |
BaseConfig
Application basic configuration.
Used by actions: CreateApp, DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Application name. |
| Avatar | String | Yes | Application avatar url, required as an input parameter in "CreateApp" and "ModifyApp". Description of input parameter: 1. The image of input URL must be jpeg or png, with a size no more than 500kb, and the URL must allow head requests. 2. If the user does not have object storage, use the "Obtain temporary file upload key" (DescribeStorageCredential) API to obtain the COS temporary key and upload path. Upload the avatar to COS by yourself and get the access link. |
| Desc | String | No | Application description. |
CallDetail
Call type.
Used by actions: ListUsageCallDetail.
| Name | Type | Description |
|---|---|---|
| Id | String | Associated ID. |
| CallTime | String | Call time. |
| TotalTokenUsage | Float | Total token consumption. |
| InputTokenUsage | Float | Token consumption for input. |
| OutputTokenUsage | Float | Token consumption for output. |
| SearchUsage | Integer | Number of search service calls. |
| ModelName | String | Model name. |
| CallType | String | Call type. |
| UinAccount | String | Account. |
| AppName | String | Application name. |
| PageUsage | Integer | Total number of consumed pages. |
| SubScene | String | Filter sub-scenario. |
CateInfo
Category information.
Used by actions: ListDocCate.
| Name | Type | Description |
|---|---|---|
| CateBizId | String | Category ID. |
| Name | String | Category name. |
| Total | Integer | Quantity of records (such as documents, synonyms, etc.) under the category. |
| CanAdd | Boolean | Whether it is possible to add. |
| CanEdit | Boolean | Whether it can be edited. |
| CanDelete | Boolean | Whether it can be deleted. |
| Children | Array of CateInfo | Subcategory. |
ClassifyConfig
Label extraction configuration.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Model | AppModel | No | Model configuration. |
| Labels | Array of ClassifyLabel | No | Label list. |
| Greeting | String | No | Welcome words, within 200 characters. |
ClassifyLabel
Label information.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Label name. |
| Description | String | No | Label description. |
| Values | Array of String | No | Label value range. |
Context
Obtain response of unsatisfied reply context.
Used by actions: DescribeUnsatisfiedReplyContext.
| Name | Type | Description |
|---|---|---|
| RecordBizId | String | Message record ID. |
| IsVisitor | Boolean | Whether it is a user. |
| NickName | String | Nickname. |
| Avatar | String | Avatar. |
| Content | String | Message content. |
| FileInfos | Array of MsgFileInfo | Document information. |
| ReplyMethod | Integer | Response method, 15: clarification confirmation response. |
CreateReconstructDocumentFlowConfig
Configuration information for creating a smart document parsing task.
Used by actions: CreateReconstructDocumentFlow.
| Name | Type | Required | Description |
|---|---|---|---|
| TableResultType | String | No | The returned form of a table in a markdown file: 0: the table is returned in MD format; 1: the table is returned in HTML form. The default is 1. |
| ResultType | String | No | The format of smart document parsing results: 0: only return full-text MD; 1: only return OCR original JSON of each page;. 2: only return MD of each page; 3: return full-text MD + OCR original JSON of each page;. 4: return full-text MD + MD of each page. The default value is 3 (return full-text MD + OCR original JSON of each page). |
Credentials
Temporary key structure.
Used by actions: DescribeStorageCredential.
| Name | Type | Description |
|---|---|---|
| Token | String | Token. |
| TmpSecretId | String | Temporary license key ID. |
| TmpSecretKey | String | Temporary license key. |
| AppId | Integer | Temporary license appid. |
DigitalHumanConfig
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| AssetKey | String | No | |
| Name | String | No | |
| Avatar | String | No |
DocFilterFlag
Used by actions: ListDoc.
| Name | Type | Required | Description |
|---|---|---|---|
| Flag | String | No | |
| Value | Boolean | No |
DocSegment
Document fragment.
Used by actions: DescribeSegments.
| Name | Type | Description |
|---|---|---|
| Id | String | Fragment ID. |
| BusinessId | String | Business ID. |
| FileType | String | File type (markdown, word, txt). |
| SegmentType | String | Document segment type (segment, table). |
| Title | String | Title. |
| PageContent | String | Paragraph content. |
| OrgData | String | Original paragraph. |
| DocId | String | Article ID. |
| DocBizId | String | Document business ID. |
| DocUrl | String | Document URL. |
DuplicateFileHandle
Used by actions: SaveDoc.
| Name | Type | Required | Description |
|---|---|---|---|
| CheckType | Integer | No | |
| HandleType | Integer | No |
ExtraInfo
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| EChartsInfo | Array of String | No |
FileInfo
Real-Time uploaded file information.
Used by actions: GetMsgRecord.
| Name | Type | Description |
|---|---|---|
| FileName | String | File name. |
| FileSize | String | File size. |
| FileUrl | String | URL of the file, address of COS. |
| FileType | String | File type. |
| DocId | String | DocID returned after parsing. |
| CreatedAt | String | Creation time. |
Filters
Retrieve and filter dissatisfied responses.
Used by actions: ExportUnsatisfiedReply.
| Name | Type | Required | Description |
|---|---|---|---|
| Query | String | No | Retrieve user question or answer. |
| Reasons | Array of String | No | Incorrect retrieval type. |
GetWsTokenReq_Label
Obtain ws token label.
Used by actions: GetWsToken.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Label name. |
| Values | Array of String | No | Label value. |
Highlight
Fragment highlight content.
Used by actions: DescribeQA, DescribeRefer.
| Name | Type | Required | Description |
|---|---|---|---|
| StartPos | String | No | Highlight starting position. |
| EndPos | String | No | Highlight end position. |
| Text | String | No | Highlight subtext. |
HistorySummary
Multiple rounds of historical information.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Assistant | String | No | Assistant. |
| User | String | No | User. |
IntentAchievement
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | |
| Desc | String | No |
InvokeAPI
Information of the requested API.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Method | String | No | Request method, such as get/post. |
| Url | String | No | Request address. |
| HeaderValues | Array of StrValue | No | Header parameter. |
| QueryValues | Array of StrValue | No | Input parameter Query. |
| RequestPostBody | String | No | Original data of a Post request. |
| ResponseBody | String | No | Returned original data. |
| ResponseValues | Array of ValueInfo | No | Output parameter. |
| FailMessage | String | No | Exception information. |
KnowledgeCapacityPieGraphDetail
Detailed information of a knowledge library capacity pie chart.
Used by actions: DescribeKnowledgeUsagePieGraph.
| Name | Type | Description |
|---|---|---|
| AppName | String | Current application name. |
| UsedCharSize | String | Number of characters used by the current application. |
| Proportion | Float | Proportion of the current application in total usage. |
KnowledgeDetail
Application usage details of knowledge library capacity.
Used by actions: ListAppKnowledgeDetail.
| Name | Type | Required | Description |
|---|---|---|---|
| AppName | String | No | Application name. |
| UsedCharSize | String | No | Number of used characters. |
| Proportion | Float | No | Usage proportion. |
| ExceedCharSize | String | No | Exceeding character count. |
KnowledgeQaConfig
Knowledge Q&A configuration.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Greeting | String | No | Welcome words, within 200 characters. |
| RoleDescription | String | No | Character description, within 4,000 characters. By filling out the description, set the #Character Name, #Style Characteristics, and reachable #Intent of the application. It is recommended to fill in according to the following template, with custom intents no more than 5. #Character Name: #Style Characteristics: #Output Requirements: #Ability Limitations: The following user intents can be reached. ##Intent Name: ##Intent Description: ##Intent Example: ##Intent Implementation: |
| Model | AppModel | No | Generative model configuration. |
| Search | Array of KnowledgeQaSearch | No | Knowledge search configuration. |
| Output | KnowledgeQaOutput | No | Knowledge management output configuration. |
| Workflow | KnowledgeWorkflow | No | Workflow configuration. |
| SearchRange | SearchRange | No | Retrieval range. |
| Pattern | String | No | Application modes: standard, agent, single_workflow. |
| SearchStrategy | SearchStrategy | No | Retrieve a policy. |
| SingleWorkflow | KnowledgeQaSingleWorkflow | No | Single workflow ID, which is entered when Pattern is single_workflow. |
| Plugins | Array of KnowledgeQaPlugin | No | Application associated plug-in. |
| ThoughtModel | AppModel | No | Thinking model configuration. |
| IntentAchievements | Array of IntentAchievement | No | Priority of intent achievement methods. |
| ImageTextRetrieval | Boolean | No | Whether to enable Image-Text Search. |
| AiCall | AICallConfig | No | Configure voice call parameters. |
| EnableAudit | Boolean | No | Session content moderation switch. Note: 1. This feature is enabled by default if no value is input. 2. Tencent Cloud provides a content pre-filtering feature to help filter high-risk or illegal content. If you do not use our filtering feature, you can disable it here. We hereby remind you that you are responsible for ensuring that your content complies with platform policies and laws and regulations, and that you should fulfill your content moderation obligations. |
KnowledgeQaOutput
Application management output configuration.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Method | Integer | No | Output method, 1: streaming 2: non-streaming. |
| UseGeneralKnowledge | Boolean | No | General model response. |
| BareAnswer | String | No | Unknown response, within 300 characters. |
| ShowQuestionClarify | Boolean | No | Whether to display the question clarification switch. |
| UseQuestionClarify | Boolean | No | Whether to enable question clarification. |
| QuestionClarifyKeywords | Array of String | No | List of keywords for question clarification. |
| UseRecommended | Boolean | No | Whether to enable recommended questions. |
KnowledgeQaPlugin
Information of application-associated plug-in.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| PluginId | String | No | Plugin ID. |
| PluginName | String | No | Plugin name. |
| PluginIcon | String | No | Plugin icon. |
| ToolId | String | No | Tool ID. |
| ToolName | String | No | Tool name. |
| ToolDesc | String | No | Tool description. |
| Inputs | Array of PluginToolReqParam | No | Tool input parameter. |
| IsBindingKnowledge | Boolean | No | Whether the plugin is bound to the knowledge library. |
KnowledgeQaSearch
Retrieval configuration.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | Knowledge source: doc (document), qa (question & answering), taskflow (business process), search (search enhancement). |
| ReplyFlexibility | Integer | No | Q&A - reply flexibility, 1: directly reply if the answer has been accepted. 2: reply after the accepted answer has been polished. |
| UseSearchEngine | Boolean | No | Search enhancement - search engine status. |
| ShowSearchEngine | Boolean | No | Whether to display the search engine retrieval status. |
| IsEnabled | Boolean | No | Knowledge source, whether to select. |
| QaTopN | Integer | No | Maximum number of Q&A recalls, defaults to 2, limited to 5. |
| DocTopN | Integer | No | Maximum number of documents recalls, defaults to 3, limited to 5. |
| Confidence | Float | No | Retrieval confidence degree, valid for documents and Q&A. Value range: 0.01 - 0.99. |
| ResourceStatus | Integer | No | Resource status, 1: the resource is available; 2: the resource is exhausted. |
KnowledgeQaSingleWorkflow
Specifies the single workflow configuration in Q&A knowledge library single workflow mode.
Used by actions: DescribeApp, GetWsToken, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| WorkflowId | String | No | Workflow ID. |
| WorkflowName | String | No | Workflow name. |
| WorkflowDesc | String | No | Workflow description. |
| Status | String | No | Workflow status, publishing status (UNPUBLISHED; PUBLISHING; PUBLISHED; FAIL). |
| IsEnable | Boolean | No | Whether to enable workflow. |
| AsyncWorkflow | Boolean | No | Whether to enable asynchronous call of the workflow. |
KnowledgeSummary
Retrieve knowledge.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | Integer | No | 1: Q&A; 2: document fragment. |
| Content | String | No | Knowledge content. |
KnowledgeWorkflow
Q&A knowledge library workflow configuration.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| IsEnabled | Boolean | No | Whether to enable the workflow. |
| UsePdl | Boolean | No | Whether to enable PDL. |
Label
Label ID.
Used by actions: DescribeDoc, DescribeQA.
| Name | Type | Description |
|---|---|---|
| LabelBizId | String | Label ID. |
| LabelName | String | Label name. |
ListAppCategoryRspOption
Application type details.
Used by actions: ListAppCategory.
| Name | Type | Description |
|---|---|---|
| Text | String | Type name. |
| Value | String | Type value. |
| Logo | String | Type log. |
ListDocItem
Description of document list details.
Used by actions: ListDoc.
| Name | Type | Description |
|---|---|---|
| DocBizId | String | Document ID. |
| FileName | String | File name. |
| NewName | String | The new document name after renaming. This name remains until the document is published after the renaming submission. |
| FileType | String | File type. |
| CosUrl | String | COS path. |
| UpdateTime | String | Update time. |
| Status | Integer | Document status. |
| StatusDesc | String | Document status description. |
| Reason | String | Reason. |
| IsRefer | Boolean | Whether to refer to an answer. |
| QaNum | Integer | Quantity of Q&A pairs. |
| IsDeleted | Boolean | Whether it has been deleted. |
| Source | Integer | Document source. |
| SourceDesc | String | Document source description. |
| IsAllowRestart | Boolean | Whether regeneration is allowed. |
| IsDeletedQa | Boolean | Whether the Q&A has been deleted. |
| IsCreatingQa | Boolean | Whether the Q&A is being generated. |
| IsAllowDelete | Boolean | Whether deletion is allowed. |
| IsAllowRefer | Boolean | Whether to allow operation reference switch. |
| IsCreatedQa | Boolean | Whether Q&A has been generated. |
| DocCharSize | String | Document character count. |
| AttrRange | Integer | Applicable range of attribute label. |
| AttrLabels | Array of AttrLabel | Attribute label. |
| IsAllowEdit | Boolean | Whether editing is allowed. |
| ReferUrlType | Integer | External reference URL type, 0: system URL; 1: custom URL. When the value is 1, the WebUrl field cannot be empty; otherwise, it will not take effect. |
| WebUrl | String | Web page URL (or custom URL) . |
| ExpireStart | String | Effective start time, unix timestamp. |
| ExpireEnd | String | Effective end time, unix timestamp. 0 indicates permanent validity. |
| IsAllowRetry | Boolean | Whether retries are allowed, 0: no, 1: yes. |
| Processing | Array of Integer | 0: document comparison processing; 1: Q&A generation from document. |
| CreateTime | String | Time when the document was created and stored into the database. |
| CateBizId | String | ID of the document's category. |
| CustomerKnowledgeId | String | User-defined ID of the document. |
| AttributeFlags | Array of Integer | Attribute label of the document. 0: Do not perform external user permission verification. |
ListQaItem
Q&A details data.
Used by actions: ListQA.
| Name | Type | Description |
|---|---|---|
| QaBizId | String | Q&A ID. |
| Question | String | Question. |
| Answer | String | Answer. |
| Source | Integer | Source. |
| SourceDesc | String | Source description. |
| UpdateTime | String | Update time. |
| Status | Integer | Status. |
| StatusDesc | String | Status description. |
| DocBizId | String | Document ID. |
| CreateTime | String | Creation time. |
| IsAllowEdit | Boolean | Whether editing is allowed. |
| IsAllowDelete | Boolean | Whether deletion is allowed. |
| IsAllowAccept | Boolean | Whether verification is allowed. |
| FileName | String | Document name. |
| FileType | String | Document type. |
| QaCharSize | String | Number of Q&A characters. |
| ExpireStart | String | Effective start time, unix timestamp. |
| ExpireEnd | String | Effective end time, unix timestamp. 0 indicates permanent validity. |
| AttrRange | Integer | Applicable range of attribute label, 1: all, 2: by conditions. |
| AttrLabels | Array of AttrLabel | Attribute label. |
| SimilarQuestionNum | Integer | Count of similar questions. |
| SimilarQuestionTips | String | Return similar questions associated with the Q&A and perform linked search. Only one similar question will be displayed. |
ListReleaseItem
Details of release list.
Used by actions: ListRelease.
| Name | Type | Description |
|---|---|---|
| ReleaseBizId | String | Version ID. |
| Operator | String | Releaser. |
| Desc | String | Release description. |
| UpdateTime | String | Update time. |
| Status | Integer | Release status. |
| StatusDesc | String | Release status description. |
| Reason | String | Reason for failure. |
| SuccessCount | Integer | Number of successful releases. |
| FailCount | Integer | Number of failed releases. |
ModelInfo
Model information.
Used by actions: ListModel.
| Name | Type | Required | Description |
|---|---|---|---|
| ModelName | String | No | Model name. |
| ModelDesc | String | No | Model description. |
| AliasName | String | No | Model name. |
| ResourceStatus | Integer | No | Resource status, 1: available; 2: exhausted. |
| PromptWordsLimit | String | No | Character limit of prompt content. |
| TopP | ModelParameter | No | By controlling the diversity of content generation through core sampling, a higher Top P value will lead to more diverse content generation. |
| Temperature | ModelParameter | No | Temperature control randomness. |
| MaxTokens | ModelParameter | No | Maximum quantity of tokens that can be generated. |
| Source | String | No | Model source, Hunyuan: Tencent Hunyuan; Industry: Tencent Cloud industry large model; Experience: new model experience. |
| Icon | String | No | Model icon. |
| IsFree | Boolean | No | Whether it is free. |
| InputLenLimit | Integer | No | Maximum characters input in the model dialog box. |
| SupportWorkflowStatus | Integer | No | Workflow support levels: 0 - Not supported by the model; 1 - Supported by the model; 2 - Poorly supported by the model. |
| ModelCategory | String | No | Model categories: Generate: Generative model Thought: Thinking model |
| IsDefault | Boolean | No | Whether it is the default model. |
| RoleLenLimit | Integer | No | Maximum characters of role prompt words. |
| IsExclusive | Boolean | No | Whether it is an exclusive concurrency model. |
| SupportAiCallStatus | Integer | No | The model supports intelligent call effects. |
ModelParameter
Model parameter value range.
Used by actions: ListModel.
| Name | Type | Required | Description |
|---|---|---|---|
| Default | Float | No | Default value. |
| Min | Float | No | Minimum value. |
| Max | Float | No | Maximum value. |
MsgFileInfo
Document information.
Used by actions: DescribeUnsatisfiedReplyContext.
| Name | Type | Description |
|---|---|---|
| FileName | String | Document name. |
| FileSize | String | Document size. |
| FileUrl | String | Document URL. |
| FileType | String | Document type. |
| DocId | String | Document ID. |
MsgRecord
Message details.
Used by actions: GetMsgRecord.
| Name | Type | Description |
|---|---|---|
| Content | String | Content. |
| SessionId | String | The Session ID corresponding to the current record. |
| RecordId | String | Record ID. |
| RelatedRecordId | String | Associated record ID. |
| IsFromSelf | Boolean | Whether it is from oneself. |
| FromName | String | Sender name. |
| FromAvatar | String | Avatar of the sender. |
| Timestamp | String | Timestamp. |
| HasRead | Boolean | Whether it is read. |
| Score | Integer | Evaluation. |
| CanRating | Boolean | Whether to rate. |
| CanFeedback | Boolean | Whether to display the feedback button. |
| Type | Integer | Record type. |
| References | Array of MsgRecordReference | Reference source. |
| Reasons | Array of String | Reason for evaluation. |
| IsLlmGenerated | Boolean | Whether it is a large model. |
| ImageUrls | Array of String | Image URL, which can be public read. |
| TokenStat | TokenStat | Statistical information of the current token. |
| ReplyMethod | Integer | Response method. 1: Large model directly replies. 2: Conservative reply, reply to unknown questions. 3: Reply to rejected question. 4: Sensitive response. 5: Directly reply to Q&A pairs. Priority will be given to answering the adopted Q&A pairs. 6: Reply with welcome words. 7: Reply for concurrency limit exceeded. 8: Global intervention knowledge. 9: Reply during the task flow process. When task_flow.type = 0 in history, it is a response from the large model. 10: Reply with task flow answer. 11: Reply from the search engine. 12: Reply after knowledge polishing. 13: Reply with image understanding. 14: Reply based on real-time document. |
| OptionCards | Array of String | Option tab, used for multi-round dialogue. |
| TaskFlow | TaskFlowInfo | Task information. |
| FileInfos | Array of FileInfo | File information passed in by the user. |
| QuoteInfos | Array of QuoteInfo | Location information of reference source . |
| AgentThought | AgentThought | Information on the thinking process of the agent. |
| ExtraInfo | ExtraInfo | Expanded information. |
| WorkFlow | WorkflowInfo | Workflow information. |
MsgRecordReference
Chat details Refer.
Used by actions: GetMsgRecord.
| Name | Type | Description |
|---|---|---|
| Id | String | ID |
| Url | String | URL. |
| Type | Integer | Type. |
| Name | String | Name. |
| DocId | String | Source document ID. |
Option
Dropdown options.
Used by actions: ListSelectDoc.
| Name | Type | Required | Description |
|---|---|---|---|
| Text | String | No | Text. |
| Value | String | No | Value. |
| CharSize | String | No | Number of characters in a file. |
| FileType | String | No | File type. |
PluginToolReqParam
Plugin parameter request structure.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Parameter name. |
| Desc | String | No | Parameter description. |
| Type | Integer | No | Parameter type, 0: string; 1: int; 2: float; 3: bool; 4: object; 5: array_string; 6: array_int; 7: array_float; 8: array_bool; 9: array_object, 99: null, 100: upspecified. |
| IsRequired | Boolean | No | Whether the parameter is required. |
| DefaultValue | String | No | Parameter default value. |
| SubParams | Array of PluginToolReqParam | No | Sub-parameter. "ParamType" is useful when it is "OBJECT " or "ARRAY<>" type. |
| GlobalHidden | Boolean | No | Whether the plugin parameter configuration is hidden and invisible. true - Hidden and invisible; false - Visible. |
| OneOf | Array of PluginToolReqParam | No | OneOf type parameter. |
| AnyOf | Array of PluginToolReqParam | No | AnyOf type parameter. |
Procedure
Execution process information log.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | English name of execution process. |
| Title | String | No | Chinese name for display. |
| Status | String | No | Status: processing, success, failed. |
| Count | Integer | No | Number of consumed tokens. |
| Debugging | ProcedureDebugging | No | Debugging information. |
| ResourceStatus | Integer | No | Billing resource status, 1: available; 2: unavailable. |
ProcedureDebugging
Debug information.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Content | String | No | Retrieve query. |
| System | String | No | System prompt. |
| Histories | Array of HistorySummary | No | Multiple rounds of historical information. |
| Knowledge | Array of KnowledgeSummary | No | Retrieve knowledge. |
| TaskFlow | TaskFlowSummary | No | Task process. |
| WorkFlow | WorkFlowSummary | No | Workflow debugging information. |
| Agent | AgentDebugInfo | No | Agent debugging information. |
| CustomVariables | Array of String | No | Custom parameter. |
QACate
Obtain Q&A category group.
Used by actions: ListQACate.
| Name | Type | Description |
|---|---|---|
| CateBizId | String | Q&A category business ID. |
| Name | String | Category name. |
| Total | Integer | Quantity of Q&As under the category. |
| CanAdd | Boolean | Whether it is possible to add. |
| CanEdit | Boolean | Whether it can be edited. |
| CanDelete | Boolean | Whether it can be deleted. |
| Children | Array of QACate | Subcategory. |
QAList
Q&A list.
Used by actions: VerifyQA.
| Name | Type | Required | Description |
|---|---|---|---|
| QaBizId | String | Yes | Q&A ID. |
| IsAccepted | Boolean | No | Whether to accept. |
| CateBizId | String | No | Category ID. |
| Question | String | No | Question. |
| Answer | String | No | Answer. |
QAQuery
Q&A query parameter.
Used by actions: ExportQAList.
| Name | Type | Required | Description |
|---|---|---|---|
| PageNumber | Integer | Yes | Page number. |
| PageSize | Integer | Yes | Number of items per page. |
| BotBizId | String | Yes | Application ID. |
| Query | String | No | Query content. |
| CateBizId | String | No | Category ID. |
| AcceptStatus | Array of Integer | No | Verification status. |
| ReleaseStatus | Array of Integer | No | Release status. |
| DocBizId | String | No | Document ID. |
| QaBizId | String | No | Q&A ID. |
| Source | Integer | No | Source. |
| QueryAnswer | String | No | Query an answer. |
| QueryType | String | No | Query type: filename, attribute label. |
QuoteInfo
Search engine reference source index.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Position | Integer | No | Reference source location. |
| Index | String | No | Reference source index sequence. |
ReconstructDocumentFailedPage
Document parsing failure record.
Used by actions: GetReconstructDocumentResult.
| Name | Type | Description |
|---|---|---|
| PageNumber | Integer | Failure page number. |
ReferDetail
Reference source details.
Used by actions: DescribeRefer.
| Name | Type | Description |
|---|---|---|
| ReferBizId | String | Reference ID. |
| DocType | Integer | Document type (1: Q&A; 2: document paragraph). |
| DocName | String | Document name. |
| PageContent | String | Fragment content. |
| Question | String | Question. |
| Answer | String | Answer. |
| Confidence | Float | Confidence. |
| Mark | Integer | Mark. |
| Highlights | Array of Highlight | Fragment highlight content. |
| OrgData | String | Original content. |
| PageInfos | Array of Integer | Page number information. |
| SheetInfos | Array of String | Sheet information. |
| DocBizId | String | Document ID. |
RejectedQuestion
Release rejected questions.
Used by actions: ListRejectedQuestion.
| Name | Type | Description |
|---|---|---|
| RejectedBizId | String | Reject question ID. |
| Question | String | The question that has been rejected. |
| Status | Integer | Status. |
| StatusDesc | String | Status description. |
| UpdateTime | String | Update time. |
| IsAllowEdit | Boolean | Whether editing is allowed. |
| IsAllowDelete | Boolean | Whether deletion is allowed. |
ReleaseConfigs
Release configuration items.
Used by actions: ListReleaseConfigPreview.
| Name | Type | Description |
|---|---|---|
| ConfigItem | String | Configuration item description. |
| UpdateTime | String | Update time. |
| Action | Integer | Status. |
| Value | String | Content after modification. |
| LastValue | String | Content before modification. |
| Content | String | Modified content (display "content" with priority. If "content" is empty, take "value"). |
| Message | String | Reason for failure. |
ReleaseDoc
Release document details.
Used by actions: ListReleaseDocPreview.
| Name | Type | Required | Description |
|---|---|---|---|
| FileName | String | No | File name. |
| FileType | String | No | File type. |
| UpdateTime | String | No | Update time. |
| Action | Integer | No | Status. |
| ActionDesc | String | No | Status description. |
| Message | String | No | Reason for failure. |
| DocBizId | String | No | Document business ID. |
ReleaseQA
Release Q&A.
Used by actions: ListReleaseQAPreview.
| Name | Type | Required | Description |
|---|---|---|---|
| Question | String | No | Question. |
| UpdateTime | String | No | Update time. |
| Action | Integer | No | Status. |
| ActionDesc | String | No | Status description. |
| Source | Integer | No | Source, 1: documentation generation; 2: batch import; 3: manual addition. |
| SourceDesc | String | No | Source description. |
| FileName | String | No | Filename. |
| FileType | String | No | Document type. |
| Message | String | No | Reason for failure |
| ReleaseStatus | Integer | No | Release status. |
| QaBizId | String | No | Q&A ID. |
| DocBizId | String | No | Document business ID. |
ReleaseRejectedQuestion
Release rejected questions.
Used by actions: ListRejectedQuestionPreview.
| Name | Type | Description |
|---|---|---|
| Question | String | Question. |
| UpdateTime | String | Update time. |
| Action | Integer | Status. |
| ActionDesc | String | Status description. |
| Message | String | Reason for failure. |
RunNodeInfo
Node information
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeType | Integer | No | Node type, 0: unspecified; 1: start node; 2: api node; 3: inquiry node; 4: answer node. |
| NodeId | String | No | Node ID. |
| NodeName | String | No | Node name. |
| InvokeApi | InvokeAPI | No | Requested API. |
| SlotValues | Array of ValueInfo | No | Values of all slots of the current node, key: SlotID. Return an Null even if there is no value. |
SearchRange
Retrieval range configuration.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Condition | String | No | Search criteria and/or. |
| ApiVarAttrInfos | Array of ApiVarAttrInfo | No | Custom variable and label relational data. |
SearchStrategy
Knowledge library retrieval strategy.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| StrategyType | Integer | No | Retrieval strategy type, 0: hybrid retrieval; 1: semantic retrieval. |
| TableEnhancement | Boolean | No | Excel retrieval enhancement switch. |
SimilarQuestion
Similar question information.
Used by actions: DescribeQA, ModifyQA.
| Name | Type | Required | Description |
|---|---|---|---|
| SimBizId | String | No | Similar question ID. |
| Question | String | No | Similar question content. |
| AuditStatus | Integer | No | Similar question review status, 1: audit failure. |
SimilarQuestionModify
Similar question modification (update) information.
Used by actions: ModifyQA.
| Name | Type | Required | Description |
|---|---|---|---|
| AddQuestions | Array of String | No | List of similar questions (content) to be added. |
| UpdateQuestions | Array of SimilarQuestion | No | List of similar questions to be updated. |
| DeleteQuestions | Array of SimilarQuestion | No | List of similar questions to be deleted. |
Stat
Billing statistical information.
Used by actions: DescribeCallStatsGraph, DescribeSearchStatsGraph, DescribeTokenUsageGraph.
| Name | Type | Description |
|---|---|---|
| X | String | X-axis: time zone; return three interval ranges of "minute/hour/day" according to the granularity of the query condition. |
| Y | Float | Y-axis: statistical values in this time period, such as token consumption, call count, or usage information. |
StatisticInfo
Statistical information of large model tokens.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| ModelName | String | No | Model name. |
| FirstTokenCost | Integer | No | Time consumption of the first token. |
| TotalCost | Integer | No | Total time consumption. |
| InputTokens | Integer | No | Number of input tokens. |
| OutputTokens | Integer | No | Number of output tokens. |
| TotalTokens | Integer | No | Total number of tokens. |
StrValue
String KV information.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Name. |
| Value | String | No | Value. |
SummaryConfig
Knowledge summary application configuration.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Model | AppModel | No | Model configuration. |
| Output | SummaryOutput | No | Knowledge summary output configuration. |
| Greeting | String | No | Welcome words, within 200 characters. |
SummaryOutput
Knowledge summary output configuration.
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Method | Integer | No | Output method: 1. streaming; 2. non-streaming. |
| Requirement | Integer | No | Output requirement 1: text summary. 2: customized requirement. |
| RequireCommand | String | No | Custom requirement command. |
TaskFlowInfo
Task process information.
Used by actions: GetMsgRecord.
| Name | Type | Description |
|---|---|---|
| TaskFlowId | String | Task flow ID. |
| TaskFlowName | String | Task flow name. |
| QueryRewrite | String | Rewrite results of query. |
| HitIntent | String | Hit intent. |
| Type | Integer | Task flow response type. 0: Task flow response. 1: Silent task flow. 2: Pull back script of workflow. 3: Custom response of task flow. |
TaskFlowSummary
Task process debugging information.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| IntentName | String | No | Task flow name. |
| UpdatedSlotValues | Array of ValueInfo | No | Entity list. |
| RunNodes | Array of RunNodeInfo | No | Node list. |
| Purposes | Array of String | No | Intent determination. |
TaskParams
Task parameter.
Used by actions: GetTaskStatus.
| Name | Type | Description |
|---|---|---|
| CosPath | String | Download address. Download through the COS bucket temporary key. |
TokenStat
Current executed token statistical information.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| SessionId | String | No | Session ID. |
| RequestId | String | No | Request ID. |
| RecordId | String | No | It corresponds to a session, session id, used for storing messages for answering. It can be generated in advance, used when saving messages. |
| UsedCount | Integer | No | Number of consumed tokens. |
| FreeCount | Integer | No | Number of free tokens. |
| OrderCount | Integer | No | Total number of tokens for orders. |
| StatusSummary | String | No | Current execution status summary. Constant: processing, success., failed. |
| StatusSummaryTitle | String | No | Chinese display after summarizing the current execution status. |
| Elapsed | Integer | No | Current request execution time, in milliseconds. |
| TokenCount | Integer | No | Number of tokens consumed by the current request. |
| Procedures | Array of Procedure | No | Execution information. |
| TraceId | String | No | Execution process information TraceId. |
UnsatisfiedReply
Unsatisfied response.
Used by actions: ListUnsatisfiedReply.
| Name | Type | Description |
|---|---|---|
| ReplyBizId | String | Unsatisfied response ID. |
| RecordBizId | String | Message record ID. |
| Question | String | User question. |
| Answer | String | Application response. |
| Reasons | Array of String | Error type. |
UpdatePeriodInfo
Used by actions: SaveDoc.
| Name | Type | Required | Description |
|---|---|---|---|
| UpdatePeriodH | Integer | No |
ValueInfo
Task flow parameter information.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| Id | String | No | Value ID. |
| Name | String | No | Name. |
| ValueType | Integer | No | Value type, 0: unknown or empty; 1: string; 2: integer; 3: float; 4: boolean; 5: array (string array); 6: object_array (structure array); 7: object (structure). |
| ValueStr | String | No | String. |
| ValueInt | String | No | Int (return as a string to avoid precision loss). |
| ValueFloat | Float | No | Float. |
| ValueBool | Boolean | No | Bool. |
| ValueStrArray | Array of String | No | Array. |
VoiceConfig
Used by actions: DescribeApp, ModifyApp.
| Name | Type | Required | Description |
|---|---|---|---|
| VoiceType | Integer | No | |
| TimbreKey | String | No | |
| VoiceName | String | No |
WorkFlowSummary
Workflow debugging information.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| WorkflowId | String | No | Workflow ID. |
| WorkflowName | String | No | Workflow name. |
| WorkflowRunId | String | No | Workflow running ID. |
| RunNodes | Array of WorkflowRunNodeInfo | No | Node information. |
| OptionCards | Array of String | No | Tab. |
| Outputs | Array of String | No | Output results of multiple bubbles. |
| WorkflowReleaseTime | String | No | Workflow release time, Unix timestamp. |
WorkflowInfo
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| WorkflowId | String | No | |
| WorkflowName | String | No | |
| WorkflowRunId | String | No | |
| OptionCards | Array of String | No | |
| Outputs | Array of String | No | |
| WorkflowReleaseTime | String | No |
WorkflowRunNodeInfo
Workflow running node information.
Used by actions: GetMsgRecord.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeId | String | No | Node ID. |
| NodeType | Integer | No | Node type. |
| NodeName | String | No | Node name. |
| Status | Integer | No | Status. |
| Input | String | No | Input.. |
| Output | String | No | Output. |
| TaskOutput | String | No | Task output. |
| FailMessage | String | No | Error message. |
| CostMilliSeconds | Integer | No | Time consumption. |
| StatisticInfos | Array of StatisticInfo | No | Large model output information. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback