fix: 修复注释标签导致的build失败问题

IdeaLeap · Sep 30, 2023 · 6a10a87 · 6a10a87
1 parent 07e9737
commit 6a10a87
Show file tree

Hide file tree

Showing 12 changed files with 26 additions and 39 deletions.
diff --git a/docs/api/llm-ops.chain.call.md b/docs/api/llm-ops.chain.call.md
@@ -22,5 +22,4 @@ call(params: chainCallSchema): Promise<import("llm-ops/utils").Result<any>>;
 
 Promise&lt;import("llm-ops/utils").[Result](./llm-ops.result.md)<!-- -->&lt;any&gt;&gt;
 
-{<!-- -->Promise<any>} 返回异步处理的链调用结果。
-
+Promise&lt;any&gt; 返回异步处理的链调用结果。
diff --git a/docs/api/llm-ops.chaincallschema.md b/docs/api/llm-ops.chaincallschema.md
@@ -6,8 +6,6 @@
 
 `Chain`<!-- -->类的`call`<!-- -->方法的参数数据结构。
 
- {<!-- -->messageType \| string<!-- -->} request - 请求消息或字符串。  {<!-- -->messageType\[\]<!-- -->} \[prompt\] - 一个可选的消息提示数组。  {<!-- -->structSchema<!-- -->} \[struct\] - 一个可选的结构模式。  {<!-- -->boolean<!-- -->} \[verbose\] - 一个可选的详细模式标志。
-
 **Signature:**
 
 ```typescript

diff --git a/docs/api/llm-ops.chainschema.md b/docs/api/llm-ops.chainschema.md
@@ -6,8 +6,6 @@
 
 `Chain` 构造函数的参数数据结构。
 
- {<!-- -->LLM<!-- -->} \[llm\] - 一个可选的LLM实例。  {<!-- -->createLLMSchema<!-- -->} \[llmSchema\] - 一个可选的LLM模式对象。  {<!-- -->string<!-- -->} \[chainName\] - 一个可选的链名称。
-
 **Signature:**
 
 ```typescript

diff --git a/docs/api/llm-ops.llm_ops_config.md b/docs/api/llm-ops.llm_ops_config.md
@@ -20,6 +20,6 @@ export declare class LLM_OPS_CONFIG
 |  [MILVUS\_ADDRESS](./llm-ops.llm_ops_config.milvus_address.md) | <code>static</code> | string \| undefined | <p>Milvus的服务地址。</p><p>从环境变量中获取此地址。</p> |
 |  [MILVUS\_PASSWORD](./llm-ops.llm_ops_config.milvus_password.md) | <code>static</code> | string \| undefined | <p>用于连接到Milvus服务的密码。</p><p>从环境变量中获取此密码。</p> |
 |  [MILVUS\_USERNAME](./llm-ops.llm_ops_config.milvus_username.md) | <code>static</code> | string \| undefined | <p>用于连接到Milvus服务的用户名。</p><p>从环境变量中获取此用户名。</p> |
-|  [OPEN\_PATH](./llm-ops.llm_ops_config.open_path.md) | <code>static</code> | { baseURL: string; defaultHeaders: { "Helicone-Auth": string; }; } | <p>OPEN\_PATH 对象定义了与Helicone API进行通信时的基础设置。</p><p> {<!-- -->string<!-- -->} baseURL - Helicone API的基础URL。  {<!-- -->Object<!-- -->} defaultHeaders - 用于与Helicone API通信时的默认请求头。</p> |
+|  [OPEN\_PATH](./llm-ops.llm_ops_config.open_path.md) | <code>static</code> | { baseURL: string; defaultHeaders: { "Helicone-Auth": string; }; } | OPEN\_PATH 对象定义了与Helicone API进行通信时的基础设置。 |
 |  [OPENAI\_API\_KEY](./llm-ops.llm_ops_config.openai_api_key.md) | <code>static</code> | string \| undefined | <p>OpenAI的API密钥。</p><p>从环境变量中获取该密钥。</p> |
 
