@alicloud/gpdb20160503 3.5.0 → 3.7.0

package/src/models/ChatWithKnowledgeBaseResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCallsFunction extends $dara.Model {
   /**
    * @remarks
-   * Arguments of the called function.
+   * The arguments to pass to the function.
    * 
    * @example
    * {"city":"hangzhou"}
@@ -13,7 +13,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCa
   arguments?: string;
   /**
    * @remarks
-   * The name of the called function.
+   * The name of the function to call.
    * 
    * @example
    * "get_weather"
@@ -45,12 +45,12 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCa
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCalls extends $dara.Model {
   /**
    * @remarks
-   * Function call information.
+   * The function that the model wants to call.
    */
   function?: ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCallsFunction;
   /**
    * @remarks
-   * ID
+   * The ID of the tool call.
    * 
    * @example
    * "chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"
@@ -58,7 +58,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCa
   id?: string;
   /**
    * @remarks
-   * The position of this tool in the \\"input\\" request parameter.
+   * The index of the tool call.
    * 
    * @example
    * 1
@@ -95,24 +95,29 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCa
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessage extends $dara.Model {
   /**
    * @remarks
-   * The content of the document.
+   * The content of the message.
+   * 
+   * @example
+   * The weather in Hangzhou is sunny.
    */
   content?: string;
   /**
    * @remarks
-   * 模型思维内容
+   * The model\\"s reasoning process.
    * 
    * @example
-   * 逻辑推理过程
+   * Logical reasoning process
    */
   reasoningContent?: string;
   /**
    * @remarks
-   * Message role:
+   * The role of the message:
+   * 
+   * - `system`
+   * 
+   * - `user`
    * 
-   * *   system
-   * *   user
-   * *   assistant
+   * - `assistant`
    * 
    * @example
    * user
@@ -120,7 +125,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessage exten
   role?: string;
   /**
    * @remarks
-   * Tool call response.
+   * A list of tool calls generated by the model.
    */
   toolCalls?: ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessageToolCalls[];
   static names(): { [key: string]: string } {
@@ -156,7 +161,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessage exten
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoices extends $dara.Model {
   /**
    * @remarks
-   * Finish reason.
+   * The reason the model stopped generating tokens.
    * 
    * @example
    * finish
@@ -164,7 +169,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoices extends $dar
   finishReason?: string;
   /**
    * @remarks
-   * The sequence number of the reply.
+   * The index of this choice in the `Choices` array.
    * 
    * @example
    * 0
@@ -172,7 +177,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoices extends $dar
   index?: number;
   /**
    * @remarks
-   * LLM response.
+   * The message generated by the large language model.
    */
   message?: ChatWithKnowledgeBaseResponseBodyChatCompletionChoicesMessage;
   static names(): { [key: string]: string } {
@@ -206,7 +211,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionChoices extends $dar
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsagePromptTokensDetails extends $dara.Model {
   /**
    * @remarks
-   * The number of tokens from cache hits.
+   * The number of prompt tokens that resulted in a cache hit.
    * 
    * @example
    * 24
@@ -236,7 +241,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsagePromptTokensDet
 export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsage extends $dara.Model {
   /**
    * @remarks
-   * The number of tokens consumed by the generated content.
+   * The number of tokens in the generated response.
    * 
    * @example
    * 42
@@ -244,7 +249,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsage extends $dara.
   completionTokens?: number;
   /**
    * @remarks
-   * The number of tokens consumed by the prompt.
+   * The number of tokens in the input prompt.
    * 
    * @example
    * 42
@@ -252,12 +257,12 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsage extends $dara.
   promptTokens?: number;
   /**
    * @remarks
-   * The details about the prompt token.
+   * Details of the prompt tokens.
    */
   promptTokensDetails?: ChatWithKnowledgeBaseResponseBodyChatCompletionUsagePromptTokensDetails;
   /**
    * @remarks
-   * The total number of tokens.
+   * The total number of tokens used in the request (prompt tokens + completion tokens).
    * 
    * @example
    * 42
@@ -296,12 +301,12 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletionUsage extends $dara.
 export class ChatWithKnowledgeBaseResponseBodyChatCompletion extends $dara.Model {
   /**
    * @remarks
-   * Text content generated in real time.
+   * A list of chat completion choices.
    */
   choices?: ChatWithKnowledgeBaseResponseBodyChatCompletionChoices[];
   /**
    * @remarks
-   * The creation time.
+   * The creation time of the response, as a Unix timestamp.
    * 
    * @example
    * 1758529748
@@ -309,7 +314,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletion extends $dara.Model
   created?: number;
   /**
    * @remarks
-   * The ID of the response.
+   * The response ID.
    * 
    * @example
    * 273e3fc7-8f56-4167-a1bb-d35d2f3b9043
@@ -317,7 +322,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletion extends $dara.Model
   id?: string;
   /**
    * @remarks
-   * The name of the model.
+   * The model that generated the response.
    * 
    * @example
    * qwen-plus
@@ -325,7 +330,7 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletion extends $dara.Model
   model?: string;
   /**
    * @remarks
-   * The number of tokens used in LLM output.
+   * Token usage statistics for the chat completion.
    */
   usage?: ChatWithKnowledgeBaseResponseBodyChatCompletionUsage;
   static names(): { [key: string]: string } {
@@ -366,7 +371,10 @@ export class ChatWithKnowledgeBaseResponseBodyChatCompletion extends $dara.Model
 export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches extends $dara.Model {
   /**
    * @remarks
-   * The content of the document.
+   * The document content.
+   * 
+   * @example
+   * AnalyticDB PostgreSQL vector database.
    */
   content?: string;
   /**
@@ -379,9 +387,9 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   fileName?: string;
   /**
    * @remarks
-   * The URL of the image result. By default, the URL is valid for 2 hours.
+   * The public URL of the file. By default, the URL is valid for 2 hours.
    * 
-   * You can use the UrlExpiration parameter to specify a validity period.
+   * You can specify a custom validity period by using the `UrlExpiration` request parameter.
    * 
    * @example
    * http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/b4d8_207196811002111319_570c0e199f03428f812ab21fcc00dd6a
@@ -389,7 +397,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   fileURL?: string;
   /**
    * @remarks
-   * The unique ID of the vector data.
+   * The unique ID of the vector.
    * 
    * @example
    * 273e3fc7-8f56-4167-a1bb-d35d2f3b9043
@@ -397,7 +405,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   id?: string;
   /**
    * @remarks
-   * Document loader metadata.
+   * The metadata generated when the document was loaded.
    * 
    * @example
    * {"page":1}
@@ -410,7 +418,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   metadata?: { [key: string]: any };
   /**
    * @remarks
-   * The rerank score.
+   * The reranking score.
    * 
    * @example
    * 0.1
@@ -418,7 +426,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   rerankScore?: number;
   /**
    * @remarks
-   * The source of the retrieved results. 1 indicates vector retrieval, 2 indicates full-text retrieval, and 3 indicates dual-path retrieval.
+   * The retrieval source. Valid values: `1` for vector retrieval, `2` for full-text search, and `3` for two-channel recall.
    * 
    * @example
    * 3
@@ -426,7 +434,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
   retrievalSource?: number;
   /**
    * @remarks
-   * The similarity score of the data. It is related to the `l2, ip, or cosine` algorithm that is specified when you create an index.
+   * The similarity score. The score is based on the algorithm `(l2/ip/cosine)` specified when the index was created.
    * 
    * @example
    * 12
@@ -485,9 +493,9 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches
 export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultUsage extends $dara.Model {
   /**
    * @remarks
-   * The number of tokens that are used during vectorization.
+   * The number of tokens used for vectorization.
    * 
-   * >  A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.
+   * > A token is the smallest unit of text. A token can be a word, a phrase, a punctuation mark, or a character.
    * 
    * @example
    * 21
@@ -517,22 +525,22 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultUsage e
 export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult extends $dara.Model {
   /**
    * @remarks
-   * The details of the entity.
+   * A list of identified entity types.
    */
   entities?: string[];
   /**
    * @remarks
-   * The retrieved items.
+   * The recalled items.
    */
   matches?: ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultMatches[];
   /**
    * @remarks
-   * The name of the file.
+   * The relationship edges.
    */
   relations?: string[];
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 6B9E3255-4543-5B3B-9E00-6490CA64742B
@@ -540,10 +548,11 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult extend
   requestId?: string;
   /**
    * @remarks
-   * The status of the operation. Valid values:
+   * The status of the recall operation. Valid values:
    * 
-   * *   **success**
-   * *   **fail**
+   * - `success`: The recall was successful.
+   * 
+   * - `fail`: The recall failed.
    * 
    * @example
    * success
@@ -551,7 +560,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult extend
   status?: string;
   /**
    * @remarks
-   * The number of tokens that are consumed.
+   * The number of tokens consumed by the recall process.
    * 
    * @example
    * 42
@@ -559,7 +568,7 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult extend
   tokens?: number;
   /**
    * @remarks
-   * The number of tokens that are consumed during document understanding or embedding.
+   * Usage statistics for the recall, such as the number of tokens for vectorization.
    */
   usage?: ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResultUsage;
   static names(): { [key: string]: string } {
@@ -610,12 +619,12 @@ export class ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult extend
 export class ChatWithKnowledgeBaseResponseBody extends $dara.Model {
   /**
    * @remarks
-   * model response.
+   * The response from the large language model.
    */
   chatCompletion?: ChatWithKnowledgeBaseResponseBodyChatCompletion;
   /**
    * @remarks
-   * The returned information.
+   * A message that provides details about the status of the operation.
    * 
    * @example
    * Successful
@@ -623,12 +632,12 @@ export class ChatWithKnowledgeBaseResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Retrieve information from multiple knowledge bases.
+   * The recall results from multiple knowledge bases.
    */
   multiCollectionRecallResult?: ChatWithKnowledgeBaseResponseBodyMultiCollectionRecallResult;
   /**
    * @remarks
-   * The unique ID of the request.
+   * The request ID.
    * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
@@ -636,10 +645,11 @@ export class ChatWithKnowledgeBaseResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The status of the operation. Valid values:
+   * The final status of the request. Valid values:
+   * 
+   * - `success`: The request was successful.
    * 
-   * *   **success**
-   * *   **fail**
+   * - `fail`: The request failed.
    * 
    * @example
    * success

package/src/models/ChatWithKnowledgeBaseShrinkRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ChatWithKnowledgeBaseShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The cluster ID.
+   * The instance ID.
    * 
-   * >  You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/196830.html) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
+   * > 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.
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class ChatWithKnowledgeBaseShrinkRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * Whether to return the retrieved result. Default value: false.
+   * Whether to include the raw retrieval results from the knowledge base in the response. Default: `false`.
    * 
    * @example
    * false
@@ -25,12 +25,12 @@ export class ChatWithKnowledgeBaseShrinkRequest extends $dara.Model {
   includeKnowledgeBaseResults?: boolean;
   /**
    * @remarks
-   * The knowledge retrieval parameter object. If you do not specify this parameter, only chat mode is enabled.
+   * Parameters for knowledge retrieval. If omitted, the operation performs a standard chat without retrieving from a knowledge base.
    */
   knowledgeParamsShrink?: string;
   /**
    * @remarks
-   * The Large Language Model (LLM) invocation parameter object.
+   * The parameters for calling the large language model (LLM).
    * 
    * This parameter is required.
    */
@@ -38,12 +38,15 @@ export class ChatWithKnowledgeBaseShrinkRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The system prompt template, which should include {{ text_chunks }},{{ user_system_prompt }},{{ graph_entities },{{ graph_relations }}. If any of these placeholders are not specified, the corresponding section should have no effect.
+   * 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.
+   * 
+   * @example
+   * "参考以下知识回答问题:{{ text_chunks }}"
    */
   promptParams?: string;
   /**
    * @remarks
-   * 实例所在的地域ID
+   * The region ID of the instance.
    * 
    * This parameter is required.
    *