llm-exe 2.1.8 → 2.2.1

package/dist/index.d.mts

@@ -65,20 +65,6 @@ type OpenAIChatModelName = "gpt-3.5-turbo" | "gpt-3.5-turbo-0613" | "gpt-3.5-tur
 type OpenAIConversationModelName = "davinci" | "text-curie-001" | "text-babbage-001" | "text-ada-001";
 type OpenAIEmbeddingModelName = "text-embedding-ada-002";
 type OpenAIModelName = OpenAIChatModelName | OpenAIConversationModelName | OpenAIEmbeddingModelName;
-interface LlmExecutorExecuteOptions {
-    functions?: CallableExecutorCore[];
-    functionCall?: any;
-    jsonSchema?: Record<string, any>;
-}
-type GenericFunctionCall = "auto" | "none" | "any" | {
-    name: string;
-};
-interface OpenAiLlmExecutorOptions<T extends GenericFunctionCall = "auto"> extends LlmExecutorExecuteOptions {
-    functions?: CallableExecutorCore[];
-    functionCall?: T;
-    functionCallStrictInput?: boolean;
-    jsonSchema?: Record<string, any>;
-}
 
 /**
  * BaseParser is an abstract class for parsing text and enforcing JSON schema on the parsed data.
@@ -113,21 +99,6 @@ declare abstract class BaseParserWithJson<S extends JSONSchema | undefined = und
     constructor(name: string, options: BaseParserOptionsWithSchema<S>);
 }
 
-interface OpenAiFunctionParserOptions<T extends BaseParser<any>> extends BaseParserOptions {
-    parser: T;
-}
-declare class OpenAiFunctionParser<T extends BaseParser<any>> extends BaseParser<ParserOutput<T> | {
-    name: any;
-    arguments: any;
-}> {
-    parser: T;
-    constructor(options: OpenAiFunctionParserOptions<T>);
-    parse(text: OutputResultContent[], _options?: Record<string, any>): ParserOutput<T> | {
-        name: string;
-        arguments: any;
-    };
-}
-
 interface StringParserOptions extends BaseParserOptions {
 }
 declare class StringParser extends BaseParser<string> {
@@ -330,6 +301,25 @@ declare function createParser<T extends Extract<CreateParserType, "json">, S ext
 declare function createParser<T extends CreateParserType, S extends JSONSchema | undefined = undefined>(type: T, options?: BaseParserOptionsWithSchema<S> | BaseParserOptions): JsonParser<S> | ListToJsonParser<S> | StringParser | NumberParser | BooleanParser | ListToArrayParser | ListToKeyValueParser | ReplaceStringTemplateParser | MarkdownCodeBlockParser | MarkdownCodeBlocksParser | StringExtractParser;
 declare function createCustomParser<O>(name: string, parserFn: (text: string, inputValues: ExecutorContext<any, any>) => O): CustomParser<ReturnType<typeof parserFn>>;
 
+interface LlmNativeFunctionParserOptions<T extends BaseParser<any>> extends BaseParserOptions {
+    parser: T;
+}
+declare class LlmNativeFunctionParser<T extends BaseParser<any>> extends BaseParser<ParserOutput<T> | {
+    name: any;
+    arguments: any;
+}> {
+    parser: T;
+    constructor(options: LlmNativeFunctionParserOptions<T>);
+    parse(text: OutputResultContent[], _options?: Record<string, any>): ParserOutput<T> | {
+        name: string;
+        arguments: any;
+    };
+}
+/**
+ * @deprecated Use `LlmExecutorWithFunctions` instead.
+ */
+declare const OpenAiFunctionParser: typeof LlmNativeFunctionParser;
+
 declare function replaceTemplateString(templateString?: string, substitutions?: Record<string, any>, configuration?: PromptTemplateOptions): string;
 
 declare function replaceTemplateStringAsync(templateString?: string, substitutions?: Record<string, any>, configuration?: PromptTemplateOptions): Promise<string>;
@@ -740,9 +730,14 @@ declare class LlmExecutor<Llm extends BaseLlm<any>, Prompt extends BasePrompt<Re
 /**
  * Core Executor With LLM
  */