diff --git a/docs/api/llm-ops.llm_ops_config.open_path.md b/docs/api/llm-ops.llm_ops_config.open_path.md
@@ -6,8 +6,6 @@
 
 OPEN\_PATH 对象定义了与Helicone API进行通信时的基础设置。
 
- {<!-- -->string<!-- -->} baseURL - Helicone API的基础URL。  {<!-- -->Object<!-- -->} defaultHeaders - 用于与Helicone API通信时的默认请求头。
-
 **Signature:**
 
 ```typescript

diff --git a/docs/api/llm-ops.md b/docs/api/llm-ops.md
@@ -41,8 +41,8 @@
 |  --- | --- |
 |  [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) |  |
 |  [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) |  |
-|  [chainCallSchema](./llm-ops.chaincallschema.md) | <p><code>Chain</code>类的<code>call</code>方法的参数数据结构。</p><p> {<!-- -->messageType \| string<!-- -->} request - 请求消息或字符串。  {<!-- -->messageType\[\]<!-- -->} \[prompt\] - 一个可选的消息提示数组。  {<!-- -->structSchema<!-- -->} \[struct\] - 一个可选的结构模式。  {<!-- -->boolean<!-- -->} \[verbose\] - 一个可选的详细模式标志。</p> |
-|  [chainSchema](./llm-ops.chainschema.md) | <p><code>Chain</code> 构造函数的参数数据结构。</p><p> {<!-- -->LLM<!-- -->} \[llm\] - 一个可选的LLM实例。  {<!-- -->createLLMSchema<!-- -->} \[llmSchema\] - 一个可选的LLM模式对象。  {<!-- -->string<!-- -->} \[chainName\] - 一个可选的链名称。</p> |
+|  [chainCallSchema](./llm-ops.chaincallschema.md) | <code>Chain</code>类的<code>call</code>方法的参数数据结构。 |
+|  [chainSchema](./llm-ops.chainschema.md) | <code>Chain</code> 构造函数的参数数据结构。 |
 |  [ChatSchema](./llm-ops.chatschema.md) | 聊天参数接口 |
 |  [createLLMSchema](./llm-ops.createllmschema.md) | 创建LLM的参数接口 |
 |  [createMessageSchema](./llm-ops.createmessageschema.md) |  |
@@ -59,11 +59,11 @@
 |  [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) |  |
 |  [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) |  |
 |  [milvusVectorDBUploadSchema](./llm-ops.milvusvectordbuploadschema.md) |  |
-|  [MultiPromptSchema](./llm-ops.multipromptschema.md) | <p>多重提示模板数据结构。</p><p> {<!-- -->string<!-- -->} \[COLLECTION\_NAME\] - 一个可选的集合名称，用于指定向量数据库的集合。</p> |
+|  [MultiPromptSchema](./llm-ops.multipromptschema.md) | 多重提示模板数据结构。 |
 |  [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) |  |
-|  [PromptsSchema](./llm-ops.promptsschema.md) | <p>主要的模板数据结构。</p><p> {<!-- -->string<!-- -->} name - 提示模板的名称。可能的值为："polishPromptTemplate"、"agentPromptTemplate" 或其他字符串。  {<!-- -->MultiPromptSchema\[\] \| any\[\]<!-- -->} \[prompt\] - 一个可选的提示模板数组。  {<!-- -->Record<!-- -->&lt;<!-- -->string, any<!-- -->&gt;<!-- -->} \[schema\] - 一个可选的记录对象，用于存储额外的数据模板。  {<!-- -->string<!-- -->} \[COLLECTION\_NAME\] - 一个可选的集合名称，用于指定向量数据库的集合。</p> |
+|  [PromptsSchema](./llm-ops.promptsschema.md) | 主要的模板数据结构。 |
 |  [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) |  |
-|  [structSchema](./llm-ops.structschema.md) | <p><code>call</code> 方法的<code>struct</code>参数的数据结构。</p><p> {<!-- -->functionsType<!-- -->} \[functions\] - 可选的函数类型。  {<!-- -->function\_callType<!-- -->} \[function\_call\] - 可选的函数调用类型。  {<!-- -->string<!-- -->} \[schema\] - 一个可选的模式字符串。  {<!-- -->string<!-- -->} \[typeName\] - 一个可选的类型名称。</p> |
+|  [structSchema](./llm-ops.structschema.md) | <code>call</code> 方法的<code>struct</code>参数的数据结构。 |
 |  [Success](./llm-ops.success.md) | An object representing a successful operation with a result of type <code>T</code>. |
 |  [TeacherEvaluateSchema](./llm-ops.teacherevaluateschema.md) |  |
 |  [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) | Represents an object that can validate JSON strings according to a given TypeScript schema. |

diff --git a/docs/api/llm-ops.multipromptschema.md b/docs/api/llm-ops.multipromptschema.md
@@ -6,8 +6,6 @@
 
 多重提示模板数据结构。
 
- {<!-- -->string<!-- -->} \[COLLECTION\_NAME\] - 一个可选的集合名称，用于指定向量数据库的集合。
-
 **Signature:**
 
 ```typescript

