brianyin/ajs-260-add-gateway-api-to-js

.cursor/rules/agent-core.mdc

@@ -508,6 +508,30 @@ For more information, read the example agent file under the `examples` directory
 
 `pnpm build && pnpm dlx tsx ./examples/src/my_agent.ts dev|download-files --log-level=debug|info(default)`
 
+
+## License
+
+Remember to always add the following header to the top of every newly added file.
+```
+// SPDX-FileCopyrightText: 2025 LiveKit, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+```
+
 ## Debugging Plugins
 
-For plugin components such as STT, TTS, LLM. You can debug these individual components by creating a new example agent file under the `examples` directory. You do not need to have `defineAgent` function if you only want to debug individual plugin components, just run `pnpm build` and `node ./examples/src/test_my_plugin.ts` to test the plugin. Test file is prefixed with `test_`.
+For plugin components such as STT, TTS, LLM. You can debug these individual components by creating a new example agent file under the `examples` directory. You do not need to have `defineAgent` function if you only want to debug individual plugin components, just run `pnpm build` and `node ./examples/src/test_my_plugin.ts` to test the plugin. Test file is prefixed with `test_`.
+
+### Inference LLM Testing Guidelines
+
+When testing the inference LLM (`inference.LLM`):
+
+1. **Model Names**: Always use the full model names from `agents/src/inference/models.ts`. Use `'openai/gpt-4o-mini'` instead of just `'gpt-4o-mini'`.
+
+2. **Logger Initialization**: Always initialize the logger before using any LLM functionality:
+   ```typescript
+   import { initializeLogger } from '@livekit/agents';
+   initializeLogger({ pretty: true });
+   ```
+
+6. **Test Structure**: Include both basic streaming and tool calling tests to verify full functionality.

agents/package.json

@@ -44,12 +44,13 @@
   },
   "dependencies": {
     "@livekit/mutex": "^1.1.1",
-    "@livekit/protocol": "^1.29.1",
+    "@livekit/protocol": "^1.41.0",
     "@livekit/typed-emitter": "^3.0.0",
     "@types/pidusage": "^2.0.5",
     "commander": "^12.0.0",
     "heap-js": "^2.6.0",
     "json-schema": "^0.4.0",
+    "openai": "^4.91.1",
     "livekit-server-sdk": "^2.13.3",
     "pidusage": "^4.0.1",
     "pino": "^8.19.0",

agents/src/index.ts

@@ -10,6 +10,7 @@
  * @packageDocumentation
  */
 import * as cli from './cli.js';
+import * as inference from './inference/index.js';
 import * as ipc from './ipc/index.js';
 import * as llm from './llm/index.js';
 import * as metrics from './metrics/index.js';
@@ -33,4 +34,4 @@ export * from './vad.js';
 export * from './version.js';
 export * from './worker.js';
 
-export { cli, ipc, llm, metrics, stream, stt, tokenize, tts, voice };
+export { cli, inference, ipc, llm, metrics, stream, stt, tokenize, tts, voice };

agents/src/inference/index.ts

@@ -0,0 +1,7 @@
+// SPDX-FileCopyrightText: 2025 LiveKit, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+export { LLM, LLMStream } from './llm.js';
+export type { GatewayOptions, InferenceLLMOptions } from './llm.js';
+export type { LLMModels, STTLanguages, STTModels, TTSModels } from './models.js';
+export { STT } from './stt.js';