tencent cloud

APIs

ドキュメントAPIsTencent Cloud Agent Development PlatformData Types

Data Types

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-28 18:04:26

DBRetrievalConfig

Database search configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Enabled Boolean No

Whether to enable

DocRetrievalConfig

Document search configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Confidence Float No

Confidence threshold
Enabled Boolean No

Whether to enable
TopN Integer No

Return the top N entries

ExpirationAwareness

Timeliness retrieval enhancement configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Enabled Boolean No

Whether to enable timeliness retrieval. Once enabled, retrieval results will be sorted based on the validity time of the knowledge

FinalRerankConfig

Final rerank configuration

Used by actions: SearchKnowledge.

Name Type Required Description
ModelName String No

Model name

GraphRAG

GraphRAG configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Enabled Boolean No

Whether to enable

KBRetrievalConfig

Search configuration of each knowledge base

Used by actions: SearchKnowledge.

Name Type Required Description
DbRetrievalConfig DBRetrievalConfig No

Database search configuration
DocRetrievalConfig DocRetrievalConfig No

Document retrieval configuration.
KbId String No

Knowledge base ID
OptionConfig RetrievalOption No

Retrieval optional configuration
QaRetrievalConfig QARetrievalConfig No

QA search configuration
RerankConfig RerankConfig No

ReRank configuration
SearchFilterConfig SearchFilterConfig No

Search filter configuration
StrategyType Integer No

Retrieval strategy: 1=hybrid, 2=semantic, 3=keyword, 4=none

Enumeration itemEnumeration valueDescription
SEARCH_STRATEGY_TYPE_UNKNOWN0
SEARCH_STRATEGY_TYPE_MIXING1Hybrid retrieval
SEARCH_STRATEGY_TYPE_SEMANTIC2Semantic retrieval
SEARCH_STRATEGY_TYPE_KEYWORD3Keyword retrieval
SEARCH_STRATEGY_TYPE_NONE4No semantic/vector retrieval
TextToSqlModel ModelDetailInfo No

Text2SQL model

KVPair

Common key-value pair

Used by actions: SearchKnowledge.

Name Type Required Description
Key String No Key
Value String No Value

KnowledgeResult

A single retrieval result

Used by actions: SearchKnowledge.

Name Type Required Description
Confidence Float No

Confidence degree
KnowledgeType Integer No

Hit knowledge type: 1=QA, 2=document fragment, 3=database, 4=map

Enumeration itemEnumeration valueDescription
KNOWLEDGE_SOURCE_TYPE_UNKNOWN0
KNOWLEDGE_SOURCE_TYPE_QA1QA
KNOWLEDGE_SOURCE_TYPE_DOC2Document fragment
KNOWLEDGE_SOURCE_TYPE_DB3Database
KNOWLEDGE_SOURCE_TYPE_GRAPH4Map
RecallTypeList Array of Integer No

Recall type list
ResultPayload SearchResultPayload No

Result payload
ResultType Integer No

Result type

Enumeration itemEnumeration valueDescription
SEARCH_RESULT_TYPE_UNKNOWN0
SEARCH_RESULT_TYPE_RETRIEVAL1Standard search result
SEARCH_RESULT_TYPE_TEXT_TO_SQL2text2sql result
SEARCH_RESULT_TYPE_IMAGE_SEARCH_IMAGE3
SEARCH_RESULT_TYPE_TEXT_SEARCH_IMAGE4
SimilarQuestionExtra SimilarQuestionExtra No

Additional information for similar questions.
SnippetProfile KnowledgeSnippetProfile No

Basic information of knowledge fragment
SourceInfo KnowledgeSource No

Knowledge source information

KnowledgeSnippetProfile

Basic information of knowledge fragment

Used by actions: SearchKnowledge.

Name Type Required Description
Content String No

Content
DocId String No

Associated document ID
DocName String No

Document name
KbId String No

Knowledge base ID
KnowledgeId String No

Knowledge ID
Question String No

Query
Title String No

Document title

KnowledgeSource

Knowledge source information

Used by actions: SearchKnowledge.

Name Type Required Description
IsBigData Boolean No

Whether it is big data
IsShared Boolean No

Whether it is a shared knowledge base
KbName String No

Knowledge base name

ModelDetailInfo

Model details

Used by actions: SearchKnowledge.

Name Type Required Description
Alias String No Model alias.
HistoryLimit Integer No Limit on number of historical conversations
ModelId String No Unique model ID
ModelParams ModelParams No Model parameters

ModelParams

Model parameters

Used by actions: SearchKnowledge.

Name Type Required Description
DeepThinking String No

Whether deep thinking is enabled
FrequencyPenalty Float No

Frequency penalty
MaxTokens Integer No

Maximum output length
PresencePenalty Float No

Existence penalty
ReasoningEffort String No

Deep thinking effect
RepetitionPenalty Float No

Repetition penalty
ReplyFormat String No

Output format (text, json_object)
Seed Integer No

Random seed
StopSequenceList Array of String No

Stop sequence
Temperature Float No

Temperature
TopP Float No

top_p
TopK Integer No

top_k

QARetrievalConfig

QA search configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Confidence Float No

Confidence threshold
Enabled Boolean No

Whether to enable
TopN Integer No

Return the top N entries

RerankConfig

Rearrange the configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Enabled Boolean No

Whether to enable
ModelName String No

