@alicloud/gpdb20160503 3.6.0 → 3.8.0

package/src/models/ChatWithKnowledgeBaseResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCallsFunction extends $dara.Model {
   /**
    * @remarks
-   * The arguments to pass to the function.
+   * The called function parameters.
    * 
    * @example
    * {"city":"hangzhou"}
@@ -13,7 +13,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCa
   arguments?: string;
   /**
    * @remarks
-   * The name of the function to call.
+   * The called function name.
    * 
    * @example
    * "get_weather"
@@ -45,12 +45,12 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCa
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCalls extends $dara.Model {
   /**
    * @remarks
-   * The function that the model wants to call.
+   * The called function information.
    */
   function?: ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCallsFunction;
   /**
    * @remarks
-   * The ID of the tool call.
+   * The ID.
    * 
    * @example
    * "chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"
@@ -58,7 +58,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCa
   id?: string;
   /**
    * @remarks
-   * The index of the tool call.
+   * The tool call sequence number.
    * 
    * @example
    * 1
@@ -95,7 +95,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCa
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessage extends $dara.Model {
   /**
    * @remarks
-   * The content of the message.
+   * The document content.
    * 
    * @example
    * The weather in Hangzhou is sunny.
@@ -103,7 +103,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessage exten
   content?: string;
   /**
    * @remarks
-   * The model\\"s reasoning process.
+   * The model reasoning content.
    * 
    * @example
    * Logical reasoning process
@@ -111,13 +111,10 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessage exten
   reasoningContent?: string;
   /**
    * @remarks
-   * The role of the message:
-   * 
-   * - `system`
-   * 
-   * - `user`
-   * 
-   * - `assistant`
+   * The message role:
+   * - system
+   * - user
+   * - assistant
    * 
    * @example
    * user
@@ -125,7 +122,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessage exten
   role?: string;
   /**
    * @remarks
-   * A list of tool calls generated by the model.
+   * The tool call response list.
    */
   toolCalls?: ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCalls[];
   static names(): { [key: string]: string } {
@@ -161,7 +158,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessage exten
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoices extends $dara.Model {
   /**
    * @remarks
-   * The reason the model stopped generating tokens.
+   * The stop reason.
    * 
    * @example
    * finish
@@ -169,7 +166,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoices extends $dar
   finishReason?: string;
   /**
    * @remarks
-   * The index of this choice in the `Choices` array.
+   * The reply sequence number.
    * 
    * @example
    * 0
@@ -177,7 +174,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoices extends $dar
   index?: number;
   /**
    * @remarks
-   * The message generated by the large language model.
+   * The large model reply response.
    */
   message?: ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessage;
   static names(): { [key: string]: string } {
@@ -211,7 +208,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoices extends $dar
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsagePromptTokensDetails extends $dara.Model {
   /**
    * @remarks
-   * The number of prompt tokens that resulted in a cache hit.
+   * The number of tokens that hit the cache.
    * 
    * @example
    * 24
@@ -241,7 +238,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsagePromptTokensDet
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsage extends $dara.Model {
   /**
    * @remarks
-   * The number of tokens in the generated response.
+   * The number of tokens consumed for generating content.
    * 
    * @example
    * 42
@@ -249,7 +246,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsage extends $dara.
   completionTokens?: number;
   /**
    * @remarks
-   * The number of tokens in the input prompt.
+   * The number of tokens consumed by the input prompt.
    * 
    * @example
    * 42
@@ -257,12 +254,12 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsage extends $dara.
   promptTokens?: number;
   /**
    * @remarks
-   * Details of the prompt tokens.
+   * The prompt token details.
    */
   promptTokensDetails?: ChatWithKnowledgeBaseResponseBodyChatCompletionUsagePromptTokensDetails;
   /**
    * @remarks
-   * The total number of tokens used in the request (prompt tokens + completion tokens).
+   * The total number of tokens.
    * 
    * @example
    * 42
@@ -301,12 +298,12 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsage extends $dara.
 export class ChatWithKnowledgeBaseResponseBodyChatCompletion extends $dara.Model {
   /**
    * @remarks
-   * A list of chat completion choices.
+   * The real-time generated text content.
    */
   choices?: ChatWithKnowledgeBaseResponseBodyChatCompletionChoices[];
   /**
    * @remarks
-   * The creation time of the response, as a Unix timestamp.
+   * The creation time.
    * 
    * @example
    * 1758529748
@@ -322,7 +319,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletion extends $dara.Model
   id?: string;
   /**
    * @remarks
-   * The model that generated the response.
+   * The model name used.
    * 
    * @example
    * qwen-plus
@@ -330,7 +327,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletion extends $dara.Model
   model?: string;
   /**
    * @remarks
-   * Token usage statistics for the chat completion.
+   * The token usage of the large model output.
    */
   usage?: ChatWithKnowledgeBaseResponseBodyChatCompletionUsage;
   static names(): { [key: string]: string } {
@@ -387,9 +384,9 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   fileName?: string;
   /**
    * @remarks
-   * The public URL of the file. By default, the URL is valid for 2 hours.
+   * The public URL of the query result image, valid for 2 hours by default.
    * 
-   * You can specify a custom validity period by using the `UrlExpiration` request parameter.
+   * You can specify the validity period using the UrlExpiration input parameter.
    * 
    * @example
    * http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/b4d8_207196811002111319_570c0e199f03428f812ab21fcc00dd6a
@@ -397,7 +394,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   fileURL?: string;
   /**
    * @remarks
-   * The unique ID of the vector.
+   * The unique ID of the vector data.
    * 
    * @example
    * 273e3fc7-8f56-4167-a1bb-d35d2f3b9043
@@ -405,7 +402,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   id?: string;
   /**
    * @remarks
-   * The metadata generated when the document was loaded.
+   * The metadata information loaded by the document loader.
    * 
    * @example
    * {"page":1}
@@ -426,7 +423,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   rerankScore?: number;
   /**
    * @remarks
-   * The retrieval source. Valid values: `1` for vector retrieval, `2` for full-text search, and `3` for two-channel recall.
+   * The source of the retrieval result. 1 indicates vector retrieval, 2 indicates full-text retrieval, and 3 indicates dual-path recall.
    * 
    * @example
    * 3
@@ -434,7 +431,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   retrievalSource?: number;
   /**
    * @remarks
-   * The similarity score. The score is based on the algorithm `(l2/ip/cosine)` specified when the index was created.
+   * The similarity score of this data entry. The scoring algorithm is related to the algorithm specified when creating the index (l2/ip/cosine).
    * 
    * @example
    * 12
@@ -495,7 +492,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultUsage e
    * @remarks
    * The number of tokens used for vectorization.
    * 
-   * > A token is the smallest unit of text. A token can be a word, a phrase, a punctuation mark, or a character.
+   * > A token is the smallest unit into which input text is divided. A token can be a word, a phrase, a punctuation mark, a character, etc.
    * 
    * @example
    * 21
@@ -525,17 +522,17 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultUsage e
 export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult extends $dara.Model {
   /**
    * @remarks
-   * A list of identified entity types.
+   * The entity details.
    */
   entities?: string[];
   /**
    * @remarks
-   * The recalled items.
+   * The recall items.
    */
   matches?: ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches[];
   /**
    * @remarks
-   * The relationship edges.
+   * The relationship edge details.
    */
   relations?: string[];
   /**
@@ -548,11 +545,9 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult extend
   requestId?: string;
   /**
    * @remarks
-   * The status of the recall operation. Valid values:
-   * 
-   * - `success`: The recall was successful.
-   * 
-   * - `fail`: The recall failed.
+   * The API execution status. Valid values:
+   * - **success**: Execution succeeded.
+   * - **fail**: Execution failed.
    * 
    * @example
    * success
@@ -560,7 +555,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult extend
   status?: string;
   /**
    * @remarks
-   * The number of tokens consumed by the recall process.
+   * The number of tokens consumed.
    * 
    * @example
    * 42
@@ -568,7 +563,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult extend
   tokens?: number;
   /**
    * @remarks
-   * Usage statistics for the recall, such as the number of tokens for vectorization.
+   * The tokens or items consumed by document understanding or embedding.
    */
   usage?: ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultUsage;
   static names(): { [key: string]: string } {
@@ -619,12 +614,12 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult extend
 export class ChatWithKnowledgeBaseResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response from the large language model.
+   * The model response.
    */
   chatCompletion?: ChatWithKnowledgeBaseResponseBodyChatCompletion;
   /**
    * @remarks
-   * A message that provides details about the status of the operation.
+   * The return message.
    * 
    * @example
    * Successful
@@ -632,7 +627,7 @@ export class ChatWithKnowledgeBaseResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The recall results from multiple knowledge bases.
+   * The multi-knowledge base recall information.
    */
   multiCollectionRecallResult?: ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult;
   /**
@@ -645,11 +640,9 @@ export class ChatWithKnowledgeBaseResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The final status of the request. Valid values:
-   * 
-   * - `success`: The request was successful.
-   * 
-   * - `fail`: The request failed.
+   * The status. Valid values:
+   * - **success**: Succeeded.
+   * - **fail**: Failed.
    * 
    * @example
    * success

package/src/models/ChatWithKnowledgeBaseShrinkRequest.ts

@@ -6,8 +6,7 @@ export class ChatWithKnowledgeBaseShrinkRequest extends $dara.Model {
   /**
    * @remarks
    * The instance ID.
-   * 
-   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/196830.html) operation to view the details of all instances in a target region, including their instance IDs.
+   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/196830.html) operation to query the details of all instances in the target region, including the instance ID.
    * 
    * This parameter is required.
    * 
@@ -17,7 +16,7 @@ export class ChatWithKnowledgeBaseShrinkRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * Whether to include the raw retrieval results from the knowledge base in the response. Default: `false`.
+   * Specifies whether to return the recall results. Default value: false.
    * 
    * @example
    * false
@@ -25,12 +24,12 @@ export class ChatWithKnowledgeBaseShrinkRequest extends $dara.Model {
   includeKnowledgeBaseResults?: boolean;
   /**
    * @remarks
-   * Parameters for knowledge retrieval. If omitted, the operation performs a standard chat without retrieving from a knowledge base.
+   * The knowledge retrieval parameter object. If not specified, only chat is performed.
    */
   knowledgeParamsShrink?: string;
   /**
    * @remarks
-   * The parameters for calling the large language model (LLM).
+   * The large language model (LLM) invocation parameter object.
    * 
    * This parameter is required.
    */
@@ -38,7 +37,7 @@ export class ChatWithKnowledgeBaseShrinkRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * A custom system prompt template. If specified, it overrides the default prompt. The template must include the {{ text_chunks }}, {{ user_system_prompt }}, {{ graph_entities }}, and {{ graph_relations }} placeholders.
+   * The system prompt template, which must include {{ text_chunks }}, {{ user_system_prompt }}, {{ graph_entities }}, and {{ graph_relations }}. If not specified, this part does not take effect.
    * 
    * @example
    * "参考以下知识回答问题:{{ text_chunks }}"