@alicloud/bailian20231229 2.6.2 → 2.7.1

package/src/client.ts

@@ -30,7 +30,14 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 添加类目
+   * Creates a category in the specified workspace to categorize and manage documents. You can create up to 1,000 categories in each workspace.
+   * 
+   * @remarks
+   *   You cannot use API to create structured table. To create a table, go to [Data Management](https://bailian.console.alibabacloud.com/#/data-center) in the console. You can associate a knowledge base with ApsaraDB for RDS to automatically update structured knowledge base. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
+   * *   If you are using a RAM user, you must first obtain the OpenAPI management permissions (namely sfm:AddCategory) of Model Studio. For more information, see [Grant OpenAPI permissions to a RAM user](https://help.aliyun.com/document_detail/2848578.html). If you are using the Alibaba Cloud account, you do not need permissions. We recommend that you use [the latest version of the SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
+   * *   You can create up to 1,000 categories in each workspace.
+   * *   This interface is not idempotent.
+   * **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
    * 
    * @param request - AddCategoryRequest
    * @param headers - map
@@ -71,7 +78,14 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 添加类目
+   * Creates a category in the specified workspace to categorize and manage documents. You can create up to 1,000 categories in each workspace.
+   * 
+   * @remarks
+   *   You cannot use API to create structured table. To create a table, go to [Data Management](https://bailian.console.alibabacloud.com/#/data-center) in the console. You can associate a knowledge base with ApsaraDB for RDS to automatically update structured knowledge base. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
+   * *   If you are using a RAM user, you must first obtain the OpenAPI management permissions (namely sfm:AddCategory) of Model Studio. For more information, see [Grant OpenAPI permissions to a RAM user](https://help.aliyun.com/document_detail/2848578.html). If you are using the Alibaba Cloud account, you do not need permissions. We recommend that you use [the latest version of the SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
+   * *   You can create up to 1,000 categories in each workspace.
+   * *   This interface is not idempotent.
+   * **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
    * 
    * @param request - AddCategoryRequest
    * @returns AddCategoryResponse
@@ -320,7 +334,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 申请临时文件存储上传许可
+   * This interface is intended for pro-code deployment only; other scenarios are currently not supported. It is used to apply for a temporary file upload lease. After obtaining the lease, you must upload the file manually.
+   * 
+   * @remarks
+   * 1\\. This interface is intended for pro-code deployment only; other scenarios are currently not supported. 2. After obtaining the temporary file upload lease via this interface, upload the file manually.
    * 
    * @param request - ApplyTempStorageLeaseRequest
    * @param headers - map
@@ -357,7 +374,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 申请临时文件存储上传许可
+   * This interface is intended for pro-code deployment only; other scenarios are currently not supported. It is used to apply for a temporary file upload lease. After obtaining the lease, you must upload the file manually.
+   * 
+   * @remarks
+   * 1\\. This interface is intended for pro-code deployment only; other scenarios are currently not supported. 2. After obtaining the temporary file upload lease via this interface, upload the file manually.
    * 
    * @param request - ApplyTempStorageLeaseRequest
    * @returns ApplyTempStorageLeaseResponse
@@ -1504,6 +1524,59 @@ export default class Client extends OpenApi {
     return await this.getIndexJobStatusWithOptions(WorkspaceId, request, headers, runtime);
   }
 
+  /**
+   * 获取索引监控情况
+   * 
+   * @param request - GetIndexMonitorRequest
+   * @param headers - map
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns GetIndexMonitorResponse
+   */
+  async getIndexMonitorWithOptions(WorkspaceId: string, request: $_model.GetIndexMonitorRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.GetIndexMonitorResponse> {
+    request.validate();
+    let query : {[key: string ]: any} = { };
+    if (!$dara.isNull(request.endTimestamp)) {
+      query["EndTimestamp"] = request.endTimestamp;
+    }
+
+    if (!$dara.isNull(request.indexId)) {
+      query["IndexId"] = request.indexId;
+    }
+
+    if (!$dara.isNull(request.startTimestamp)) {
+      query["StartTimestamp"] = request.startTimestamp;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      headers: headers,
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "GetIndexMonitor",
+      version: "2023-12-29",
+      protocol: "HTTPS",
+      pathname: `/${$dara.URL.percentEncode(WorkspaceId)}/rag/index/monitor`,
+      method: "GET",
+      authType: "AK",
+      style: "ROA",
+      reqBodyType: "json",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.GetIndexMonitorResponse>(await this.callApi(params, req, runtime), new $_model.GetIndexMonitorResponse({}));
+  }
+
+  /**
+   * 获取索引监控情况
+   * 
+   * @param request - GetIndexMonitorRequest
+   * @returns GetIndexMonitorResponse
+   */
+  async getIndexMonitor(WorkspaceId: string, request: $_model.GetIndexMonitorRequest): Promise<$_model.GetIndexMonitorResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    let headers : {[key: string ]: string} = { };
+    return await this.getIndexMonitorWithOptions(WorkspaceId, request, headers, runtime);
+  }
+
   /**
    * 获取memory
    * 

package/src/models/ApplyTempStorageLeaseRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ApplyTempStorageLeaseRequest extends $dara.Model {
   /**
    * @remarks
+   * The file name, including the file extension.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ApplyTempStorageLeaseRequest extends $dara.Model {
   fileName?: string;
   /**
    * @remarks
+   * The size of the file, in bytes.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ApplyTempStorageLeaseResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ApplyTempStorageLeaseResponseBodyDataParam extends $dara.Model {
   /**
+   * @remarks
+   * K-V fields to be included in the Header; both Key and Value are strings.
+   * 
    * @example
    * Content-Type: application/json
    */
   headers?: any;
   /**
+   * @remarks
+   * HTTP method for the call. Valid values: PUT POST
+   * 
    * @example
    * PUT
    */
   method?: string;
   /**
+   * @remarks
+   * Authorized URL for the file upload.
+   * 
    * @example
    * https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D
    */
@@ -44,8 +53,15 @@ export class ApplyTempStorageLeaseResponseBodyDataParam extends $dara.Model {
 }
 
 export class ApplyTempStorageLeaseResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * HTTP parameters used for uploading the file.
+   */
   param?: ApplyTempStorageLeaseResponseBodyDataParam;
   /**
+   * @remarks
+   * Unique lease ID. This parameter is required when retrieving the uploaded file within the application later.
+   * 
    * @example
    * 1e6a159107384782be5e45ac4759b247.1719325231035
    */
@@ -78,26 +94,46 @@ export class ApplyTempStorageLeaseResponseBodyData extends $dara.Model {
 
 export class ApplyTempStorageLeaseResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
    * DataCenter.FileTooLarge
    */
   code?: string;
+  /**
+   * @remarks
+   * The returned data fields.
+   */
   data?: ApplyTempStorageLeaseResponseBodyData;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * User not authorized to operate on the specified resource
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 778C0B3B-xxxx-5FC1-A947-36EDD13606AB
    */
   requestId?: string;
   /**
+   * @remarks
+   * The HTTP status code returned.
+   * 
    * @example
    * 200
    */
   status?: string;
+  /**
+   * @remarks
+   * Indicates whether the request was successful.
+   */
   success?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeFileResponseBody.ts

@@ -43,6 +43,7 @@ export class DescribeFileResponseBodyData extends $dara.Model {
    * pdf
    */
   fileType?: string;
+  parseResultDownloadUrl?: string;
   /**
    * @remarks
    * The parser that is used to parse the document. Valid value:
@@ -86,6 +87,7 @@ export class DescribeFileResponseBodyData extends $dara.Model {
       fileId: 'FileId',
       fileName: 'FileName',
       fileType: 'FileType',
+      parseResultDownloadUrl: 'ParseResultDownloadUrl',
       parser: 'Parser',
       sizeInBytes: 'SizeInBytes',
       status: 'Status',
@@ -100,6 +102,7 @@ export class DescribeFileResponseBodyData extends $dara.Model {
       fileId: 'string',
       fileName: 'string',
       fileType: 'string',
+      parseResultDownloadUrl: 'string',
       parser: 'string',
       sizeInBytes: 'number',
       status: 'string',

package/src/models/GetIndexMonitorRequest.ts

@@ -0,0 +1,54 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetIndexMonitorRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 1767604500
+   */
+  endTimestamp?: number;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * kb-123456xxxx
+   */
+  indexId?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 1767604500
+   */
+  startTimestamp?: number;
+  static names(): { [key: string]: string } {
+    return {
+      endTimestamp: 'EndTimestamp',
+      indexId: 'IndexId',
+      startTimestamp: 'StartTimestamp',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      endTimestamp: 'number',
+      indexId: 'string',
+      startTimestamp: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetIndexMonitorResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { GetIndexMonitorResponseBody } from "./GetIndexMonitorResponseBody";
+
+
+export class GetIndexMonitorResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: GetIndexMonitorResponseBody;
+  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: GetIndexMonitorResponseBody,
+    };
+  }
+
+  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/GetIndexMonitorResponseBody.ts

@@ -0,0 +1,77 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetIndexMonitorResponseBody extends $dara.Model {
+  /**
+   * @example
+   * 200
+   */
+  code?: string;
+  /**
+   * @example
+   * {
+   *     "code": "Success",
+   *     "status_code": 200,
+   *     "data": {
+   *         "storageMonitorData": Object{...},
+   *         "qpsMonitorData": Object{...}
+   *     },
+   *     "success": true,
+   *     "message": "success",
+   *     "request_id": "65d34b79-b97e-478e-a0a3-xxx",
+   *     "status": "SUCCESS"
+   * }
+   */
+  data?: any;
+  /**
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @example
+   * 778C0B3B-xxxx-5FC1-A947-36EDD13606AB
+   */
+  requestId?: string;
+  /**
+   * @example
+   * SUCCESS
+   */
+  status?: number;
+  /**
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      message: 'Message',
+      requestId: 'RequestId',
+      status: 'Status',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: 'any',
+      message: 'string',
+      requestId: 'string',
+      status: 'number',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/model.ts

@@ -169,6 +169,9 @@ export { GetAvailableParserTypesResponse } from './GetAvailableParserTypesRespon
 export { GetIndexJobStatusRequest } from './GetIndexJobStatusRequest';
 export { GetIndexJobStatusResponseBody } from './GetIndexJobStatusResponseBody';
 export { GetIndexJobStatusResponse } from './GetIndexJobStatusResponse';
+export { GetIndexMonitorRequest } from './GetIndexMonitorRequest';
+export { GetIndexMonitorResponseBody } from './GetIndexMonitorResponseBody';
+export { GetIndexMonitorResponse } from './GetIndexMonitorResponse';
 export { GetMemoryResponseBody } from './GetMemoryResponseBody';
 export { GetMemoryResponse } from './GetMemoryResponse';
 export { GetMemoryNodeResponseBody } from './GetMemoryNodeResponseBody';