From 6a10a87a521199bf58326086429c23069fe0e1c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=91=E8=BD=BB=E7=8B=82?= <1677568218@qq.com> Date: Sat, 30 Sep 2023 14:00:09 +0800 Subject: [PATCH] =?UTF-8?q?fix:=20=E4=BF=AE=E5=A4=8D=E6=B3=A8=E9=87=8A?= =?UTF-8?q?=E6=A0=87=E7=AD=BE=E5=AF=BC=E8=87=B4=E7=9A=84build=E5=A4=B1?= =?UTF-8?q?=E8=B4=A5=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/llm-ops.chain.call.md | 3 +-- docs/api/llm-ops.chaincallschema.md | 2 -- docs/api/llm-ops.chainschema.md | 2 -- docs/api/llm-ops.llm_ops_config.md | 2 +- docs/api/llm-ops.llm_ops_config.open_path.md | 2 -- docs/api/llm-ops.md | 10 ++++---- docs/api/llm-ops.multipromptschema.md | 2 -- docs/api/llm-ops.promptsschema.md | 2 -- docs/api/llm-ops.structschema.md | 2 -- package/chain/chain.ts | 24 ++++++++++---------- package/prompt/promptTemplate.ts | 10 ++++---- package/utils/config.ts | 4 ++-- 12 files changed, 26 insertions(+), 39 deletions(-) diff --git a/docs/api/llm-ops.chain.call.md b/docs/api/llm-ops.chain.call.md index ac218ee..921aa5b 100644 --- a/docs/api/llm-ops.chain.call.md +++ b/docs/api/llm-ops.chain.call.md @@ -22,5 +22,4 @@ call(params: chainCallSchema): Promise>; Promise<import("llm-ops/utils").[Result](./llm-ops.result.md)<any>> -{Promise} 返回异步处理的链调用结果。 - +Promise<any> 返回异步处理的链调用结果。 diff --git a/docs/api/llm-ops.chaincallschema.md b/docs/api/llm-ops.chaincallschema.md index 59bc79c..7af7f4e 100644 --- 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 index e477ce8..3e39657 100644 --- 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 index f941bc7..44086f5 100644 --- 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) | static | string \| undefined |

Milvus的服务地址。

从环境变量中获取此地址。

| | [MILVUS\_PASSWORD](./llm-ops.llm_ops_config.milvus_password.md) | static | string \| undefined |

用于连接到Milvus服务的密码。

从环境变量中获取此密码。

| | [MILVUS\_USERNAME](./llm-ops.llm_ops_config.milvus_username.md) | static | string \| undefined |

用于连接到Milvus服务的用户名。

从环境变量中获取此用户名。

| -| [OPEN\_PATH](./llm-ops.llm_ops_config.open_path.md) | static | { baseURL: string; defaultHeaders: { "Helicone-Auth": string; }; } |

OPEN\_PATH 对象定义了与Helicone API进行通信时的基础设置。

{string} baseURL - Helicone API的基础URL。 {Object} defaultHeaders - 用于与Helicone API通信时的默认请求头。

| +| [OPEN\_PATH](./llm-ops.llm_ops_config.open_path.md) | static | { baseURL: string; defaultHeaders: { "Helicone-Auth": string; }; } | OPEN\_PATH 对象定义了与Helicone API进行通信时的基础设置。 | | [OPENAI\_API\_KEY](./llm-ops.llm_ops_config.openai_api_key.md) | static | string \| undefined |

OpenAI的API密钥。

从环境变量中获取该密钥。

| diff --git a/docs/api/llm-ops.llm_ops_config.open_path.md b/docs/api/llm-ops.llm_ops_config.open_path.md index 0fbebdb..8a89562 100644 --- 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 index 8c57513..7ddf27b 100644 --- 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) |

Chain类的call方法的参数数据结构。