Model name

RetrievalOption

Optional retrieval configuration

Used by actions: SearchKnowledge.

Name Type Required Description
ExpirationAwareness ExpirationAwareness No

Timeliness retrieval enhancement configuration
GraphRag GraphRAG No

GraphRAG Configuration
TableEnhancement TableEnhancement No

Spreadsheet enhancement configuration

SearchAdvancedConfig

Retrieve advanced configuration

Used by actions: SearchKnowledge.

Name Type Required Description
FinalRerankConfig FinalRerankConfig No

Final ReRank Configuration
KbRetrievalList Array of KBRetrievalConfig No

Search configuration of each knowledge base
KnowledgeType Integer No

Retrieve knowledge type: 1=document and QA, 2=rejected question

Enumeration itemEnumeration valueDescription
SEARCH_KNOWLEDGE_TYPE_UNKNOWN0
SEARCH_KNOWLEDGE_TYPE_DOC_QA1Document and QA
SEARCH_KNOWLEDGE_TYPE_REJECTED_QUESTION2Rejected question
RecallCount Integer No

Number of final returned results

SearchBilling

Retrieval billing information

Used by actions: SearchKnowledge.

Name Type Required Description
BillingTagList Array of KVPair No

Billing tag list
FinanceSubBusinessType String No

Billing sub-business type

SearchContext

Retrieval request context info

Used by actions: SearchKnowledge.

Name Type Required Description
CallSource Integer No

Request source

Enumeration itemEnumeration valueDescription
CALL_SOURCE_UNSPECIFIED0
CALL_SOURCE_RAG1Standard mode
CALL_SOURCE_WORKFLOW2Workflow
CALL_SOURCE_PLUGIN3Plug-in
CALL_SOURCE_OPENCLAW4openclaw
CALL_SOURCE_RECALL_TEST5Recall test
CALL_SOURCE_RECALL_TEST_DIFF6Recall test in comparison scenarios also needs to trigger the retrieval interface. The difference is that in this case, the frontend does not need to update the latest configuration. Because when comparing 1, 2, and 3, the final saved one may be 2.
Domain Integer No

adp DOMAIN: 1=development DOMAIN, 2=production DOMAIN

Enumeration itemEnumeration valueDescription
adp_DOMAIN_UNSPECIFIED0not specified
adp_DOMAIN_DEV1development DOMAIN
adp_DOMAIN_PROD2production DOMAIN
VisitorId String No

Visitor ID

SearchFilter

Search filter

Used by actions: SearchKnowledge.

Name Type Required Description
FilterType Integer No

Search filter type

Enumeration itemEnumeration valueDescription
SEARCH_FILTER_TYPE_UNKNOWN0
SEARCH_FILTER_TYPE_CUSTOMER_LABEL_VALUE1User-customized tag value
SEARCH_FILTER_TYPE_CUSTOMER_LABEL_VALUE_ID2User-customized tag value ID
SEARCH_FILTER_TYPE_DOC_ID3Retrieve by specified document ID
SEARCH_FILTER_TYPE_DOC_CATEGORY_ID4Retrieve by specified document classification ID
SEARCH_FILTER_TYPE_DB_TABLE_ID5Retrieve by specified database table ID
SEARCH_FILTER_TYPE_KB_SCHEMA_ID6Specified knowledge base schema ID
FilterValueList Array of String No

Filter value list. According to SearchFilterType, take value 1: pass a custom tag value; 2: pass a custom tag value ID; 3: pass a document ID; 4: pass a category ID
LabelId String No

User-customized tag ID
LogicOp Integer No

Logical operator: AND or OR

Enumeration itemEnumeration valueDescription
LOGIC_OPR_NOOP0
LOGIC_OPR_AND1
LOGIC_OPR_OR2
SearchFilterList Array of SearchFilter No

Nested search filter

SearchFilterConfig

Search filter configuration

Used by actions: SearchKnowledge.

Name Type Required Description
OnlyRetrievalSelectedLabel Boolean No

Whether to retrieve only selected tags. true: retrieve only knowledge with selected tags; false: simultaneous retrieval of knowledge with selected tags and knowledge without any tags
SearchFilter SearchFilter No

Search filter

SearchInput

Retrieval input

Used by actions: SearchKnowledge.

Name Type Required Description
ImageUrlList Array of String No

List of image URLs
Question String No

Query
SubQuestionList Array of String No

Deconstructed sub-problem list

SearchResultPayload

Result payload

Used by actions: SearchKnowledge.

Name Type Required Description
GraphData String No

Additional information of knowledge graph (JSON string)
ImageUrlList Array of String No

List of hit image URLs
SheetInfo String No

Table additional information (JSON string)

SimilarQuestionExtra

Additional information of the similar question

Used by actions: SearchKnowledge.

Name Type Required Description
Content String No

Text content of the similar question
SimilarQuestionId String No

Similar question ID

TableEnhancement

Table enhancement configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Enabled Boolean No

Whether to enable

TokenUsage

Token usage statistics

Used by actions: SearchKnowledge.

Name Type Required Description
CompletionTokens Integer No

Number of completion tokens
ModelName String No

Model name
PromptTokens Integer No

prompt token count
TotalTokens Integer No

Total token count
前の記事へ: SearchKnowledge次の記事へ: Error Codes

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック

キーワードで検索
    Enter keywords to search documentation