@alicloud/gpdb20160503 3.7.0 → 3.9.0

package/src/client.ts

@@ -568,14 +568,14 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Combines a knowledge base with a large language model for intelligent Q&A.
+   * Provides intelligent Q&A services by combining knowledge bases with large models.
    * 
    * @remarks
-   * This API lets you interact with a large language model using specific knowledge base collections to ensure responses are grounded in their content. You can customize requests by configuring parameters, including the database instance ID, knowledge retrieval parameters, and model inference parameters. The API provides a default system prompt template and supports custom system prompts.
-   * - **DBInstanceId**: Required. Specifies the ID of the database instance.
-   * - **KnowledgeParams**: Optional. Contains parameters for knowledge retrieval, such as retrieval content and merge policies.
-   * - **ModelParams**: Required. Contains parameters for model inference, such as the message list and the model name.
-   * - **PromptTemplate**: Optional. Specifies a custom system prompt template.
+   * This API allows users to interact with a large model through specified knowledge base collections to obtain answers based on knowledge base content. It supports configuring various parameters to customize requests, including but not limited to database instance ID, knowledge retrieval parameters, model inference parameters, etc. Additionally, it provides a default system prompt template and allows users to customize system prompts.
+   * - **DBInstanceId**: Required. Specifies the database instance ID.
+   * - **KnowledgeParams**: Optional. Contains parameters related to knowledge retrieval, such as retrieval content, merge strategies, etc.
+   * - **ModelParams**: Required. Contains parameters related to model inference, such as message list, model name, etc.
+   * - **PromptTemplate**: Optional. Used to customize the system prompt template.
    * 
    * @param tmpReq - ChatWithKnowledgeBaseRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -640,14 +640,14 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Combines a knowledge base with a large language model for intelligent Q&A.
+   * Provides intelligent Q&A services by combining knowledge bases with large models.
    * 
    * @remarks
-   * This API lets you interact with a large language model using specific knowledge base collections to ensure responses are grounded in their content. You can customize requests by configuring parameters, including the database instance ID, knowledge retrieval parameters, and model inference parameters. The API provides a default system prompt template and supports custom system prompts.
-   * - **DBInstanceId**: Required. Specifies the ID of the database instance.
-   * - **KnowledgeParams**: Optional. Contains parameters for knowledge retrieval, such as retrieval content and merge policies.
-   * - **ModelParams**: Required. Contains parameters for model inference, such as the message list and the model name.
-   * - **PromptTemplate**: Optional. Specifies a custom system prompt template.
+   * This API allows users to interact with a large model through specified knowledge base collections to obtain answers based on knowledge base content. It supports configuring various parameters to customize requests, including but not limited to database instance ID, knowledge retrieval parameters, model inference parameters, etc. Additionally, it provides a default system prompt template and allows users to customize system prompts.
+   * - **DBInstanceId**: Required. Specifies the database instance ID.
+   * - **KnowledgeParams**: Optional. Contains parameters related to knowledge retrieval, such as retrieval content, merge strategies, etc.
+   * - **ModelParams**: Required. Contains parameters related to model inference, such as message list, model name, etc.
+   * - **PromptTemplate**: Optional. Used to customize the system prompt template.
    * 
    * @param request - ChatWithKnowledgeBaseRequest
    * @returns ChatWithKnowledgeBaseResponse
@@ -658,14 +658,14 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * This service combines a knowledge base with a large model to provide intelligent Q&A. You can access the streaming interface using Server-Sent Events (SSE) or the Java asynchronous SDK.
+   * Provides AI chat services by combining knowledge bases with large language models. This is a streaming API called through SSE or the Java asynchronous SDK.
    * 
    * @remarks
