@livekit/agents-plugin-openai 0.3.5 → 0.4.0

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @livekit/agents-plugin-openai@0.3.5 build /home/runner/work/agents-js/agents-js/plugins/openai
+> @livekit/agents-plugin-openai@0.4.0 build /home/runner/work/agents-js/agents-js/plugins/openai
 > tsc -b tsconfig.json
 

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @livekit/agents-plugin-openai
 
+## 0.4.0
+
+### Minor Changes
+
+- OpenAI function calling: support arrays and optional fields in function call schema - [#140](https://github.com/livekit/agents-js/pull/140) ([@nbsp](https://github.com/nbsp))
+
+- add OpenAI LLM - [#140](https://github.com/livekit/agents-js/pull/140) ([@nbsp](https://github.com/nbsp))
+
+### Patch Changes
+
+- add ChatContext - [#140](https://github.com/livekit/agents-js/pull/140) ([@nbsp](https://github.com/nbsp))
+
+- Updated dependencies [[`d9273f27ae8df6c41e56a8258f540a4ffd9a7b7b`](https://github.com/livekit/agents-js/commit/d9273f27ae8df6c41e56a8258f540a4ffd9a7b7b), [`b4b9c1d337ff9a0212e90fb31002d4fcf58fe287`](https://github.com/livekit/agents-js/commit/b4b9c1d337ff9a0212e90fb31002d4fcf58fe287), [`4713a0490a3e4cd823aa648172c618ea924ae5d6`](https://github.com/livekit/agents-js/commit/4713a0490a3e4cd823aa648172c618ea924ae5d6), [`09782ec316590aa956d1a234dfb5594a8974dbfc`](https://github.com/livekit/agents-js/commit/09782ec316590aa956d1a234dfb5594a8974dbfc), [`d32f2470d4d1ea6786f4e13334f7251cc9823c04`](https://github.com/livekit/agents-js/commit/d32f2470d4d1ea6786f4e13334f7251cc9823c04), [`37bcf55aa75a289978af82e86332298dd7c07c73`](https://github.com/livekit/agents-js/commit/37bcf55aa75a289978af82e86332298dd7c07c73), [`35265a5b58adcbc048078d39c115412734dd4462`](https://github.com/livekit/agents-js/commit/35265a5b58adcbc048078d39c115412734dd4462), [`61899cde8c7fc19791d9d7d6a5ccabc2bb8f94dd`](https://github.com/livekit/agents-js/commit/61899cde8c7fc19791d9d7d6a5ccabc2bb8f94dd), [`644effb7c607e214e8d3ff8147afa7aec4a2496b`](https://github.com/livekit/agents-js/commit/644effb7c607e214e8d3ff8147afa7aec4a2496b), [`0e40262f3a60823d3d9cabbbd90f71c943db6c0e`](https://github.com/livekit/agents-js/commit/0e40262f3a60823d3d9cabbbd90f71c943db6c0e), [`cb788b7c37ca2297c04f5deb410a2fdab70d5c5f`](https://github.com/livekit/agents-js/commit/cb788b7c37ca2297c04f5deb410a2fdab70d5c5f), [`f844e8bb865beadbc58ea1c3a21e362aee1dce55`](https://github.com/livekit/agents-js/commit/f844e8bb865beadbc58ea1c3a21e362aee1dce55)]:
+  - @livekit/agents@0.4.0
+
 ## 0.3.5
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,2 +1,4 @@
 export * as realtime from './realtime/index.js';
+export * from './models.js';
+export { type LLMOptions, LLM, LLMStream } from './llm.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,KAAK,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -2,4 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 export * as realtime from './realtime/index.js';
+export * from './models.js';
+export { LLM, LLMStream } from './llm.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,EAAE;AACF,sCAAsC;AACtC,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,EAAE;AACF,sCAAsC;AACtC,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAmB,GAAG,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC"}

package/dist/llm.d.ts

@@ -0,0 +1,195 @@
+import { llm } from '@livekit/agents';
+import { OpenAI } from 'openai';
+import type { CerebrasChatModels, ChatModels, DeepSeekChatModels, GroqChatModels, OctoChatModels, PerplexityChatModels, TelnyxChatModels, TogetherChatModels, XAIChatModels } from './models.js';
+export interface LLMOptions {
+    model: string | ChatModels;
+    apiKey?: string;
+    baseURL?: string;
+    user?: string;
+    temperature?: number;
+    client?: OpenAI;
+}
+export declare class LLM extends llm.LLM {
+    #private;
+    /**
+     * Create a new instance of OpenAI LLM.
+     *
+     * @remarks
+     * `apiKey` must be set to your OpenAI API key, either using the argument or by setting the
+     * `OPENAI_API_KEY` environmental variable.
+     */
+    constructor(opts?: Partial<LLMOptions>);
+    /**
+     * Create a new instance of OpenAI LLM with Azure.
+     *
+     * @remarks
+     * This automatically infers the following arguments from their corresponding environment variables if they are not provided:
+     * - `apiKey` from `AZURE_OPENAI_API_KEY`
+     * - `organization` from `OPENAI_ORG_ID`
+     * - `project` from `OPENAI_PROJECT_ID`
+     * - `azureAdToken` from `AZURE_OPENAI_AD_TOKEN`
+     * - `apiVersion` from `OPENAI_API_VERSION`
+     * - `azureEndpoint` from `AZURE_OPENAI_ENDPOINT`
+     */
+    static withAzure(opts?: {
+        model: string | ChatModels;
+        azureEndpoint?: string;
+        azureDeployment?: string;
+        apiVersion?: string;
+        apiKey?: string;
+        azureAdToken?: string;
+        azureAdTokenProvider?: () => Promise<string>;
+        organization?: string;
+        project?: string;
+        baseURL?: string;
+        user?: string;
+        temperature?: number;
+    }): LLM;
+    /**
+     * Create a new instance of Cerebras LLM.
+     *
+     * @remarks
+     * `apiKey` must be set to your Cerebras API key, either using the argument or by setting the
+     * `CEREBRAS_API_KEY` environmental variable.
+     */
+    static withCerebras(opts?: Partial<{
+        model: string | CerebrasChatModels;
+        apiKey?: string;
+        baseURL?: string;
+        user?: string;
+        temperature?: number;
+        client: OpenAI;
+    }>): LLM;
+    /**
+     * Create a new instance of Fireworks LLM.
+     *
+     * @remarks
+     * `apiKey` must be set to your Fireworks API key, either using the argument or by setting the
+     * `FIREWORKS_API_KEY` environmental variable.
+     */
+    static withFireworks(opts?: Partial<LLMOptions>): LLM;
+    /**
+     * Create a new instance of xAI LLM.
+     *
+     * @remarks
+     * `apiKey` must be set to your xAI API key, either using the argument or by setting the
+     * `XAI_API_KEY` environmental variable.
+     */
+    static withXAI(opts?: Partial<{
+        model: string | XAIChatModels;
+        apiKey?: string;
+        baseURL?: string;
+        user?: string;
+        temperature?: number;
+        client: OpenAI;
+    }>): LLM;
+    /**
+     * Create a new instance of Groq LLM.
+     *
+     * @remarks
+     * `apiKey` must be set to your Groq API key, either using the argument or by setting the
+     * `GROQ_API_KEY` environmental variable.
+     */
+    static withGroq(opts?: Partial<{
+        model: string | GroqChatModels;
+        apiKey?: string;
+        baseURL?: string;
+        user?: string;
+        temperature?: number;
+        client: OpenAI;
+    }>): LLM;
+    /**
+     * Create a new instance of DeepSeek LLM.
+     *
+     * @remarks
+     * `apiKey` must be set to your DeepSeek API key, either using the argument or by setting the
+     * `DEEPSEEK_API_KEY` environmental variable.
+     */
+    static withDeepSeek(opts?: Partial<{
+        model: string | DeepSeekChatModels;
+        apiKey?: string;
+        baseURL?: string;
+        user?: string;
+        temperature?: number;
+        client: OpenAI;
+    }>): LLM;
+    /**
+     * Create a new instance of OctoAI LLM.
+     *
+     * @remarks
+     * `apiKey` must be set to your OctoAI API key, either using the argument or by setting the
+     * `OCTOAI_TOKEN` environmental variable.
+     */
+    static withOcto(opts?: Partial<{
+        model: string | OctoChatModels;
+        apiKey?: string;
+        baseURL?: string;
+        user?: string;
+        temperature?: number;
+        client: OpenAI;
+    }>): LLM;
+    /** Create a new instance of Ollama LLM. */
+    static withOllama(opts?: Partial<{
+        model: string;
+        baseURL?: string;
+        temperature?: number;
+        client: OpenAI;
+    }>): LLM;
+    /**
+     * Create a new instance of PerplexityAI LLM.
+     *
+     * @remarks
+     * `apiKey` must be set to your PerplexityAI API key, either using the argument or by setting the
+     * `PERPLEXITY_API_KEY` environmental variable.
+     */
+    static withPerplexity(opts?: Partial<{
+        model: string | PerplexityChatModels;
+        apiKey?: string;
+        baseURL?: string;
+        user?: string;
+        temperature?: number;
+        client: OpenAI;
+    }>): LLM;
+    /**
+     * Create a new instance of TogetherAI LLM.
+     *
+     * @remarks
+     * `apiKey` must be set to your TogetherAI API key, either using the argument or by setting the
+     * `TOGETHER_API_KEY` environmental variable.
+     */
+    static withTogether(opts?: Partial<{
+        model: string | TogetherChatModels;
+        apiKey?: string;
+        baseURL?: string;
+        user?: string;
+        temperature?: number;
+        client: OpenAI;
+    }>): LLM;
+    /**
+     * Create a new instance of Telnyx LLM.
+     *
+     * @remarks
+     * `apiKey` must be set to your Telnyx API key, either using the argument or by setting the
+     * `TELNYX_API_KEY` environmental variable.
+     */
+    static withTelnyx(opts?: Partial<{
+        model: string | TelnyxChatModels;
+        apiKey?: string;
+        baseURL?: string;
+        user?: string;
+        temperature?: number;
+        client: OpenAI;
+    }>): LLM;
+    chat({ chatCtx, fncCtx, temperature, n, parallelToolCalls, }: {
+        chatCtx: llm.ChatContext;
+        fncCtx?: llm.FunctionContext | undefined;
+        temperature?: number | undefined;
+        n?: number | undefined;
+        parallelToolCalls?: boolean | undefined;
+    }): LLMStream;
+}
+export declare class LLMStream extends llm.LLMStream {
+    #private;
+    constructor(client: OpenAI, chatCtx: llm.ChatContext, fncCtx: llm.FunctionContext | undefined, opts: LLMOptions, parallelToolCalls?: boolean, temperature?: number, n?: number);
+}
+//# sourceMappingURL=llm.d.ts.map

package/dist/llm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"llm.d.ts","sourceRoot":"","sources":["../src/llm.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,GAAG,EAAO,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAe,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE7C,OAAO,KAAK,EACV,kBAAkB,EAClB,UAAU,EACV,kBAAkB,EAClB,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACd,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAYD,qBAAa,GAAI,SAAQ,GAAG,CAAC,GAAG;;IAI9B;;;;;;OAMG;gBACS,IAAI,GAAE,OAAO,CAAC,UAAU,CAAqB;IAgBzD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,CACd,IAAI,GAAE;QACJ,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC;QAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,oBAAoB,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACG,GACzB,GAAG;IAaN;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CACjB,IAAI,GAAE,OAAO,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAC;QACnC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAM,GACN,GAAG;IAeN;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,GAAE,OAAO,CAAC,UAAU,CAAM,GAAG,GAAG;IAezD;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CACZ,IAAI,GAAE,OAAO,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,aAAa,CAAC;QAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAM,GACN,GAAG;IAaN;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CACb,IAAI,GAAE,OAAO,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,cAAc,CAAC;QAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAM,GACN,GAAG;IAaN;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CACjB,IAAI,GAAE,OAAO,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAC;QACnC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAM,GACN,GAAG;IAeN;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CACb,IAAI,GAAE,OAAO,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,cAAc,CAAC;QAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAM,GACN,GAAG;IAaN,2CAA2C;IAC3C,MAAM,CAAC,UAAU,CACf,IAAI,GAAE,OAAO,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAM,GACN,GAAG;IASN;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CACnB,IAAI,GAAE,OAAO,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,oBAAoB,CAAC;QACrC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAM,GACN,GAAG;IAeN;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CACjB,IAAI,GAAE,OAAO,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAC;QACnC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAM,GACN,GAAG;IAeN;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CACf,IAAI,GAAE,OAAO,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;QACjC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAM,GACN,GAAG;IAaN,IAAI,CAAC,EACH,OAAO,EACP,MAAM,EACN,WAAW,EACX,CAAC,EACD,iBAAiB,GAClB,EAAE;QACD,OAAO,EAAE,GAAG,CAAC,WAAW,CAAC;QACzB,MAAM,CAAC,EAAE,GAAG,CAAC,eAAe,GAAG,SAAS,CAAC;QACzC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACjC,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACvB,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACzC,GAAG,SAAS;CAad;AAED,qBAAa,SAAU,SAAQ,GAAG,CAAC,SAAS;;gBASxC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,GAAG,CAAC,WAAW,EACxB,MAAM,EAAE,GAAG,CAAC,eAAe,GAAG,SAAS,EACvC,IAAI,EAAE,UAAU,EAChB,iBAAiB,CAAC,EAAE,OAAO,EAC3B,WAAW,CAAC,EAAE,MAAM,EACpB,CAAC,CAAC,EAAE,MAAM;CAkJb"}