@alicloud/aimiaobi20230801 1.45.0 → 1.45.2

package/dist/models/RunQuickWritingShrinkRequest.d.ts

@@ -1,19 +1,40 @@
 import * as $dara from '@darabonba/typescript';
 export declare class RunQuickWritingShrinkRequest extends $dara.Model {
+    /**
+     * @remarks
+     * Referenced articles
+     *
+     * @example
+     * 集合
+     */
     articlesShrink?: string;
     /**
      * @remarks
+     * Other writing parameters. Choose either prompt or writingParams.
+     *
      * This parameter is required.
+     *
+     * @example
+     * 请按英文输出
      */
     prompt?: string;
+    /**
+     * @remarks
+     * Use the specified search source list.
+     */
     searchSourcesShrink?: string;
     /**
+     * @remarks
+     * Task ID. Reuse the same task ID for multi-turn conversations.
+     *
      * @example
      * 3f7045e099474ba28ceca1b4eb6d6e21
      */
     taskId?: string;
     /**
      * @remarks
+     * [Workspace ID](https://help.aliyun.com/document_detail/2782167.html)
+     *
      * This parameter is required.
      *
      * @example

package/dist/models/RunQuickWritingShrinkRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"RunQuickWritingShrinkRequest.js","sourceRoot":"","sources":["../../src/models/RunQuickWritingShrinkRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,4BAA6B,SAAQ,KAAK,CAAC,KAAK;IAqB3D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,cAAc,EAAE,UAAU;YAC1B,MAAM,EAAE,QAAQ;YAChB,mBAAmB,EAAE,eAAe;YACpC,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,aAAa;SAC3B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,cAAc,EAAE,QAAQ;YACxB,MAAM,EAAE,QAAQ;YAChB,mBAAmB,EAAE,QAAQ;YAC7B,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,QAAQ;SACtB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAhDD,oEAgDC"}
+{"version":3,"file":"RunQuickWritingShrinkRequest.js","sourceRoot":"","sources":["../../src/models/RunQuickWritingShrinkRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,4BAA6B,SAAQ,KAAK,CAAC,KAAK;IA0C3D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,cAAc,EAAE,UAAU;YAC1B,MAAM,EAAE,QAAQ;YAChB,mBAAmB,EAAE,eAAe;YACpC,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,aAAa;SAC3B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,cAAc,EAAE,QAAQ;YACxB,MAAM,EAAE,QAAQ;YAChB,mBAAmB,EAAE,QAAQ;YAC7B,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,QAAQ;SACtB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AArED,oEAqEC"}

package/dist/models/RunSearchGenerationRequest.d.ts

@@ -1,62 +1,102 @@
 import * as $dara from '@darabonba/typescript';
 export declare class RunSearchGenerationRequestAgentContextBizContextMultimodalMediaSelectionTextSearchResultSearchResult extends $dara.Model {
+    /**
+     * @remarks
+     * Relevant chunks.
+     */
     chunks?: string[];
     /**
+     * @remarks
+     * Content.
+     *
      * @example
      * 文章内容
      */
     content?: string;
     /**
+     * @remarks
+     * Custom unique document ID.
+     *
      * @example
      * 文档-自定义的唯一ID
      */
     docId?: string;
     /**
+     * @remarks
+     * Internal unique document identifier.
+     *
      * @example
      * xxx
      */
     docUuid?: string;
     /**
+     * @remarks
+     * Publication time.
+     *
      * @example
      * 2024-11-25 14:25:59
      */
     pubTime?: string;
     /**
+     * @remarks
+     * Relevance score.
+     *
      * @example
      * 1
      */
     score?: number;
     /**
+     * @remarks
+     * Unique identifier for the search source. Same as searchSource.datasetName.
+     *
      * @example
      * QuarkCommonNews
      */
     searchSource?: string;
     /**
+     * @remarks
+     * Name of the search source.
+     *
      * @example
      * 互联网搜索
      */
     searchSourceName?: string;
     /**
+     * @remarks
+     * Search source type. Same as searchSource.code.
+     *
      * @example
      * SystemSearch
      */
     searchSourceType?: string;
     /**
+     * @remarks
+     * Source.
+     *
      * @example
      * 新华社
      */
     source?: string;
     /**
+     * @remarks
+     * Article summary.
+     *
      * @example
      * 文章摘要
      */
     summary?: string;
     /**
+     * @remarks
+     * Title.
+     *
      * @example
      * 文章标题
      */
     title?: string;
     /**
+     * @remarks
+     * Article URL.
+     *
      * @example
      * https://www.example.com/aaa.docx
      */
@@ -73,6 +113,10 @@ export declare class RunSearchGenerationRequestAgentContextBizContextMultimodalM
     });
 }
 export declare class RunSearchGenerationRequestAgentContextBizContextMultimodalMediaSelectionTextSearchResult extends $dara.Model {
+    /**
+     * @remarks
+     * List of text search results.
+     */
     searchResult?: RunSearchGenerationRequestAgentContextBizContextMultimodalMediaSelectionTextSearchResultSearchResult[];
     static names(): {
         [key: string]: string;
@@ -87,30 +131,49 @@ export declare class RunSearchGenerationRequestAgentContextBizContextMultimodalM
 }
 export declare class RunSearchGenerationRequestAgentContextBizContextMultimodalMediaSelection extends $dara.Model {
     /**
+     * @remarks
+     * Unique identifier for the original session. Used to retrieve full results from that session. Required only for media asset search.
+     *
      * @example
      * 原始会话唯一标识：搜索结果取这个会话中的全量，目前仅媒资搜索场景需要
      */
     originalSessionId?: string;
     /**
+     * @remarks
+     * Used only for clustering. Pass ClusterGenerate when performing secondary clustering on cluster subtopics.
+     *
      * @example
      * TextGenerate
      */
     searchModel?: string;
     /**
+     * @remarks
+     * When SearchModel = ClusterGenerate, enter the topic name for the subtopic. Include quotation marks if the original value has them.
+     *
      * @example
      * 分类1
      */
     searchModelDataValue?: string;
     /**
+     * @remarks
+     * The type of referenced data source. Valid values: ‒ all: Retrieves the full data from historical sessions. This value is supported only in clustering scenarios. ‒ selected: Retrieves data from textSearchResult during generation.
+     *
      * @example
      * all
      */
     selectionType?: string;
     /**
+     * @remarks
+     * Unique identifier for the session used as reference during generation. Used for clustering in media asset search.
+     *
      * @example
      * 3f7045e099474ba28ceca1b4eb6d6e21
      */
     sessionId?: string;
+    /**
+     * @remarks
+     * Text search results.
+     */
     textSearchResult?: RunSearchGenerationRequestAgentContextBizContextMultimodalMediaSelectionTextSearchResult;
     static names(): {
         [key: string]: string;
@@ -124,15 +187,76 @@ export declare class RunSearchGenerationRequestAgentContextBizContextMultimodalM
     });
 }
 export declare class RunSearchGenerationRequestAgentContextBizContext extends $dara.Model {
+    /**
+     * @remarks
+     * Follow-up question.
+     *
+     * @example
+     * 您想了解关于xx的哪些信息？
+     */
     askUser?: string;
+    /**
+     * @remarks
+     * List of recommended keywords for follow-up questions.
+     */
     askUserKeywords?: string[];
+    /**
+     * @remarks
+     * Current step.
+     *
+     * @example
+     * think
+     */
     currentStep?: string;
+    /**
+     * @remarks
+     * User-provided or selected multimodal data.
+     */
     multimodalMediaSelection?: RunSearchGenerationRequestAgentContextBizContextMultimodalMediaSelection;
+    /**
+     * @remarks
+     * Next step.
+     *
+     * @example
+     * generate
+     */
     nextStep?: string;
+    /**
+     * @remarks
+     * Skip follow-up questions.
+     *
+     * @example
+     * false
+     */
     skipCurrentSupplement?: boolean;
+    /**
+     * @remarks
+     * Data type needed for reasoning: searchQuery.
+     *
+     * @example
+     * searchQuery
+     */
     supplementDataType?: string;
+    /**
+     * @remarks
+     * Specifies whether supplementation is required.
+     *
+     * @example
+     * true
+     */
     supplementEnable?: boolean;
+    /**
+     * @remarks
+     * User feedback to follow-up questions.
+     *
+     * @example
+     * 地点
+     */
     userBack?: string;
+    /**
+     * @remarks
+     * List of keywords from user feedback to follow-up questions.
+     */
     userBackKeywords?: string[];
     static names(): {
         [key: string]: string;
@@ -146,6 +270,10 @@ export declare class RunSearchGenerationRequestAgentContextBizContext extends $d
     });
 }
 export declare class RunSearchGenerationRequestAgentContext extends $dara.Model {
+    /**
+     * @remarks
+     * Business context.
+     */
     bizContext?: RunSearchGenerationRequestAgentContextBizContext;
     static names(): {
         [key: string]: string;
@@ -160,11 +288,23 @@ export declare class RunSearchGenerationRequestAgentContext extends $dara.Model
 }
 export declare class RunSearchGenerationRequestChatConfigSearchParamSearchSources extends $dara.Model {
     /**
+     * @remarks
+     * Search source type:
+     *
+     * - SystemSearch: Built-in system search
+     *
+     * - CustomSemanticSearch: Custom semantic index search
+     *
+     * - ThirdSearch: Third-party API search
+     *
      * @example
      * SystemSearch
      */
     code?: string;
     /**
+     * @remarks
+     * Unique identifier for the search source: matches the dataset name shown in the console, such as 4cb0eda3fad841758262dbe8d61191.
+     *
      * @example
      * QuarkCommonNews
      */
@@ -181,46 +321,123 @@ export declare class RunSearchGenerationRequestChatConfigSearchParamSearchSource
     });
 }
 export declare class RunSearchGenerationRequestChatConfigSearchParam extends $dara.Model {
+    /**
+     * @remarks
+     * Unique category identifier.
+     */
     categoryUuids?: string[];
+    /**
+     * @remarks
+     * End creation time, in UNIX timestamp format.
+     *
+     * @example
+     * 111111111111
+     */
     createTimeEnd?: number;
+    /**
+     * @remarks
+     * Start creation time, in UNIX timestamp format.
+     *
+     * @example
+     * 111111111111
+     */
     createTimeStart?: number;
+    /**
+     * @remarks
+     * Array of document IDs.
+     */
     docIds?: string[];
+    /**
+     * @remarks
+     * Unique document identifier.
+     */
     docUuids?: string[];
     /**
+     * @remarks
+     * End time.
+     *
      * @example
      * 1725983999999
      */
     endTime?: number;
+    /**
+     * @remarks
+     * Extension field 1.
+     *
+     * @example
+     * xxx
+     */
     extend1?: string;
+    /**
+     * @remarks
+     * Extension field 2.
+     *
+     * @example
+     * xxx
+     */
     extend2?: string;
+    /**
+     * @remarks
+     * Extension field 3.
+     *
+     * @example
+     * xxx
+     */
     extend3?: string;
+    /**
+     * @remarks
+     * Search scope list.
+     */
     multimodalSearchTypes?: string[];
     /**
+     * @remarks
+     * Voice search threshold: Applies only to custom data sources (range: 0 to 1).
+     *
      * @example
-     * 0.6
+     * 0.66
      */
     searchAudioMinScore?: number;
     /**
+     * @remarks
+     * Image search threshold: Applies only to custom data sources (range: 0 to 1).
+     *
      * @example
-     * 0.6
+     * 0.66
      */
     searchImageMinScore?: number;
+    /**
+     * @remarks
+     * List of search sources.
+     */
     searchSources?: RunSearchGenerationRequestChatConfigSearchParamSearchSources[];
     /**
+     * @remarks
+     * Text search threshold: Applies only to custom data sources (range: 0 to 1).
+     *
      * @example
-     * 0.6
+     * 0.66
      */
     searchTextMinScore?: number;
     /**
+     * @remarks
+     * Video search threshold: Applies only to custom data sources (range: 0 to 1).
+     *
      * @example
-     * 0.6
+     * 0.66
      */
     searchVideoMinScore?: number;
     /**
+     * @remarks
+     * Start time.
+     *
      * @example
      * 1725983999999
      */
     startTime?: number;
+    /**
+     * @remarks
+     * Tags.
+     */
     tags?: string[];
     static names(): {
         [key: string]: string;
@@ -234,29 +451,150 @@ export declare class RunSearchGenerationRequestChatConfigSearchParam extends $da
     });
 }
 export declare class RunSearchGenerationRequestChatConfig extends $dara.Model {
+    /**
+     * @remarks
+     * Enable deep thinking.
+     *
+     * @example
+     * false
+     */
     enableThinking?: boolean;
+    /**
+     * @remarks
+     * List of generation options to skip.
+     */
     excludeGenerateOptions?: string[];
     /**
+     * @remarks
+     * Detailedness of the response:
+     *
+     * - concise: Concise (default)
+     *
+     * - enhance: Enhanced
+     *
+     * - free: Free-form
+     *
+     * - deepResearch: Research-level
+     *
      * @example
      * concise
      */
     generateLevel?: string;
     /**
+     * @remarks
+     * Generation technology:
+     *
+     * - copilotReference: Q\\&A-style search
+     *
+     * - copilotPrecise: Pure search
+     *
      * @example
-     * copilotPrecise
+     * copilotReference
      */
     generateTechnology?: string;
     /**
+     * @remarks
+     * Plain-text prompt template for Q\\&A-style search and summary generation. Must include variables {query} and {content}. Example:
+     *
+     * ```text
+     * # Role
+     * You are an expert article retrieval and Q&A assistant.
+     *
+     * # Goal
+     * Answer or explain the user\\"s question "{query}" using the retrieved articles.
+     *
+     * # Constraints
+     * - Filter by knowledge date if the question mentions a specific date.
+     * - Structure responses clearly.
+     * - Keep responses concise.
+     * - Do not use external data or fabricate answers.
+     * - If unable to answer, respond in the appropriate language:
+     *   - Chinese: "Unable to answer based on known information."
+     *   - English: "Unable to answer based on the known information."
+     *
+     * # Input
+     * ## Retrieved articles
+     * {content}
+     * ```
+     *
      * @example
-     * # 角色 你是一个专业的文章检索和问答机器人，擅长文章检索和回答用户问题。  # 任务目标 请你根据检索到的相关文章，回答或表述用户问题“{query}”。  # 任务限制 - 如果用户问题中提到具体日期，请考虑知识日期做筛选。 - 生成内容结构条理。 - 生成内容尽量精简。 - 控制在30字以内 - 不要使用其他数据，不要杜撰。 - 如果不能回答用户问题，请输出对应语言的拒识文案:   - 中文：\\"根据已知信息无法回答。\\"   - 英文：\\"Unable to answer based on the known information.\\"  # 输入数据 ## 检索到的相关文章 {content}
+     * # 角色
+     * 你是一个专业的文章检索和问答专家，擅长文章检索和回答用户问题。
+     *
+     * # 任务目标
+     * 请你根据检索到的相关文章，回答或表述用户问题“{query}”。
+     *
+     * # 任务限制
+     * - 如果用户问题中提到具体日期，请考虑知识日期做筛选。
+     * - 生成内容结构条理。
+     * - 生成内容尽量精简。
+     * - 不要使用其他数据，不要杜撰。
+     * - 如果不能回答用户问题，请输出对应语言的拒识文案:
+     *   - 中文："根据已知信息无法回答。"
+     *   - 英文："Unable to answer based on the known information."
+     *
+     * # 输入数据
+     * ## 检索到的相关文章
+     * {content}
      */
     modelCustomPromptTemplate?: string;
     /**
+     * @remarks
+     * Plain-text prompt template for Q\\&A-style search and summary generation. Must include variables {query} and {content}. Example:
+     *
+     * ```text
+     * # Role
+     * You are an expert article retrieval and Q&A assistant.
+     *
+     * # Goal
+     * Answer or explain the user\\"s question "{query}" using the retrieved articles and images.
+     *
+     * # Constraints
+     * - Filter by knowledge date if the question mentions a specific date.
+     * - Structure responses clearly.
+     * - Keep responses concise.
+     * - Ignore article content if image content fully answers the question.
+     * - Do not use external data or fabricate answers.
+     * - If unable to answer, respond in the appropriate language:
+     *     - Chinese: "Unable to answer based on known information."
+     *     - English: "Unable to answer based on the known information."
+     *
+     * # Input
+     * ## Retrieved articles
+     * {content}
+     * ```
+     *
      * @example
-     * # 角色 你是一个专业的文章检索和问答机器人，擅长文章检索和回答用户问题。   # 任务目标 请你根据检索到的相关文章和图片，回答或表述用户问题“{query}”。  # 任务限制  - 如果用户问题中提到具体日期，请考虑知识日期做筛选。  - 生成内容结构条理。  - 生成内容尽量精简。  - 控制在30字以内。 - 如果图片内容可以回答，可以忽略文章内容。 - 不要使用其他数据，不要杜撰。  - 如果不能回答用户问题，请输出对应语言的拒识文案:    	- 中文：\\"根据已知信息无法回答。\\"    	- 英文：\\"Unable to answer based on the known information.\\"    # 输入数据  ## 检索到的相关文章  {content}
+     * # 角色
+     * 你是一个专业的文章检索和问答专家，擅长文章检索和回答用户问题。
+     *
+     * # 任务目标
+     * 请你根据检索到的相关文章和图片，回答或表述用户问题“{query}”。
+     *
+     * # 任务限制
+     * - 如果用户问题中提到具体日期，请考虑知识日期做筛选。
+     * - 生成内容结构条理。
+     * - 生成内容尽量精简。
+     * - 如果图片内容可以回答，可以忽略文章内容。
+     * - 不要使用其他数据，不要杜撰。
+     * - 如果不能回答用户问题，请输出对应语言的拒识文案:
+     *     - 中文："根据已知信息无法回答。"
+     *     - 英文："Unable to answer based on the known information."
+     *
+     * # 输入数据
+     * ## 检索到的相关文章
+     * {content}
      */
     modelCustomVlPromptTemplate?: string;
+    /**
+     * @remarks
+     * List of search types.
+     */
     searchModels?: string[];
+    /**
+     * @remarks
+     * Search parameters.
+     */
     searchParam?: RunSearchGenerationRequestChatConfigSearchParam;
     static names(): {
         [key: string]: string;
@@ -270,39 +608,69 @@ export declare class RunSearchGenerationRequestChatConfig extends $dara.Model {
     });
 }
 export declare class RunSearchGenerationRequest extends $dara.Model {
+    /**
+     * @remarks
+     * Context.
+     */
     agentContext?: RunSearchGenerationRequestAgentContext;
     /**
+     * @remarks
+     * Session configuration.
+     *
      * @example
      * xxx
      */
     chatConfig?: RunSearchGenerationRequestChatConfig;
     /**
+     * @remarks
+     * Image URL. Used for image search and hybrid text-and-image (prompt) search generation.
+     *
      * @example
      * http://xxxx
      */
     fileUrl?: string;
     /**
+     * @remarks
+     * Model ID:
+     *
+     * - quanmiao-max: Quanmiao-Max
+     *
+     * - quanmiao-plus: Quanmiao-Plus
+     *
      * @example
-     * qwen-max-latest
+     * quanmiao-max
      */
     modelId?: string;
     /**
+     * @remarks
+     * Original session identifier. Usually empty. When non-empty, it indicates that the current conversation is based on the referenced session. The system loads parameters and search results from that session and replaces the generated result. Use this for re-generation, changing data sources, or adding new agents.
+     *
      * @example
      * xxx
      */
     originalSessionId?: string;
     /**
+     * @remarks
+     * Search query.
+     *
      * @example
-     * xxx
+     * 杭州亚运会吉祥物是什么
      */
     prompt?: string;
     /**
+     * @remarks
+     * Unique identifier for the session task.
+     *
+     * > By default, you do not need to provide a TaskId. The system generates one automatically. If you specify the same TaskId in subsequent requests, those tasks are grouped into the same conversation.
+     *
      * @example
      * 7AA2AE16-D873-5C5F-9708-15396C382EB1
      */
     taskId?: string;
     /**
      * @remarks
+     * ID of the Alibaba Cloud Model Studio workspace. To learn how to obtain this ID, see [How to use workspaces](https://help.aliyun.com/document_detail/2782167.html).
+     *
      * This parameter is required.
      *
      * @example