-   * Use this API to retrieve answers from a large language model based on content from a specified knowledge base. You can customize the request by configuring various parameters, including the database instance ID, knowledge retrieval parameters, and model inference parameters. The API includes a default system prompt template, and you can also specify a custom one.
-   * - DBInstanceId: Required. The ID of the database instance.
-   * - KnowledgeParams: Optional. Parameters for knowledge retrieval, such as retrieval content and the merge policy.
-   * - ModelParams: Required. Parameters for model inference, such as the message list and the model name.
-   * - PromptTemplate: Optional. A custom system prompt template.
+   * This API allows you to interact with a large language model by using specified knowledge base collections to obtain answers based on knowledge base content. You can configure various parameters to customize requests, including but not limited to the database instance ID, knowledge retrieval parameters, and model inference parameters. A default system prompt template is provided, and you can also customize the system prompt.
+   * - DBInstanceId: Required. Specifies the database instance ID.
+   * - KnowledgeParams: Optional. Contains knowledge retrieval parameters such as retrieval content and merge strategy.
+   * - ModelParams: Required. Contains model inference parameters such as the message list and model name.
+   * - PromptTemplate: Optional. Specifies a custom system prompt template.
    * 
    * @param tmpReq - ChatWithKnowledgeBaseStreamRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -744,14 +744,14 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * This service combines a knowledge base with a large model to provide intelligent Q&A. You can access the streaming interface using Server-Sent Events (SSE) or the Java asynchronous SDK.
+   * Provides AI chat services by combining knowledge bases with large language models. This is a streaming API called through SSE or the Java asynchronous SDK.
    * 
    * @remarks
-   * Use this API to retrieve answers from a large language model based on content from a specified knowledge base. You can customize the request by configuring various parameters, including the database instance ID, knowledge retrieval parameters, and model inference parameters. The API includes a default system prompt template, and you can also specify a custom one.
-   * - DBInstanceId: Required. The ID of the database instance.
-   * - KnowledgeParams: Optional. Parameters for knowledge retrieval, such as retrieval content and the merge policy.
-   * - ModelParams: Required. Parameters for model inference, such as the message list and the model name.
-   * - PromptTemplate: Optional. A custom system prompt template.
+   * This API allows you to interact with a large language model by using specified knowledge base collections to obtain answers based on knowledge base content. You can configure various parameters to customize requests, including but not limited to the database instance ID, knowledge retrieval parameters, and model inference parameters. A default system prompt template is provided, and you can also customize the system prompt.
+   * - DBInstanceId: Required. Specifies the database instance ID.
+   * - KnowledgeParams: Optional. Contains knowledge retrieval parameters such as retrieval content and merge strategy.
+   * - ModelParams: Required. Contains model inference parameters such as the message list and model name.
+   * - PromptTemplate: Optional. Specifies a custom system prompt template.
    * 
    * @param tmpReq - ChatWithKnowledgeBaseStreamRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -816,14 +816,14 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * This service combines a knowledge base with a large model to provide intelligent Q&A. You can access the streaming interface using Server-Sent Events (SSE) or the Java asynchronous SDK.
+   * Provides AI chat services by combining knowledge bases with large language models. This is a streaming API called through SSE or the Java asynchronous SDK.
    * 
    * @remarks
-   * Use this API to retrieve answers from a large language model based on content from a specified knowledge base. You can customize the request by configuring various parameters, including the database instance ID, knowledge retrieval parameters, and model inference parameters. The API includes a default system prompt template, and you can also specify a custom one.
-   * - DBInstanceId: Required. The ID of the database instance.
-   * - KnowledgeParams: Optional. Parameters for knowledge retrieval, such as retrieval content and the merge policy.
-   * - ModelParams: Required. Parameters for model inference, such as the message list and the model name.
-   * - PromptTemplate: Optional. A custom system prompt template.
+   * This API allows you to interact with a large language model by using specified knowledge base collections to obtain answers based on knowledge base content. You can configure various parameters to customize requests, including but not limited to the database instance ID, knowledge retrieval parameters, and model inference parameters. A default system prompt template is provided, and you can also customize the system prompt.
+   * - DBInstanceId: Required. Specifies the database instance ID.
+   * - KnowledgeParams: Optional. Contains knowledge retrieval parameters such as retrieval content and merge strategy.
+   * - ModelParams: Required. Contains model inference parameters such as the message list and model name.
+   * - PromptTemplate: Optional. Specifies a custom system prompt template.
    * 
    * @param request - ChatWithKnowledgeBaseStreamRequest
    * @returns ChatWithKnowledgeBaseStreamResponse
