@alicloud/aimiaobi20230801 1.45.0 → 1.45.2

package/src/models/SearchDatasetDocumentsShrinkRequest.ts

@@ -3,53 +3,120 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class SearchDatasetDocumentsShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * A list of category UUIDs for filtering.
+   */
   categoryUuidsShrink?: string;
+  /**
+   * @remarks
+   * The end time for document creation, specified as a Unix timestamp.
+   */
   createTimeEnd?: number;
+  /**
+   * @remarks
+   * The start time for document creation, specified as a Unix timestamp.
+   */
   createTimeStart?: number;
   /**
+   * @remarks
+   * The ID of the dataset. You must specify either `DatasetId` or `DatasetName`.
+   * 
    * @example
    * 1
    */
   datasetId?: number;
   /**
+   * @remarks
+   * The name of the dataset.
+   * 
    * @example
    * 数据集名称
    */
   datasetName?: string;
+  /**
+   * @remarks
+   * A list of document IDs for filtering.
+   */
   docIdsShrink?: string;
+  /**
+   * @remarks
+   * A list of document types for filtering.
+   */
   docTypesShrink?: string;
+  /**
+   * @remarks
+   * A list of document UUIDs for filtering.
+   */
   docUuidsShrink?: string;
+  /**
+   * @remarks
+   * The end of the time range for filtering, specified as a Unix timestamp.
+   */
   endTime?: number;
   /**
+   * @remarks
+   * A business parameter.
+   * 
    * @example
    * 业务参数
    */
   extend1?: string;
+  /**
+   * @remarks
+   * A reserved business parameter.
+   */
   extend2?: string;
+  /**
+   * @remarks
+   * A reserved business parameter.
+   */
   extend3?: string;
   /**
+   * @remarks
+   * Specifies whether to include the document content in the search results. The default value is `false`.
+   * 
    * @example
    * false
    */
   includeContent?: boolean;
   /**
+   * @remarks
+   * The number of documents to return per page.
+   * 
    * @example
    * 10
    */
   pageSize?: string;
   /**
    * @remarks
+   * The search query.
+   * 
    * This parameter is required.
    * 
    * @example
    * 搜索内容
    */
   query?: string;
+  /**
+   * @remarks
+   * The search mode.
+   */
   searchMode?: string;
+  /**
+   * @remarks
+   * The start of the time range for filtering, specified as a Unix timestamp.
+   */
   startTime?: number;
+  /**
+   * @remarks
+   * A list of tags for filtering.
+   */
   tagsShrink?: string;
   /**
    * @remarks
+   * The ID of the Model Studio workspace. For more information, see [Get workspaceId](https://help.aliyun.com/document_detail/2782167.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/SearchNewsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class SearchNewsRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique ID of the workspace. For more information, see [AgentKey](https://help.aliyun.com/document_detail/3027170.html).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,30 +14,49 @@ export class SearchNewsRequest extends $dara.Model {
    */
   agentKey?: string;
   /**
+   * @remarks
+   * Specifies whether to filter out results with empty content.
+   * 
    * @example
    * false
    */
   filterNotNull?: boolean;
   /**
+   * @remarks
+   * Specifies whether to include the full text of the article.
+   * 
    * @example
    * false
    */
   includeContent?: boolean;
   /**
+   * @remarks
+   * The page number. The default value is 1.
+   * 
    * @example
-   * 81
+   * 1
    */
   page?: number;
   /**
+   * @remarks
+   * The number of records to return on each page. The default value is 10.
+   * 
    * @example
-   * 35
+   * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The search query.
+   * 
    * @example
    * 检索Query
    */
   query?: string;
+  /**
+   * @remarks
+   * A list of search sources.
+   */
   searchSources?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/SearchNewsResponseBody.ts

@@ -4,62 +4,102 @@ import * as $dara from '@darabonba/typescript';
 
 export class SearchNewsResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The author of the article. This parameter may not be returned for some articles.
+   * 
    * @example
    * 作者
    */
   author?: string;
   /**
+   * @remarks
+   * The content of the article. This parameter is always returned.
+   * 
    * @example
    * 文章内容
    */
   content?: string;
   /**
+   * @remarks
+   * The unique ID of the internal document. This parameter is always returned.
+   * 
    * @example
    * 9a598b44c6444da5907b8ea68a5f82c4
    */
   docUuid?: string;