-declare class LlmExecutorOpenAiFunctions<Llm extends BaseLlm, Prompt extends BasePrompt<Record<string, any>>, Parser extends BaseParser, State extends BaseState> extends LlmExecutor<Llm, Prompt, Parser, State> {
+declare class LlmExecutorWithFunctions<Llm extends BaseLlm, Prompt extends BasePrompt<Record<string, any>>, Parser extends BaseParser, State extends BaseState> extends LlmExecutor<Llm, Prompt, Parser, State> {
     constructor(llmConfiguration: ExecutorWithLlmOptions<Llm, Prompt, Parser, State>, options?: CoreExecutorExecuteOptions<LlmExecutorHooks>);
-    execute<T extends GenericFunctionCall>(_input: PromptInput<Prompt>, _options: OpenAiLlmExecutorOptions<T>): Promise<ParserOutput<Parser>>;
+    execute<T extends GenericFunctionCall>(_input: PromptInput<Prompt>, _options: LlmExecutorWithFunctionsOptions<T>): Promise<ParserOutput<Parser>>;
+}
+/**
+ * @deprecated Use `LlmExecutorWithFunctions` instead.
+ */
+declare class LlmExecutorOpenAiFunctions<Llm extends BaseLlm, Prompt extends BasePrompt<Record<string, any>>, Parser extends BaseParser, State extends BaseState> extends LlmExecutorWithFunctions<Llm, Prompt, Parser, State> {
 }
 
 /**
@@ -763,6 +758,7 @@ declare function createCoreExecutor<I extends PlainObject, O>(handler: (input: I
  * @returns  - A new LlmExecutor instance.
  */
 declare function createLlmExecutor<Llm extends BaseLlm<any>, Prompt extends BasePrompt<any>, Parser extends BaseParser, State extends BaseState>(llmConfiguration: ExecutorWithLlmOptions<Llm, Prompt, Parser, State>, options?: CoreExecutorExecuteOptions<LlmExecutorHooks>): LlmExecutor<Llm, Prompt, Parser, State>;
+declare function createLlmFunctionExecutor<Llm extends BaseLlm, Prompt extends BasePrompt<Record<string, any>>, Parser extends BaseParser, State extends BaseState>(llmConfiguration: ExecutorWithLlmOptions<Llm, Prompt, Parser, State>, options?: CoreExecutorExecuteOptions<LlmExecutorHooks>): LlmExecutorWithFunctions<Llm, Prompt, Parser, State>;
 
 declare const hookOnComplete = "onComplete";
 declare const hookOnError = "onError";
@@ -829,6 +825,20 @@ interface CallableExecutorCore {
     description: string;
     parameters?: Record<string, any>;
 }
+interface LlmExecutorExecuteOptions {
+    functions?: CallableExecutorCore[];
+    functionCall?: any;
+    jsonSchema?: Record<string, any>;
+}
+type GenericFunctionCall = "auto" | "none" | "any" | {
+    name: string;
+};
+interface LlmExecutorWithFunctionsOptions<T extends GenericFunctionCall = "auto"> extends LlmExecutorExecuteOptions {
+    functions?: CallableExecutorCore[];
+    functionCall?: T;
+    functionCallStrictInput?: boolean;
+    jsonSchema?: Record<string, any>;
+}
 
 type CreateParserType = "json" | "string" | "boolean" | "number" | "stringExtract" | "listToArray" | "listToJson" | "listToKeyValue" | "replaceStringTemplate" | "markdownCodeBlocks" | "markdownCodeBlock";
 interface BaseParserOptions {
@@ -1038,6 +1048,7 @@ type AllUseLlmOptions = AllLlm & {
 };
 type LlmProviderKey = keyof AllLlm;
 type EmbeddingProviderKey = keyof AllEmbedding;
+type UseLlmKey = keyof AllUseLlmOptions;
 interface BaseLlCall {
     getResultContent: () => OutputResultContent[];
     getResultText: () => string;
@@ -1259,8 +1270,8 @@ declare const configs: {
 };
 
 declare function useLlm<T extends keyof typeof configs>(provider: T, options?: AllUseLlmOptions[T]["input"]): {
-    call: (messages: string | IChatMessages, options?: OpenAiLlmExecutorOptions<"auto"> | undefined) => Promise<{
-        getResultContent: (index?: number | undefined) => OutputResultContent[];
+    call: (messages: string | IChatMessages, options?: LlmExecutorWithFunctionsOptions) => Promise<{
+        getResultContent: (index?: number) => OutputResultContent[];
         getResultText: () => string;
         getResult: () => OutputResult;
     }>;
@@ -1279,8 +1290,8 @@ declare function useLlm<T extends keyof typeof configs>(provider: T, options?: A
 };
 
 declare function createEmbedding<T extends EmbeddingProviderKey>(provider: T, options: AllEmbedding[T]["input"]): {
-    call: (messages: string | string[], options?: OpenAiLlmExecutorOptions<"auto"> | undefined) => Promise<{
-        getEmbedding: (index?: number | undefined) => number[];
+    call: (messages: string | string[], options?: LlmExecutorWithFunctionsOptions) => Promise<{
+        getEmbedding: (index?: number) => number[];
         getResult: () => EmbeddingOutputResult;
     }>;
     getTraceId: () => string | null;
@@ -1297,4 +1308,4 @@ declare function createEmbedding<T extends EmbeddingProviderKey>(provider: T, op
     };
 };
 
-export { BaseExecutor, type BaseLlm, BaseParser, BasePrompt, BaseStateItem, ChatPrompt, CustomParser, DefaultState, DefaultStateItem, type ExecutorContext, type IChatMessages, LlmExecutorOpenAiFunctions, type LlmProvider, type OpenAIModelName, OpenAiFunctionParser, TextPrompt, createCallableExecutor, createChatPrompt, createCoreExecutor, createCustomParser, createDialogue, createEmbedding, createLlmExecutor, createParser, createPrompt, createState, createStateItem, useExecutors, useLlm, index as utils };
+export { BaseExecutor, type BaseLlm, BaseParser, BasePrompt, BaseStateItem, ChatPrompt, CustomParser, DefaultState, DefaultStateItem, type EmbeddingProviderKey, type ExecutorContext, type IChatMessages, LlmExecutorOpenAiFunctions, LlmExecutorWithFunctions, LlmNativeFunctionParser, type LlmProvider, type LlmProviderKey, type OpenAIModelName, OpenAiFunctionParser, TextPrompt, type UseLlmKey, createCallableExecutor, createChatPrompt, createCoreExecutor, createCustomParser, createDialogue, createEmbedding, createLlmExecutor, createLlmFunctionExecutor, createParser, createPrompt, createState, createStateItem, defineSchema, registerHelpers, registerPartials, useExecutors, useLlm, index as utils };

package/dist/index.d.ts

@@ -65,20 +65,6 @@ type OpenAIChatModelName = "gpt-3.5-turbo" | "gpt-3.5-turbo-0613" | "gpt-3.5-tur
 type OpenAIConversationModelName = "davinci" | "text-curie-001" | "text-babbage-001" | "text-ada-001";
 type OpenAIEmbeddingModelName = "text-embedding-ada-002";
 type OpenAIModelName = OpenAIChatModelName | OpenAIConversationModelName | OpenAIEmbeddingModelName;
-interface LlmExecutorExecuteOptions {
-    functions?: CallableExecutorCore[];
-    functionCall?: any;
-    jsonSchema?: Record<string, any>;
-}
-type GenericFunctionCall = "auto" | "none" | "any" | {
-    name: string;
-};
-interface OpenAiLlmExecutorOptions<T extends GenericFunctionCall = "auto"> extends LlmExecutorExecuteOptions {
-    functions?: CallableExecutorCore[];
-    functionCall?: T;
-    functionCallStrictInput?: boolean;
-    jsonSchema?: Record<string, any>;
-}
 
 /**
  * BaseParser is an abstract class for parsing text and enforcing JSON schema on the parsed data.
@@ -113,21 +99,6 @@ declare abstract class BaseParserWithJson<S extends JSONSchema | undefined = und
     constructor(name: string, options: BaseParserOptionsWithSchema<S>);
 }
 
-interface OpenAiFunctionParserOptions<T extends BaseParser<any>> extends BaseParserOptions {
-    parser: T;
-}
-declare class OpenAiFunctionParser<T extends BaseParser<any>> extends BaseParser<ParserOutput<T> | {
-    name: any;
-    arguments: any;
-}> {
-    parser: T;
-    constructor(options: OpenAiFunctionParserOptions<T>);
-    parse(text: OutputResultContent[], _options?: Record<string, any>): ParserOutput<T> | {
-        name: string;
-        arguments: any;
-    };
-}
-
 interface StringParserOptions extends BaseParserOptions {
 }
 declare class StringParser extends BaseParser<string> {
@@ -330,6 +301,25 @@ declare function createParser<T extends Extract<CreateParserType, "json">, S ext
 declare function createParser<T extends CreateParserType, S extends JSONSchema | undefined = undefined>(type: T, options?: BaseParserOptionsWithSchema<S> | BaseParserOptions): JsonParser<S> | ListToJsonParser<S> | StringParser | NumberParser | BooleanParser | ListToArrayParser | ListToKeyValueParser | ReplaceStringTemplateParser | MarkdownCodeBlockParser | MarkdownCodeBlocksParser | StringExtractParser;
 declare function createCustomParser<O>(name: string, parserFn: (text: string, inputValues: ExecutorContext<any, any>) => O): CustomParser<ReturnType<typeof parserFn>>;
 
+interface LlmNativeFunctionParserOptions<T extends BaseParser<any>> extends BaseParserOptions {
+    parser: T;
+}
+declare class LlmNativeFunctionParser<T extends BaseParser<any>> extends BaseParser<ParserOutput<T> | {
+    name: any;
+    arguments: any;
+}> {
+    parser: T;
+    constructor(options: LlmNativeFunctionParserOptions<T>);
+    parse(text: OutputResultContent[], _options?: Record<string, any>): ParserOutput<T> | {
+        name: string;
+        arguments: any;
+    };
+}
+/**
+ * @deprecated Use `LlmExecutorWithFunctions` instead.
+ */
+declare const OpenAiFunctionParser: typeof LlmNativeFunctionParser;
+
 declare function replaceTemplateString(templateString?: string, substitutions?: Record<string, any>, configuration?: PromptTemplateOptions): string;
 
 declare function replaceTemplateStringAsync(templateString?: string, substitutions?: Record<string, any>, configuration?: PromptTemplateOptions): Promise<string>;
@@ -740,9 +730,14 @@ declare class LlmExecutor<Llm extends BaseLlm<any>, Prompt extends BasePrompt<Re
 /**
  * Core Executor With LLM
  */
-declare class LlmExecutorOpenAiFunctions<Llm extends BaseLlm, Prompt extends BasePrompt<Record<string, any>>, Parser extends BaseParser, State extends BaseState> extends LlmExecutor<Llm, Prompt, Parser, State> {
+declare class LlmExecutorWithFunctions<Llm extends BaseLlm, Prompt extends BasePrompt<Record<string, any>>, Parser extends BaseParser, State extends BaseState> extends LlmExecutor<Llm, Prompt, Parser, State> {
     constructor(llmConfiguration: ExecutorWithLlmOptions<Llm, Prompt, Parser, State>, options?: CoreExecutorExecuteOptions<LlmExecutorHooks>);
-    execute<T extends GenericFunctionCall>(_input: PromptInput<Prompt>, _options: OpenAiLlmExecutorOptions<T>): Promise<ParserOutput<Parser>>;
+    execute<T extends GenericFunctionCall>(_input: PromptInput<Prompt>, _options: LlmExecutorWithFunctionsOptions<T>): Promise<ParserOutput<Parser>>;
+}
+/**
+ * @deprecated Use `LlmExecutorWithFunctions` instead.
+ */
+declare class LlmExecutorOpenAiFunctions<Llm extends BaseLlm, Prompt extends BasePrompt<Record<string, any>>, Parser extends BaseParser, State extends BaseState> extends LlmExecutorWithFunctions<Llm, Prompt, Parser, State> {
 }
 
 /**
@@ -763,6 +758,7 @@ declare function createCoreExecutor<I extends PlainObject, O>(handler: (input: I
  * @returns  - A new LlmExecutor instance.
  */
 declare function createLlmExecutor<Llm extends BaseLlm<any>, Prompt extends BasePrompt<any>, Parser extends BaseParser, State extends BaseState>(llmConfiguration: ExecutorWithLlmOptions<Llm, Prompt, Parser, State>, options?: CoreExecutorExecuteOptions<LlmExecutorHooks>): LlmExecutor<Llm, Prompt, Parser, State>;
+declare function createLlmFunctionExecutor<Llm extends BaseLlm, Prompt extends BasePrompt<Record<string, any>>, Parser extends BaseParser, State extends BaseState>(llmConfiguration: ExecutorWithLlmOptions<Llm, Prompt, Parser, State>, options?: CoreExecutorExecuteOptions<LlmExecutorHooks>): LlmExecutorWithFunctions<Llm, Prompt, Parser, State>;
 
 declare const hookOnComplete = "onComplete";
 declare const hookOnError = "onError";
@@ -829,6 +825,20 @@ interface CallableExecutorCore {
     description: string;
     parameters?: Record<string, any>;
 }
+interface LlmExecutorExecuteOptions {
+    functions?: CallableExecutorCore[];
+    functionCall?: any;
+    jsonSchema?: Record<string, any>;
+}
+type GenericFunctionCall = "auto" | "none" | "any" | {
+    name: string;
+};
+interface LlmExecutorWithFunctionsOptions<T extends GenericFunctionCall = "auto"> extends LlmExecutorExecuteOptions {
+    functions?: CallableExecutorCore[];
+    functionCall?: T;
+    functionCallStrictInput?: boolean;
+    jsonSchema?: Record<string, any>;
+}
 
 type CreateParserType = "json" | "string" | "boolean" | "number" | "stringExtract" | "listToArray" | "listToJson" | "listToKeyValue" | "replaceStringTemplate" | "markdownCodeBlocks" | "markdownCodeBlock";
 interface BaseParserOptions {
@@ -1038,6 +1048,7 @@ type AllUseLlmOptions = AllLlm & {
 };
 type LlmProviderKey = keyof AllLlm;
 type EmbeddingProviderKey = keyof AllEmbedding;
+type UseLlmKey = keyof AllUseLlmOptions;
 interface BaseLlCall {
     getResultContent: () => OutputResultContent[];
     getResultText: () => string;
@@ -1259,8 +1270,8 @@ declare const configs: {
 };
 
 declare function useLlm<T extends keyof typeof configs>(provider: T, options?: AllUseLlmOptions[T]["input"]): {
-    call: (messages: string | IChatMessages, options?: OpenAiLlmExecutorOptions<"auto"> | undefined) => Promise<{
-        getResultContent: (index?: number | undefined) => OutputResultContent[];
+    call: (messages: string | IChatMessages, options?: LlmExecutorWithFunctionsOptions) => Promise<{
+        getResultContent: (index?: number) => OutputResultContent[];
         getResultText: () => string;
         getResult: () => OutputResult;
     }>;
@@ -1279,8 +1290,8 @@ declare function useLlm<T extends keyof typeof configs>(provider: T, options?: A
 };
 
 declare function createEmbedding<T extends EmbeddingProviderKey>(provider: T, options: AllEmbedding[T]["input"]): {
-    call: (messages: string | string[], options?: OpenAiLlmExecutorOptions<"auto"> | undefined) => Promise<{
-        getEmbedding: (index?: number | undefined) => number[];
+    call: (messages: string | string[], options?: LlmExecutorWithFunctionsOptions) => Promise<{
+        getEmbedding: (index?: number) => number[];
         getResult: () => EmbeddingOutputResult;
     }>;
     getTraceId: () => string | null;
@@ -1297,4 +1308,4 @@ declare function createEmbedding<T extends EmbeddingProviderKey>(provider: T, op
     };
 };
 
-export { BaseExecutor, type BaseLlm, BaseParser, BasePrompt, BaseStateItem, ChatPrompt, CustomParser, DefaultState, DefaultStateItem, type ExecutorContext, type IChatMessages, LlmExecutorOpenAiFunctions, type LlmProvider, type OpenAIModelName, OpenAiFunctionParser, TextPrompt, createCallableExecutor, createChatPrompt, createCoreExecutor, createCustomParser, createDialogue, createEmbedding, createLlmExecutor, createParser, createPrompt, createState, createStateItem, useExecutors, useLlm, index as utils };
+export { BaseExecutor, type BaseLlm, BaseParser, BasePrompt, BaseStateItem, ChatPrompt, CustomParser, DefaultState, DefaultStateItem, type EmbeddingProviderKey, type ExecutorContext, type IChatMessages, LlmExecutorOpenAiFunctions, LlmExecutorWithFunctions, LlmNativeFunctionParser, type LlmProvider, type LlmProviderKey, type OpenAIModelName, OpenAiFunctionParser, TextPrompt, type UseLlmKey, createCallableExecutor, createChatPrompt, createCoreExecutor, createCustomParser, createDialogue, createEmbedding, createLlmExecutor, createLlmFunctionExecutor, createParser, createPrompt, createState, createStateItem, defineSchema, registerHelpers, registerPartials, useExecutors, useLlm, index as utils };