diff --git a/docs/api/llm-ops.promptsschema.md b/docs/api/llm-ops.promptsschema.md
@@ -6,8 +6,6 @@
 
 主要的模板数据结构。
 
- {<!-- -->string<!-- -->} name - 提示模板的名称。可能的值为："polishPromptTemplate"、"agentPromptTemplate" 或其他字符串。  {<!-- -->MultiPromptSchema\[\] \| any\[\]<!-- -->} \[prompt\] - 一个可选的提示模板数组。  {<!-- -->Record<!-- -->&lt;<!-- -->string, any<!-- -->&gt;<!-- -->} \[schema\] - 一个可选的记录对象，用于存储额外的数据模板。  {<!-- -->string<!-- -->} \[COLLECTION\_NAME\] - 一个可选的集合名称，用于指定向量数据库的集合。
-
 **Signature:**
 
 ```typescript

diff --git a/docs/api/llm-ops.structschema.md b/docs/api/llm-ops.structschema.md
@@ -6,8 +6,6 @@
 
 `call` 方法的`struct`<!-- -->参数的数据结构。
 
- {<!-- -->functionsType<!-- -->} \[functions\] - 可选的函数类型。  {<!-- -->function\_callType<!-- -->} \[function\_call\] - 可选的函数调用类型。  {<!-- -->string<!-- -->} \[schema\] - 一个可选的模式字符串。  {<!-- -->string<!-- -->} \[typeName\] - 一个可选的类型名称。
-
 **Signature:**
 
 ```typescript