+  /**
+   * @remarks
+   * The URLs of the images. This parameter is deprecated and is no longer returned. Do not use it.
+   */
   imageUrls?: string[];
   /**
+   * @remarks
+   * The time when the article was published. This parameter is always returned.
+   * 
    * @example
    * 2024-01-18 06:46:22
    */
   pubTime?: string;
   /**
+   * @remarks
+   * The ID of the internal search source. This parameter is always returned.
+   * 
    * @example
    * QuarkCommonNews
    */
   searchSource?: string;
   /**
+   * @remarks
+   * The name of the internal search source. This parameter is always returned.
+   * 
    * @example
    * 夸克检索
    */
   searchSourceName?: string;
   /**
+   * @remarks
+   * The source of the article. This parameter may not be returned for some articles.
+   * 
    * @example
    * 央视网
    */
   source?: string;
   /**
+   * @remarks
+   * The summary of the article. This parameter may not be returned for some articles.
+   * 
    * @example
    * 文章摘要
    */
   summary?: string;
   /**
+   * @remarks
+   * The tag of the article. This parameter may not be returned for some articles.
+   * 
    * @example
    * 文章标签
    */
   tag?: string;
   /**
+   * @remarks
+   * The title of the article. This parameter is always returned.
+   * 
    * @example
    * 文章标题
    */
   title?: string;
   /**
+   * @remarks
+   * The time when the system was updated. This parameter is deprecated and is no longer returned. Do not use it.
+   * 
    * @example
    * 2024-01-18 06:46:22
    */
   updateTime?: string;
   /**
+   * @remarks
+   * The URL of the article. This parameter is always returned.
+   * 
    * @example
    * 文章URL
    */