{messageType \| string} request - 请求消息或字符串。 {messageType\[\]} \[prompt\] - 一个可选的消息提示数组。 {structSchema} \[struct\] - 一个可选的结构模式。 {boolean} \[verbose\] - 一个可选的详细模式标志。

| -| [chainSchema](./llm-ops.chainschema.md) |

Chain 构造函数的参数数据结构。

{LLM} \[llm\] - 一个可选的LLM实例。 {createLLMSchema} \[llmSchema\] - 一个可选的LLM模式对象。 {string} \[chainName\] - 一个可选的链名称。

| +| [chainCallSchema](./llm-ops.chaincallschema.md) | Chain类的call方法的参数数据结构。 | +| [chainSchema](./llm-ops.chainschema.md) | Chain 构造函数的参数数据结构。 | | [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) |

多重提示模板数据结构。

{string} \[COLLECTION\_NAME\] - 一个可选的集合名称，用于指定向量数据库的集合。

| +| [MultiPromptSchema](./llm-ops.multipromptschema.md) | 多重提示模板数据结构。 | | [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) | | -| [PromptsSchema](./llm-ops.promptsschema.md) |

主要的模板数据结构。

{string} name - 提示模板的名称。可能的值为："polishPromptTemplate"、"agentPromptTemplate" 或其他字符串。 {MultiPromptSchema\[\] \| any\[\]} \[prompt\] - 一个可选的提示模板数组。 {Record<string, any>} \[schema\] - 一个可选的记录对象，用于存储额外的数据模板。 {string} \[COLLECTION\_NAME\] - 一个可选的集合名称，用于指定向量数据库的集合。

| +| [PromptsSchema](./llm-ops.promptsschema.md) | 主要的模板数据结构。 | | [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) | | -| [structSchema](./llm-ops.structschema.md) |

call 方法的struct参数的数据结构。

{functionsType} \[functions\] - 可选的函数类型。 {function\_callType} \[function\_call\] - 可选的函数调用类型。 {string} \[schema\] - 一个可选的模式字符串。 {string} \[typeName\] - 一个可选的类型名称。

| +| [structSchema](./llm-ops.structschema.md) | call 方法的struct参数的数据结构。 | | [Success](./llm-ops.success.md) | An object representing a successful operation with a result of type T. | | [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 index 204cf6d..9ae1cff 100644 --- 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 index 2948d94..89dd799 100644 --- 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<string, any>} \[schema\] - 一个可选的记录对象，用于存储额外的数据模板。 {string} \[COLLECTION\_NAME\] - 一个可选的集合名称，用于指定向量数据库的集合。 - **Signature:** ```typescript diff --git a/docs/api/llm-ops.structschema.md b/docs/api/llm-ops.structschema.md index 9732ace..ed63261 100644 --- 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 index a783e14..e7588af 100644 --- 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} 返回异步处理的链调用结果。 + * @returns 返回异步处理的链调用结果。 */ async call(params: chainCallSchema) { const { request, prompt, struct, verbose } = params; diff --git a/package/prompt/promptTemplate.ts b/package/prompt/promptTemplate.ts index bb1e3d7..491ccf5 100644 --- 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} [schema] - 一个可选的记录对象，用于存储额外的数据模板。 - * @property {string} [COLLECTION_NAME] - 一个可选的集合名称，用于指定向量数据库的集合。 + * @typeParam {string} name - 提示模板的名称。可能的值为："polishPromptTemplate"、"agentPromptTemplate" 或其他字符串。 + * @typeParam {MultiPromptSchema[] | any[]} [prompt] - 一个可选的提示模板数组。 + * @typeParam {Record} [schema] - 一个可选的记录对象，用于存储额外的数据模板。 + * @typeParam {string} [COLLECTION_NAME] - 一个可选的集合名称，用于指定向量数据库的集合。 */ export interface PromptsSchema extends Omit { @@ -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 index 5186d37..4aebb93 100644 --- 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",