diff --git a/package/chain/chain.ts b/package/chain/chain.ts
@@ -10,9 +10,9 @@ import { TypeScriptChain } from "llm-ops/chain/typechat";
 /**
  * `Chain` 构造函数的参数数据结构。
  *
- * @property {LLM} [llm] - 一个可选的LLM实例。
- * @property {createLLMSchema} [llmSchema] - 一个可选的LLM模式对象。
- * @property {string} [chainName] - 一个可选的链名称。
+ * @typeParam {LLM} [llm] - 一个可选的LLM实例。
+ * @typeParam {createLLMSchema} [llmSchema] - 一个可选的LLM模式对象。
+ * @typeParam {string} [chainName] - 一个可选的链名称。
  */
 export interface chainSchema {
   llm?: LLM;
@@ -22,10 +22,10 @@ export interface chainSchema {
 /**
  * `call` 方法的`struct`参数的数据结构。
  *
- * @property {functionsType} [functions] - 可选的函数类型。
- * @property {function_callType} [function_call] - 可选的函数调用类型。
- * @property {string} [schema] - 一个可选的模式字符串。
- * @property {string} [typeName] - 一个可选的类型名称。
+ * @typeParam {functionsType} [functions] - 可选的函数类型。
+ * @typeParam {function_callType} [function_call] - 可选的函数调用类型。
+ * @typeParam {string} [schema] - 一个可选的模式字符串。
+ * @typeParam {string} [typeName] - 一个可选的类型名称。
  */
 export interface structSchema {
   functions?: functionsType;
@@ -36,10 +36,10 @@ export interface structSchema {
 /**
  * `Chain`类的`call`方法的参数数据结构。
  *
- * @property {messageType | string} request - 请求消息或字符串。
- * @property {messageType[]} [prompt] - 一个可选的消息提示数组。
- * @property {structSchema} [struct] - 一个可选的结构模式。
- * @property {boolean} [verbose] - 一个可选的详细模式标志。
+ * @typeParam {messageType | string} request - 请求消息或字符串。
+ * @typeParam {messageType[]} [prompt] - 一个可选的消息提示数组。
+ * @typeParam {structSchema} [struct] - 一个可选的结构模式。
+ * @typeParam {boolean} [verbose] - 一个可选的详细模式标志。
  */
 export interface chainCallSchema {
   request: messageType | string;
@@ -87,7 +87,7 @@ export class Chain {
    *
    * @param {chainCallSchema} params - 调用方法的参数对象。
    *
-   * @returns {Promise<any>} 返回异步处理的链调用结果。
+   * @returns 返回异步处理的链调用结果。
    */
   async call(params: chainCallSchema) {
     const { request, prompt, struct, verbose } = params;

diff --git a/package/prompt/promptTemplate.ts b/package/prompt/promptTemplate.ts
@@ -12,10 +12,10 @@ import {
 /**
  * 主要的模板数据结构。
  *
- * @property {string} name - 提示模板的名称。可能的值为："polishPromptTemplate"、"agentPromptTemplate" 或其他字符串。
- * @property {MultiPromptSchema[] | any[]} [prompt] - 一个可选的提示模板数组。
- * @property {Record<string, any>} [schema] - 一个可选的记录对象，用于存储额外的数据模板。
- * @property {string} [COLLECTION_NAME] - 一个可选的集合名称，用于指定向量数据库的集合。
+ * @typeParam {string} name - 提示模板的名称。可能的值为："polishPromptTemplate"、"agentPromptTemplate" 或其他字符串。
+ * @typeParam {MultiPromptSchema[] | any[]} [prompt] - 一个可选的提示模板数组。
+ * @typeParam {Record<string, any>} [schema] - 一个可选的记录对象，用于存储额外的数据模板。
+ * @typeParam {string} [COLLECTION_NAME] - 一个可选的集合名称，用于指定向量数据库的集合。
  */
 export interface PromptsSchema
   extends Omit<milvusVectorDBSchema, "COLLECTION_NAME" | "llm"> {
@@ -27,7 +27,7 @@ export interface PromptsSchema
 /**
  * 多重提示模板数据结构。
  *
- * @property {string} [COLLECTION_NAME] - 一个可选的集合名称，用于指定向量数据库的集合。
+ * @typeParam {string} [COLLECTION_NAME] - 一个可选的集合名称，用于指定向量数据库的集合。
  */
 export interface MultiPromptSchema
   extends createMessageSchema,

diff --git a/package/utils/config.ts b/package/utils/config.ts
@@ -6,8 +6,8 @@ export class LLM_OPS_CONFIG {
   /**
    * OPEN_PATH 对象定义了与Helicone API进行通信时的基础设置。
    *
-   * @property {string} baseURL - Helicone API的基础URL。
-   * @property {Object} defaultHeaders - 用于与Helicone API通信时的默认请求头。
+   * @typeParam {string} baseURL - Helicone API的基础URL。
+   * @typeParam {Object} defaultHeaders - 用于与Helicone API通信时的默认请求头。
    */
   static OPEN_PATH = {
     baseURL: "https://oai.hconeai.com/v1",