@@ -114,42 +154,70 @@ export class SearchNewsResponseBodyData extends $dara.Model {
 
 export class SearchNewsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
-   * NoData
+   * successful
    */
   code?: string;
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   current?: number;
+  /**
+   * @remarks
+   * The data returned.
+   */
   data?: SearchNewsResponseBodyData[];
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
-   * success
+   * successful
    */
   message?: string;
   /**
+   * @remarks
+   * The unique ID of the request.
+   * 
    * @example
    * 1813ceee-7fe5-41b4-87e5-982a4d18cca5
    */
   requestId?: string;
   /**
+   * @remarks
+   * The number of records on each page.
+   * 
    * @example
    * 10
    */
   size?: number;
   /**
+   * @remarks
+   * Indicates whether the request was successful. A value of \\`true\\` indicates success and a value of \\`false\\` indicates failure.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * The total number of records.
+   * 
    * @example
    * 100
    */

package/src/models/SearchNewsShrinkRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class SearchNewsShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique ID of the workspace. For more information, see [AgentKey](https://help.aliyun.com/document_detail/3027170.html).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,30 +14,49 @@ export class SearchNewsShrinkRequest extends $dara.Model {
    */
   agentKey?: string;
   /**
+   * @remarks
+   * Specifies whether to filter out results with empty content.
+   * 
    * @example
    * false
    */
   filterNotNull?: boolean;
   /**
+   * @remarks
+   * Specifies whether to include the full text of the article.
+   * 
    * @example
    * false
    */
   includeContent?: boolean;
   /**
+   * @remarks
+   * The page number. The default value is 1.
+   * 
    * @example
-   * 81
+   * 1
    */
   page?: number;
   /**
+   * @remarks
+   * The number of records to return on each page. The default value is 10.
+   * 
    * @example
-   * 35
+   * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The search query.
+   * 
    * @example
    * 检索Query
    */
   query?: string;
+  /**
+   * @remarks
+   * A list of search sources.
+   */
   searchSourcesShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/SubmitAsyncTaskRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class SubmitAsyncTaskRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique ID of the workspace. For more information, see [AgentKey](https://help.aliyun.com/document_detail/2587494.html).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class SubmitAsyncTaskRequest extends $dara.Model {
   agentKey?: string;
   /**
    * @remarks
+   * For details on the task definition, see the task definition table.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,18 +24,27 @@ export class SubmitAsyncTaskRequest extends $dara.Model {
    */
   taskCode?: string;
   /**
+   * @remarks
+   * The time to run the task. By default, the task runs immediately. Format: YYYY-MM-DD HH:mm:ss
+   * 
    * @example
    * 2023-10-14 14:30:00
    */
   taskExecuteTime?: string;
   /**
+   * @remarks
+   * The name of the task.
+   * 
    * @example
    * 任务名称
    */
   taskName?: string;
   /**
+   * @remarks
+   * The task parameters.
+   * 
    * @example
-   * 任务提交参数
+   * {"fileUrl":"https://www.example.com/aaa.doc","fileName":"文件名称","shareAttr":1}
    */
   taskParam?: string;
   static names(): { [key: string]: string } {

package/src/models/SubmitAsyncTaskResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class SubmitAsyncTaskResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The unique task ID.
+   * 
    * @example
-   * 3f7045e099474ba28ceca1b4eb6d6e21
+   * xxxx
    */
   taskId?: string;
   /**
+   * @remarks
+   * The intermediate result.
+   * 
    * @example
    * {}
    */
   taskIntermediateResult?: any;
   /**
+   * @remarks
+   * The task name.
+   * 
    * @example
    * 任务名称
    */
@@ -45,27 +54,46 @@ export class SubmitAsyncTaskResponseBodyData extends $dara.Model {
 
 export class SubmitAsyncTaskResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
-   * DataNotExists
+   * successful
    */
   code?: string;
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: SubmitAsyncTaskResponseBodyData;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
-   * success
+   * successful
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 3f7045e099474ba28ceca1b4eb6d6e21
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. A value of true indicates success, and a value of false indicates failure.
+   * 
    * @example
    * true
    */

package/src/models/SubmitAuditNoteRequest.ts

@@ -5,15 +5,26 @@ import * as $dara from '@darabonba/typescript';
 export class SubmitAuditNoteRequest extends $dara.Model {
   /**
    * @remarks
+   * The FileKey of your rule library file stored in Alibaba Cloud OSS. For how to generate a FileKey, see [Common APIs: GenerateUploadConfig for File Upload and Download](https://next.api.aliyun.com/document/AiMiaoBi/2023-08-01/GenerateUploadConfig?spm=openapi-amp.newDocPublishment.0.0.18fc281fOiiBil). Your rule library file must be in DOCX, XLSX, or PDF format. If you use XLSX, it must have exactly two columns. The table header must be "Proofreading Basis" and "Source". XLSX files give the best parsing results. DOCX and PDF files are also parsed automatically.
+   * 
    * This parameter is required.
    * 
    * @example
    * oss://default/your/file/key
    */
   fileKey?: string;
+  /**
+   * @remarks
+   * ID of the rule library. If you omit this parameter, the system uses Default.
+   * 
+   * @example
+   * note_id_unique
+   */
   noteId?: string;
   /**
    * @remarks
+   * Unique identifier of your Model Studio workspace. To get this ID, see [Get the Workspace ID](https://help.aliyun.com/document_detail/2782167.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/SubmitAuditNoteResponseBody.ts

@@ -4,34 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class SubmitAuditNoteResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Status code
+   * 
    * @example
    * DataNotExists
    */
   code?: string;
   /**
+   * @remarks
+   * Task ID of this rule library submission. Use this ID in later API calls.
+   * 
    * @example
    * xxx_Default_89123748917
    */
   data?: string;
   /**
+   * @remarks
+   * HTTP status code
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * Error message
+   * 
    * @example
    * success
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * F2F366D6-E9FE-1006-BB70-2C650896AAB5
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request succeeded
+   * 
    * @example
    * true
    */

package/src/models/SubmitAuditTaskRequest.ts

@@ -4,14 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class SubmitAuditTaskRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the article to be audited.
+   * 
    * @example
    * xxxx
    */
   articleId?: string;
+  /**
+   * @remarks
+   * The content to be audited.
+   * 
+   * @example
+   * 待审核的内容
+   */
   content?: string;
+  /**
+   * @remarks
+   * The content to be audited, in HTML format.
+   * 
+   * @example
+   * 待审核的内容（HTML格式）
+   */
   htmlContent?: string;
+  /**
+   * @remarks
+   * The title of the article to be audited.
+   * 
+   * @example
+   * 审核时的文章标题
+   */
   title?: string;
   /**
+   * @remarks
+   * [Workspace ID](https://help.aliyun.com/document_detail/2782167.html)
+   * 
    * @example
    * xxxx
    */

package/src/models/SubmitAuditTaskResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class SubmitAuditTaskResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the task.
+   * 
    * @example
    * xx
    */
@@ -31,17 +34,30 @@ export class SubmitAuditTaskResponseBodyData extends $dara.Model {
 
 export class SubmitAuditTaskResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * DataNotExists
    */
   code?: string;
+  /**
+   * @remarks
+   * The response object of the task.
+   */
   data?: SubmitAuditTaskResponseBodyData;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 400
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * 错误消息
    */
@@ -55,6 +71,9 @@ export class SubmitAuditTaskResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */