@alicloud/gpdb20160503 3.7.0 → 3.9.0

package/src/models/ChatWithKnowledgeBaseStreamResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessageToolCallsFunction extends $dara.Model {
   /**
    * @remarks
-   * The arguments for the function call, generated by the model in JSON format.
+   * The arguments of the called function.
    * 
    * @example
    * {"city":"hangzhou"}
@@ -13,7 +13,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
   arguments?: string;
   /**
    * @remarks
-   * The name of the function to call.
+   * The name of the called function.
    * 
    * @example
    * "get_weather"
@@ -45,12 +45,12 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessageToolCalls extends $dara.Model {
   /**
    * @remarks
-   * Details of the function that the model wants to call.
+   * The information about the called function.
    */
   function?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessageToolCallsFunction;
   /**
    * @remarks
-   * The ID of the tool call.
+   * ID。
    * 
    * @example
    * "chatcmpl-c1bebafa-cc48-44e2-88c6-1a3572952f8e"
@@ -58,7 +58,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
   id?: string;
   /**
    * @remarks
-   * The index of the tool in the `Input` parameter of the request, starting from 0.
+   * The index of this tool in the Input request parameter, starting from 0.
    * 
    * @example
    * 1
@@ -95,7 +95,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage extends $dara.Model {
   /**
    * @remarks
-   * The message content.
+   * The document content.
    * 
    * @example
    * The weather in Hangzhou is sunny.
@@ -103,7 +103,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
   content?: string;
   /**
    * @remarks
-   * The model\\"s chain of thought (CoT) content.
+   * The chain-of-thought content of the model.
    * 
    * @example
    * Logical reasoning process
@@ -111,13 +111,11 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
   reasoningContent?: string;
   /**
    * @remarks
-   * The role of the message author. Valid values:
-   * 
-   * - `system`
+   * The message role. Valid values:
    * 
-   * - `user`
-   * 
-   * - `assistant`
+   * - system
+   * - user
+   * - assistant.
    * 
    * @example
    * user
@@ -125,7 +123,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
   role?: string;
   /**
    * @remarks
-   * The tool call responses.
+   * The tool invocation response.
    */
   toolCalls?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessageToolCalls[];
   static names(): { [key: string]: string } {
@@ -161,7 +159,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoices extends $dara.Model {
   /**
    * @remarks
-   * The reason the model stopped generating output.
+   * The stop reason.
    * 
    * @example
    * finish
@@ -169,7 +167,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoices extend
   finishReason?: string;
   /**
    * @remarks
-   * The index of the choice.
+   * The response index.
    * 
    * @example
    * 0
@@ -177,7 +175,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoices extend
   index?: number;
   /**
    * @remarks
-   * The response from the large language model (LLM).
+   * The large language model response.
    */
   message?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoicesMessage;
   static names(): { [key: string]: string } {
@@ -211,7 +209,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoices extend
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsagePromptTokensDetails extends $dara.Model {
   /**
    * @remarks
-   * The number of prompt tokens served from the cache.
+   * The number of tokens that hit the cache.
    * 
    * @example
    * 24
@@ -241,7 +239,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsagePromptTok
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsage extends $dara.Model {
   /**
    * @remarks
-   * The number of tokens in the generated response.
+   * The number of tokens consumed for generating the content.
    * 
    * @example
    * 42
@@ -249,7 +247,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsage extends
   completionTokens?: number;
   /**
    * @remarks
-   * The number of tokens in the input prompt.
+   * The number of tokens consumed by the input prompt.
    * 
    * @example
    * 42
@@ -257,7 +255,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsage extends
   promptTokens?: number;
   /**
    * @remarks
-   * Details about the prompt token usage.
+   * The prompt token details.
    */
   promptTokensDetails?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsagePromptTokensDetails;
   /**
@@ -301,12 +299,12 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsage extends
 export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletion extends $dara.Model {
   /**
    * @remarks
-   * The streaming output content.
+   * The text content generated in real time.
    */
   choices?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionChoices[];
   /**
    * @remarks
-   * The creation time, in Unix timestamp format.
+   * The creation time.
    * 
    * @example
    * 1758529748
@@ -330,7 +328,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyChatCompletion extends $dara
   model?: string;
   /**
    * @remarks
-   * The token usage statistics for the completion.
+   * The number of tokens used by the large language model output.
    */
   usage?: ChatWithKnowledgeBaseStreamResponseBodyChatCompletionUsage;
   static names(): { [key: string]: string } {
@@ -387,9 +385,9 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   fileName?: string;
   /**
    * @remarks
-   * The public URL of the retrieved image. By default, the URL is valid for 2 hours.
+   * The public URL of the image in the query result. The URL is valid for 2 hours by default.
    * 
-   * You can use the `UrlExpiration` parameter to specify a custom validity period.
+   * You can specify a custom validity period by using the UrlExpiration parameter.
    * 
    * @example
    * http://dailyshort-sh.oss-cn-shanghai.aliyuncs.com/vod-8efba5/f06147795c6c71f080605420848d0302/0ca34d5743a84bf7c68f489a60715dac-ld.mp4
@@ -397,9 +395,9 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   fileURL?: string;
   /**
    * @remarks
-   * The unique ID of the vector record.
+   * The unique ID of this vector data entry.
    * 
-   * > 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.
+   * > If this value is empty, the database automatically generates a UUID. If this value is not empty and conflicts with an existing ID in the database, the API data overwrites the existing value in the database.
    * 
    * @example
    * 273e3fc7-8f56-4167-a1bb-d35d2f3b9043
@@ -407,7 +405,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   id?: string;
   /**
    * @remarks
-   * Metadata from the document loader, captured during document ingestion.
+   * The metadata generated by the document loader during loading.
    * 
    * @example
    * {"page":1}
@@ -415,12 +413,12 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   loaderMetadata?: any;
   /**
    * @remarks
-   * The user-defined metadata.
+   * The metadata.
    */
   metadata?: { [key: string]: any };
   /**
    * @remarks
-   * The rerank score.
+   * The reranking score.
    * 
    * @example
    * 0.12
@@ -428,7 +426,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   rerankScore?: number;
   /**
    * @remarks
-   * The source of the match. `1` indicates vector search, `2` indicates full-text search, and `3` indicates hybrid recall.
+   * The source of the retrieve result. A value of 1 indicates AISearch retrieve, 2 indicates full-text index retrieve, and 3 indicates multi-channel recall.
    * 
    * @example
    * 0.12
@@ -436,7 +434,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
   retrievalSource?: number;
   /**
    * @remarks
-   * The similarity score. The score is calculated based on the distance metric specified when the index was created (`l2/ip/cosine`).
+   * The similarity score of this data entry. The scoring algorithm is related to the algorithm specified during index creation (l2, ip, or cosine).
    * 
    * @example
    * 10
@@ -495,9 +493,9 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultM
 export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultUsage extends $dara.Model {
   /**
    * @remarks
-   * The number of tokens used for embedding.
+   * The number of tokens used during vectorization.
    * 
-   * > 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.
+   * > A token is the smallest unit into which input text is segmented. A token can be a word, a phrase, a punctuation mark, or a character.
    * 
    * @example
    * 158
@@ -527,17 +525,17 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultU
 export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResult extends $dara.Model {
   /**
    * @remarks
-   * A list of retrieved entities.
+   * The entity details.
    */
   entities?: string[];
   /**
    * @remarks
-   * A list of retrieved matches.
+   * The recall items.
    */
   matches?: ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultMatches[];
   /**
    * @remarks
-   * A list of relationship edges.
+   * The relation names.
    */
   relations?: string[];
   /**
@@ -550,11 +548,9 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResult
   requestId?: string;
   /**
    * @remarks
-   * The status of the API call. Valid values:
-   * 
-   * - **success**: The call succeeded.
-   * 
-   * - **fail**: The call failed.
+   * The API execution status. Valid values:
+   * - **success**: The execution is successful.
+   * - **fail**: The execution failed.
    * 
    * @example
    * success
@@ -570,7 +566,7 @@ export class ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResult
   tokens?: number;
   /**
    * @remarks
-   * The number of tokens consumed for embedding.
+   * The number of tokens or entries consumed by document understanding or embedding.
    */
   usage?: ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResultUsage;
   static names(): { [key: string]: string } {
@@ -634,7 +630,7 @@ export class ChatWithKnowledgeBaseStreamResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The retrieval results from multiple knowledge bases.
+   * The recall information from multiple knowledge bases.
    */
   multiCollectionRecallResult?: ChatWithKnowledgeBaseStreamResponseBodyMultiCollectionRecallResult;
   /**
@@ -647,11 +643,9 @@ export class ChatWithKnowledgeBaseStreamResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The status of the request. Valid values:
-   * 
-   * - **success**: The request succeeded.
-   * 
-   * - **fail**: The request failed.
+   * The status. Valid values:
+   * - **success**: Successful.
+   * - **fail**: Failed.
    * 
    * @example
    * success

package/src/models/ChatWithKnowledgeBaseStreamShrinkRequest.ts

@@ -7,7 +7,7 @@ export class ChatWithKnowledgeBaseStreamShrinkRequest extends $dara.Model {
    * @remarks
    * The instance ID.
    * 
-   * > 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.
+   * > 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 region.
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class ChatWithKnowledgeBaseStreamShrinkRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * Specifies whether to include the retrieved knowledge base results in the response. Default value: `false`.
+   * Specifies whether to return recall results. Default value: false.
    * 
    * @example
    * false
@@ -25,12 +25,12 @@ export class ChatWithKnowledgeBaseStreamShrinkRequest extends $dara.Model {
   includeKnowledgeBaseResults?: boolean;
   /**
    * @remarks
-   * Parameters for knowledge retrieval. If omitted, the API performs a chat-only operation.
+   * The knowledge retrieval parameter object. If this parameter is not specified, only chat is performed.
    */
   knowledgeParamsShrink?: string;
   /**
    * @remarks
-   * An object that contains parameters for the Large Language Model (LLM) call.
+   * The large language model (LLM) invocation parameter object.
    * 
    * This parameter is required.
    */
@@ -38,7 +38,7 @@ export class ChatWithKnowledgeBaseStreamShrinkRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * 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.
+   * The system prompt template. The template must include {{ text_chunks }}, {{ user_system_prompt }}, {{ graph_entities }}, and {{ graph_relations }}. If not specified, this part does not take effect.
    * 
    * @example
    * "参考以下知识回答问题:{{ text_chunks }}"
@@ -46,7 +46,7 @@ export class ChatWithKnowledgeBaseStreamShrinkRequest extends $dara.Model {
   promptParams?: string;
   /**
    * @remarks
-   * The instance\\"s region ID.
+   * The ID of the region where the instance resides.
    * 
    * This parameter is required.
    * 

package/src/models/PauseSaasServiceRequest.ts

@@ -0,0 +1,41 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class PauseSaasServiceRequest extends $dara.Model {
+  /**
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * agdb-xxxxx
+   */
+  serviceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      regionId: 'RegionId',
+      serviceId: 'ServiceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      regionId: 'string',
+      serviceId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PauseSaasServiceResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { PauseSaasServiceResponseBody } from "./PauseSaasServiceResponseBody";
+
+
+export class PauseSaasServiceResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: PauseSaasServiceResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: PauseSaasServiceResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PauseSaasServiceResponseBody.ts

@@ -0,0 +1,38 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class PauseSaasServiceResponseBody extends $dara.Model {
+  /**
+   * @example
+   * ABB39CC3-4488-4857-905D-2E4A051D0521
+   */
+  requestId?: string;
+  /**
+   * @example
+   * drama-123456
+   */
+  serviceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      requestId: 'RequestId',
+      serviceId: 'ServiceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      requestId: 'string',
+      serviceId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+