@@ -15381,6 +15381,58 @@ export default class Client extends OpenApi {
     return await this.pauseInstanceWithOptions(request, runtime);
   }
 
+  /**
+   * 暂停SaaS服务
+   * 
+   * @remarks
+   * 删除模型服务。
+   * 
+   * @param request - PauseSaasServiceRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns PauseSaasServiceResponse
+   */
+  async pauseSaasServiceWithOptions(request: $_model.PauseSaasServiceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PauseSaasServiceResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.regionId)) {
+      query["RegionId"] = request.regionId;
+    }
+
+    if (!$dara.isNull(request.serviceId)) {
+      query["ServiceId"] = request.serviceId;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "PauseSaasService",
+      version: "2016-05-03",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.PauseSaasServiceResponse>(await this.callApi(params, req, runtime), new $_model.PauseSaasServiceResponse({}));
+  }
+
+  /**
+   * 暂停SaaS服务
+   * 
+   * @remarks
+   * 删除模型服务。
+   * 
+   * @param request - PauseSaasServiceRequest
+   * @returns PauseSaasServiceResponse
+   */
+  async pauseSaasService(request: $_model.PauseSaasServiceRequest): Promise<$_model.PauseSaasServiceResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.pauseSaasServiceWithOptions(request, runtime);
+  }
+
   /**
    * Pauses a Supabase instance.
    * 
@@ -15576,7 +15628,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Query a document collection with natural language to retrieve vectors and metadata.
+   * Retrieves vectors and metadata from a specified document collection using natural language queries.
    * 
    * @param tmpReq - QueryContentRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -15727,7 +15779,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Query a document collection with natural language to retrieve vectors and metadata.
+   * Retrieves vectors and metadata from a specified document collection using natural language queries.
    * 
    * @param request - QueryContentRequest
    * @returns QueryContentResponse
@@ -15824,7 +15876,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieve vectors and metadata from specified knowledge bases using a natural-language query, returning the merged results from a multi-channel recall.
+   * Retrieves vectors and metadata from multiple specified document collections by using natural language statements, merges multi-channel recall results, and returns the combined results.
    * 
    * @param tmpReq - QueryKnowledgeBasesContentRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -15905,7 +15957,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieve vectors and metadata from specified knowledge bases using a natural-language query, returning the merged results from a multi-channel recall.
+   * Retrieves vectors and metadata from multiple specified document collections by using natural language statements, merges multi-channel recall results, and returns the combined results.
    * 
    * @param request - QueryKnowledgeBasesContentRequest
    * @returns QueryKnowledgeBasesContentResponse
@@ -16147,6 +16199,62 @@ export default class Client extends OpenApi {
     return await this.resetAccountPasswordWithOptions(request, runtime);
   }
 
+  /**
+   * Resets a Supabase branch.
+   * 
+   * @remarks
+   * Resets a child branch to the latest data of its parent branch. The main branch, branches without a parent branch, branches with child branches, and protected branches cannot be reset.
+   * 
+   * @param request - ResetBranchRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns ResetBranchResponse
+   */
+  async resetBranchWithOptions(request: $_model.ResetBranchRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ResetBranchResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.branchId)) {
+      query["BranchId"] = request.branchId;
+    }
+
+    if (!$dara.isNull(request.projectId)) {
+      query["ProjectId"] = request.projectId;
+    }
+
+    if (!$dara.isNull(request.regionId)) {
+      query["RegionId"] = request.regionId;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "ResetBranch",
+      version: "2016-05-03",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.ResetBranchResponse>(await this.callApi(params, req, runtime), new $_model.ResetBranchResponse({}));
+  }
+
+  /**
+   * Resets a Supabase branch.
+   * 
+   * @remarks
+   * Resets a child branch to the latest data of its parent branch. The main branch, branches without a parent branch, branches with child branches, and protected branches cannot be reset.
+   * 
+   * @param request - ResetBranchRequest
+   * @returns ResetBranchResponse
+   */
+  async resetBranch(request: $_model.ResetBranchRequest): Promise<$_model.ResetBranchResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.resetBranchWithOptions(request, runtime);
+  }
+
   /**
    * Resets the IMV statistics.
    * 
@@ -16357,6 +16465,82 @@ export default class Client extends OpenApi {
     return await this.restartSupabaseProjectWithOptions(request, runtime);
   }
 
+  /**
+   * Recovers a Supabase branch.
+   * 
+   * @remarks
+   * Recovers a target branch to a specified point in time or LSN of the source branch. Before recovery, you can specify a backup branch name to preserve the original target branch.
+   * 
+   * @param request - RestoreBranchRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns RestoreBranchResponse
+   */
+  async restoreBranchWithOptions(request: $_model.RestoreBranchRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RestoreBranchResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.branchId)) {
+      query["BranchId"] = request.branchId;
+    }
+
+    if (!$dara.isNull(request.clientToken)) {
+      query["ClientToken"] = request.clientToken;
+    }
+
+    if (!$dara.isNull(request.preserveUnderName)) {
+      query["PreserveUnderName"] = request.preserveUnderName;
+    }
+
+    if (!$dara.isNull(request.projectId)) {
+      query["ProjectId"] = request.projectId;
+    }
+
+    if (!$dara.isNull(request.regionId)) {
+      query["RegionId"] = request.regionId;
+    }
+
+    if (!$dara.isNull(request.sourceBranchId)) {
+      query["SourceBranchId"] = request.sourceBranchId;
+    }
+
+    if (!$dara.isNull(request.sourceBranchLsn)) {
+      query["SourceBranchLsn"] = request.sourceBranchLsn;
+    }
+
+    if (!$dara.isNull(request.sourceBranchTimestamp)) {
+      query["SourceBranchTimestamp"] = request.sourceBranchTimestamp;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "RestoreBranch",
+      version: "2016-05-03",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.RestoreBranchResponse>(await this.callApi(params, req, runtime), new $_model.RestoreBranchResponse({}));
+  }
+
+  /**
+   * Recovers a Supabase branch.
+   * 
+   * @remarks
+   * Recovers a target branch to a specified point in time or LSN of the source branch. Before recovery, you can specify a backup branch name to preserve the original target branch.
+   * 
+   * @param request - RestoreBranchRequest
+   * @returns RestoreBranchResponse
+   */
+  async restoreBranch(request: $_model.RestoreBranchRequest): Promise<$_model.RestoreBranchResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.restoreBranchWithOptions(request, runtime);
+  }
+
   /**
    * Restores a Supabase project from a snapshot.
    * 
@@ -16535,6 +16719,58 @@ export default class Client extends OpenApi {
     return await this.resumeInstanceWithOptions(request, runtime);
   }
 
+  /**
+   * 恢复SaaS服务
+   * 
+   * @remarks
+   * 删除模型服务。
+   * 
+   * @param request - ResumeSaasServiceRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns ResumeSaasServiceResponse
+   */
+  async resumeSaasServiceWithOptions(request: $_model.ResumeSaasServiceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ResumeSaasServiceResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.regionId)) {
+      query["RegionId"] = request.regionId;
+    }
+
+    if (!$dara.isNull(request.serviceId)) {
+      query["ServiceId"] = request.serviceId;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "ResumeSaasService",
+      version: "2016-05-03",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.ResumeSaasServiceResponse>(await this.callApi(params, req, runtime), new $_model.ResumeSaasServiceResponse({}));
+  }
+
+  /**
+   * 恢复SaaS服务
+   * 
+   * @remarks
+   * 删除模型服务。
+   * 
+   * @param request - ResumeSaasServiceRequest
+   * @returns ResumeSaasServiceResponse
+   */
+  async resumeSaasService(request: $_model.ResumeSaasServiceRequest): Promise<$_model.ResumeSaasServiceResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.resumeSaasServiceWithOptions(request, runtime);
+  }
+
   /**
    * Resumes a Supabase instance.
    * 
@@ -16587,6 +16823,62 @@ export default class Client extends OpenApi {
     return await this.resumeSupabaseProjectWithOptions(request, runtime);
   }
 
+  /**
+   * Sets the default branch for a Supabase project.
+   * 
+   * @remarks
+   * Sets a specified branch as the default branch for a Supabase project.
+   * 
+   * @param request - SetAsDefaultBranchRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns SetAsDefaultBranchResponse
+   */
+  async setAsDefaultBranchWithOptions(request: $_model.SetAsDefaultBranchRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SetAsDefaultBranchResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.branchId)) {
+      query["BranchId"] = request.branchId;
+    }
+
+    if (!$dara.isNull(request.projectId)) {
+      query["ProjectId"] = request.projectId;
+    }
+
+    if (!$dara.isNull(request.regionId)) {
+      query["RegionId"] = request.regionId;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "SetAsDefaultBranch",
+      version: "2016-05-03",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.SetAsDefaultBranchResponse>(await this.callApi(params, req, runtime), new $_model.SetAsDefaultBranchResponse({}));
+  }
+
+  /**
+   * Sets the default branch for a Supabase project.
+   * 
+   * @remarks
+   * Sets a specified branch as the default branch for a Supabase project.
+   * 
+   * @param request - SetAsDefaultBranchRequest
+   * @returns SetAsDefaultBranchResponse
+   */
+  async setAsDefaultBranch(request: $_model.SetAsDefaultBranchRequest): Promise<$_model.SetAsDefaultBranchResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.setAsDefaultBranchWithOptions(request, runtime);
+  }
+
   /**
    * Enables or disables a plan for an AnalyticDB for PostgreSQL instance.
    * 
@@ -17227,6 +17519,86 @@ export default class Client extends OpenApi {
     return await this.untagSupabaseProjectWithOptions(request, runtime);
   }
 
+  /**
+   * Updates Supabase branch information.
+   * 
+   * @remarks
+   * This operation modifies the branch name, description, tags, protection status, and automatic deletion time upon expiration.
+   * 
+   * @param request - UpdateBranchRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns UpdateBranchResponse
+   */
+  async updateBranchWithOptions(request: $_model.UpdateBranchRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateBranchResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.branchId)) {
+      query["BranchId"] = request.branchId;
+    }
+
+    if (!$dara.isNull(request.branchName)) {
+      query["BranchName"] = request.branchName;
+    }
+
+    if (!$dara.isNull(request.clearExpiresAt)) {
+      query["ClearExpiresAt"] = request.clearExpiresAt;
+    }
+
+    if (!$dara.isNull(request.description)) {
+      query["Description"] = request.description;
+    }
+
+    if (!$dara.isNull(request.expiresAt)) {
+      query["ExpiresAt"] = request.expiresAt;
+    }
+
+    if (!$dara.isNull(request.projectId)) {
+      query["ProjectId"] = request.projectId;
+    }
+
+    if (!$dara.isNull(request.protected)) {
+      query["Protected"] = request.protected;
+    }
+
+    if (!$dara.isNull(request.regionId)) {
+      query["RegionId"] = request.regionId;
+    }
+
+    if (!$dara.isNull(request.tag)) {
+      query["Tag"] = request.tag;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "UpdateBranch",
+      version: "2016-05-03",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.UpdateBranchResponse>(await this.callApi(params, req, runtime), new $_model.UpdateBranchResponse({}));
+  }
+
+  /**
+   * Updates Supabase branch information.
+   * 
+   * @remarks
+   * This operation modifies the branch name, description, tags, protection status, and automatic deletion time upon expiration.
+   * 
+   * @param request - UpdateBranchRequest
+   * @returns UpdateBranchResponse
+   */
+  async updateBranch(request: $_model.UpdateBranchRequest): Promise<$_model.UpdateBranchResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.updateBranchWithOptions(request, runtime);
+  }
+
   /**
    * Update Metadata of Collection Data
    *