@alicloud/gpdb20160503 3.4.1 → 3.6.0

package/src/models/ChatWithKnowledgeBaseStreamResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessageToolCallsFunction extends $dara.Model {
   /**
    * @remarks
-   * Arguments of the called function.
+   * The arguments for the function call, generated by the model in JSON format.
    * 
    * @example
    * {"city":"hangzhou"}
@@ -13,7 +13,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
   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 ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessageToolCalls extends $dara.Model {
   /**
    * @remarks
-   * Function call information.
+   * Details of the function that the model wants to call.
    */
   function?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessageToolCallsFunction;
   /**
    * @remarks
-   * The ID.
+   * The ID of the tool call.
    * 
    * @example
    * "chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"
@@ -58,7 +58,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
   id?: string;
   /**
    * @remarks
-   * The position of this tool in the \\"input\\" request parameter, which starts from 0.
+   * The index of the tool in the `Input` parameter of the request, starting from 0.
    * 
    * @example
    * 1
@@ -95,12 +95,15 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage extends $dara.Model {
   /**
    * @remarks
-   * The content of the document.
+   * The message content.
+   * 
+   * @example
+   * The weather in Hangzhou is sunny.
    */
   content?: string;
   /**
    * @remarks
-   * Model reasoning chain content.
+   * The model\\"s chain of thought (CoT) content.
    * 
    * @example
    * Logical reasoning process
@@ -108,11 +111,13 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
   reasoningContent?: string;
   /**
    * @remarks
-   * Message role:
+   * The role of the message author. Valid values:
+   * 
+   * - `system`
+   * 
+   * - `user`
    * 
-   * *   system
-   * *   user
-   * *   assistant
+   * - `assistant`
    * 
    * @example
    * user
@@ -120,7 +125,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
   role?: string;
   /**
    * @remarks
-   * Tool call response.
+   * The tool call responses.
    */
   toolCalls?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessageToolCalls[];
   static names(): { [key: string]: string } {
@@ -156,7 +161,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoices extends $dara.Model {
   /**
    * @remarks
-   * Finish reason.
+   * The reason the model stopped generating output.
    * 
    * @example
    * finish
@@ -164,7 +169,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoices extend
   finishReason?: string;
   /**
    * @remarks
-   * The sequence number of the reply.
+   * The index of the choice.
    * 
    * @example
    * 0
@@ -172,7 +177,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoices extend
   index?: number;
   /**
    * @remarks
-   * LLM response.
+   * The response from the large language model (LLM).
    */
   message?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage;
   static names(): { [key: string]: string } {
@@ -206,7 +211,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoices extend
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsagePromptTokensDetails extends $dara.Model {
   /**
    * @remarks
-   * The number of tokens from cache hits.
+   * The number of prompt tokens served from the cache.
    * 
    * @example
    * 24
@@ -236,7 +241,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsagePromptTok
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsage 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 ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsage extends
   completionTokens?: number;
   /**
    * @remarks
-   * The number of tokens consumed by the prompt.
+   * The number of tokens in the input prompt.
    * 
    * @example
    * 42
@@ -252,7 +257,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsage extends
   promptTokens?: number;
   /**
    * @remarks
-   * The details about the prompt token.
+   * Details about the prompt token usage.
    */
   promptTokensDetails?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsagePromptTokensDetails;
   /**
@@ -296,12 +301,12 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsage extends
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletion extends $dara.Model {
   /**
    * @remarks
-   * Text content generated in real time.
+   * The streaming output content.
    */
   choices?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoices[];
   /**
    * @remarks
-   * The creation time.
+   * The creation time, in Unix timestamp format.
    * 
    * @example
    * 1758529748
@@ -309,7 +314,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletion extends $dara
   created?: number;
   /**
    * @remarks
-   * The ID of the response.
+   * The response ID.
    * 
    * @example
    * 273e3fc7-8f56-4167-a1bb-d35d2f3b9043
@@ -317,7 +322,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletion extends $dara
   id?: string;
   /**
    * @remarks
-   * The name of the model.
+   * The name of the model used.
    * 
    * @example
    * qwen-plus
@@ -325,7 +330,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletion extends $dara
   model?: string;
   /**
    * @remarks
-   * The number of tokens used in LLM output.
+   * The token usage statistics for the completion.
    */
   usage?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsage;
   static names(): { [key: string]: string } {
@@ -366,7 +371,10 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletion extends $dara
 export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultMatches 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 ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   fileName?: string;
   /**
    * @remarks
-   * The URL of the image result. By default, the URL is valid for 2 hours.
+   * The public URL of the retrieved image. By default, the URL is valid for 2 hours.
    * 
-   * You can use the UrlExpiration parameter to specify a validity period.
+   * You can use the `UrlExpiration` parameter to specify a custom validity period.
    * 
    * @example
    * http://dailyshort-sh.oss-cn-shanghai.aliyuncs.com/vod-8efba5/f06147795c6c71f080605420848d0302/0ca34d5743a84bf7c68f489a60715dac-ld.mp4
@@ -389,9 +397,9 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   fileURL?: string;
   /**
    * @remarks
-   * The unique ID of the vector data.
+   * The unique ID of the vector record.
    * 
-   * >  If you leave this parameter empty, a unique ID is automatically generated by using uuidgen. If it is not empty and conflicts with an existing ID in the database, the value in the database will be updated with the data from the API.
+   * > If this parameter is left empty, the database automatically generates a UUID. If you provide an ID that conflicts with an existing one, the existing record is updated with the data from the request.
    * 
    * @example
    * 273e3fc7-8f56-4167-a1bb-d35d2f3b9043
@@ -399,7 +407,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   id?: string;
   /**
    * @remarks
-   * Document loader metadata.
+   * Metadata from the document loader, captured during document ingestion.
    * 
    * @example
    * {"page":1}
@@ -407,7 +415,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   loaderMetadata?: any;
   /**
    * @remarks
-   * Metadata.
+   * The user-defined metadata.
    */
   metadata?: { [key: string]: any };
   /**
@@ -420,7 +428,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   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 source of the match. `1` indicates vector search, `2` indicates full-text search, and `3` indicates hybrid recall.
    * 
    * @example
    * 0.12
@@ -428,7 +436,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   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 calculated based on the distance metric specified when the index was created (`l2/ip/cosine`).
    * 
    * @example
    * 10
@@ -487,9 +495,9 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
 export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultUsage extends $dara.Model {
   /**
    * @remarks
-   * The number of tokens that are used during vectorization.
+   * The number of tokens used for embedding.
    * 
-   * >  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 created by splitting the input text. A token can be a unit such as a word, a phrase, a punctuation mark, or a character.
    * 
    * @example
    * 158
@@ -519,22 +527,22 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultU
 export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResult extends $dara.Model {
   /**
    * @remarks
-   * The details of the entity.
+   * A list of retrieved entities.
    */
   entities?: string[];
   /**
    * @remarks
-   * The retrieved item.
+   * A list of retrieved matches.
    */
   matches?: ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultMatches[];
   /**
    * @remarks
-   * The relationship name.
+   * A list of relationship edges.
    */
   relations?: string[];
   /**
    * @remarks
-   * The unique ID of the request.
+   * The request ID.
    * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
@@ -542,10 +550,11 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResult
   requestId?: string;
   /**
    * @remarks
-   * The status of the operation. Valid values:
+   * The status of the API call. Valid values:
    * 
-   * *   **success**.
-   * *   **fail**.
+   * - **success**: The call succeeded.
+   * 
+   * - **fail**: The call failed.
    * 
    * @example
    * success
@@ -553,7 +562,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResult
   status?: string;
   /**
    * @remarks
-   * The number of tokens that are consumed.
+   * The number of tokens consumed.
    * 
    * @example
    * 42
@@ -561,7 +570,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResult
   tokens?: number;
   /**
    * @remarks
-   * The number of tokens that are consumed during document understanding or embedding.
+   * The number of tokens consumed for embedding.
    */
   usage?: ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultUsage;
   static names(): { [key: string]: string } {
@@ -612,12 +621,12 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResult
 export class ChatWithKnowledgeBaseStreamResponseBody extends $dara.Model {
   /**
    * @remarks
-   * model response.
+   * The model response.
    */
   chatCompletion?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletion;
   /**
    * @remarks
-   * The returned information.
+   * The response message.
    * 
    * @example
    * Successful
@@ -625,12 +634,12 @@ export class ChatWithKnowledgeBaseStreamResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Retrieve information from multiple knowledge bases.
+   * The retrieval results from multiple knowledge bases.
    */
   multiCollectionRecallResult?: ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResult;
   /**
    * @remarks
-   * The unique ID of the request.
+   * The request ID.
    * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
@@ -638,10 +647,11 @@ export class ChatWithKnowledgeBaseStreamResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The status of the operation. Valid values:
+   * The status of the request. Valid values:
+   * 
+   * - **success**: The request succeeded.
    * 
-   * *   **success**.
-   * *   **fail**.
+   * - **fail**: The request failed.
    * 
    * @example
    * success

package/src/models/ChatWithKnowledgeBaseStreamShrinkRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ChatWithKnowledgeBaseStreamShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The cluster ID.
+   * The instance ID.
    * 
-   * >  You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.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/86911.html) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specified region.
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class ChatWithKnowledgeBaseStreamShrinkRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * Whether to return the retrieved result. Default value: false.
+   * Specifies whether to include the retrieved knowledge base results in the response. Default value: `false`.
    * 
    * @example
    * false
@@ -25,12 +25,12 @@ export class ChatWithKnowledgeBaseStreamShrinkRequest 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 API performs a chat-only operation.
    */
   knowledgeParamsShrink?: string;
   /**
    * @remarks
-   * The Large Language Model (LLM) invocation parameter object.
+   * An object that contains parameters for the Large Language Model (LLM) call.
    * 
    * This parameter is required.
    */
@@ -38,12 +38,15 @@ export class ChatWithKnowledgeBaseStreamShrinkRequest 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 template for the system prompt. It must include placeholders such as `{{text_chunks}}`, `{{user_system_prompt}}`, `{{graph_entities}}`, and `{{graph_relations}}`. If omitted, no custom prompt template is applied.
+   * 
+   * @example
+   * "参考以下知识回答问题:{{ text_chunks }}"
    */
   promptParams?: string;
   /**
    * @remarks
-   * The region ID of the instance.
+   * The instance\\"s region ID.
    * 
    * This parameter is required.
    * 

package/src/models/CreateAiserviceRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAIServiceRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
+   * > Call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to list all AnalyticDB for PostgreSQL instances in the destination region, including their instance IDs.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,17 +16,39 @@ export class CreateAIServiceRequest extends $dara.Model {
    */
   DBInstanceId?: string;
   /**
+   * @remarks
+   * A description of the service.
+   * 
    * @example
    * dramatest
    */
   description?: string;
   /**
+   * @remarks
+   * A comma-separated list of IP addresses or CIDR blocks in the IP address whitelist. You can specify up to 1000 entries. To block all external IP access, use 127.0.0.1. Valid formats include the following:
+   * 
+   * - 10.23.12.24 (an IPv4 address)
+   * 
+   * - 10.23.12.24/24 (a CIDR block, where /24 indicates the prefix length, from 1 to 32)
+   * 
+   * > After you create the service, call the ModifyAIServiceSecurityIps operation to update the IP address whitelist.
+   * 
    * @example
    * 127.0.0.1
    */
   securityIPList?: string;
   /**
    * @remarks
+   * The service account. It must meet these requirements:
+   * 
+   * - Contain only lowercase letters, digits, and underscores.
+   * 
+   * - Start with a lowercase letter and end with a lowercase letter or digit.
+   * 
+   * - Not start with gp.
+   * 
+   * - Be 2 to 16 characters long.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -31,6 +57,14 @@ export class CreateAIServiceRequest extends $dara.Model {
   serviceAccount?: string;
   /**
    * @remarks
+   * The password for the service account. It must meet these requirements:
+   * 
+   * - Contain at least three of the following: uppercase letters, lowercase letters, digits, and special characters.
+   * 
+   * - Support these special characters: !@#$%^&\\*()_+-=.
+   * 
+   * - Be 8 to 32 characters long.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -39,6 +73,8 @@ export class CreateAIServiceRequest extends $dara.Model {
   serviceAccountPassword?: string;
   /**
    * @remarks
+   * The service type. Only drama is supported.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateAiserviceResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAIServiceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
    */
   requestId?: string;
   /**
+   * @remarks
+   * The service ID.
+   * 
    * @example
    * drama-123456
    */