@inkeep/ai-sdk-provider 0.29.0

package/LICENSE.md

@@ -0,0 +1,49 @@
+# Inkeep SDK – Elastic License 2.0 with Supplemental Terms
+
+NOTE: The Inkeep SDK is licensed under the Elastic License 2.0 (ELv2), subject to Supplemental Terms included in [SUPPLEMENTAL_TERMS.md](SUPPLEMENTAL_TERMS.md). In the event of conflict, the Supplemental Terms control.
+
+# Elastic License 2.0
+
+## Acceptance  
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below.
+
+## Limitations
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+## Patents
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Notices
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+## No Other Rights
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+## Termination
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+## No Liability
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+The **licensor** is the entity offering these terms, and the **software** is the software the licensor makes available under these terms, including any portion of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. **control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.
+

package/README.md

@@ -0,0 +1,206 @@
+# @inkeep/ai-sdk-provider
+
+AI SDK provider for Inkeep Agent Framework. This package allows you to use Inkeep agents through the [Vercel AI SDK](https://sdk.vercel.ai/docs).
+
+## Installation
+
+```bash
+npm install @inkeep/ai-sdk-provider
+
+```
+
+## Usage
+
+## Basic Usage
+
+### Text Generation
+
+```typescript
+import { generateText } from 'ai';
+import { createInkeep } from '@inkeep/ai-sdk-provider';
+
+const inkeep = createInkeep({
+  baseURL: proccess.env.INKEEP_AGENTS_RUN_API_URL, // Required
+  apiKey: <your-agent-api-key>, // Created in the Agents Dashboard
+  headers: { // Optional if you are developing locally and dont want to use an api key
+    'x-inkeep-agent-id': 'your-agent-id',
+    'x-inkeep-tenant-id': 'your-tenant-id',
+    'x-inkeep-project-id': 'your-project-id',
+  },
+});
+
+const { text } = await generateText({
+  model: inkeep('agent-123'),
+  prompt: 'What is the weather in NYC?',
+});
+
+console.log(text);
+```
+
+### Streaming Responses
+
+```typescript
+import { streamText } from 'ai';
+import { createInkeep } from '@inkeep/ai-sdk-provider';
+
+const inkeep = createInkeep({
+  baseURL: proccess.env.INKEEP_AGENTS_RUN_API_URL,
+  headers: {
+    'x-emit-operations': 'true', // Enable tool event streaming
+  },
+});
+
+const result = await streamText({
+  model: inkeep('agent-123'),
+  prompt: 'Plan an event in NYC',
+});
+
+for await (const chunk of result.textStream) {
+  process.stdout.write(chunk);
+}
+```
+
+```typescript
+createInkeep({
+  baseURL: string,        // Required. Your agents-run-api URL
+  apiKey?: string,        // Optional. Bearer token for authentication
+  headers?: Record<string, string>, // Optional. Additional headers
+})
+```
+
+### Model Options
+
+Pass options when creating a provider instance:
+
+```typescript
+const provider = inkeep({
+  conversationId: 'conv-456',
+  headers: { 'user-id': 'user-789' },
+});
+```
+
+### Additional Options
+
+```typescript
+import { inkeep } from '@inkeep/ai-sdk-provider';
+import { generateText } from 'ai';
+
+const result = await generateText({
+  model: inkeep('agent-123', {
+    conversationId: 'conv-123',
+    headers: {
+      'user-id': 'user-456',
+    },
+  }),
+  prompt: 'Hello!',
+});
+```
+
+## Configuration
+
+### Provider Settings
+
+When creating a custom provider with `createInkeep()`, you can configure:
+
+- `baseURL` - **Required.** The base URL of your Inkeep agents API (can also be set via `INKEEP_AGENTS_RUN_API_URL` environment variable)
+- `apiKey` - Your Inkeep API key (can also be set via `INKEEP_API_KEY` environment variable)
+- `headers` - Additional headers to include in requests
+
+### Model Options
+
+When creating a model instance, you can configure:
+
+- `conversationId` - Conversation ID for multi-turn conversations
+- `headers` - Additional headers for context (validated against agent's context config)
+
+## Environment Variables
+
+- `INKEEP_AGENTS_RUN_API_URL` - Base URL for the Inkeep agents API (unless provided via `baseURL` option)
+
+## Features
+
+- ✅ Text generation (`generateText`)
+- ✅ Streaming responses (`streamText`)
+- ✅ Multi-turn conversations
+- ✅ Custom headers for context
+- ✅ Authentication with Bearer tokens
+- ✅ Tool call observability (with `x-emit-operations` header)
+
+## API Endpoint
+
+This provider communicates with the `/api/chat` endpoint of your Inkeep Agents Run API.
+
+- **Non-streaming** (`generateText`): Sends `stream: false` parameter - returns complete JSON response
+- **Streaming** (`streamText`): Sends `stream: true` parameter - returns Vercel AI SDK data stream
+
+The endpoint supports both streaming and non-streaming modes and uses Bearer token authentication.
+
+### Tool Call Observability
+
+To receive tool call and tool result events in your stream, include the `x-emit-operations: true` header:
+
+```typescript
+import { streamText } from 'ai';
+import { createInkeep } from '@inkeep/ai-sdk-provider';
+
+const inkeep = createInkeep({
+  baseURL: 'https://your-api.example.com',
+  apiKey: process.env.INKEEP_API_KEY,
+  headers: {
+    'x-emit-operations': 'true', // Enable tool event streaming
+  },
+});
+
+const result = await streamText({
+  model: inkeep('agent-123'),
+  prompt: 'Search for recent papers on AI',
+});
+
+// Listen for all stream events
+for await (const event of result.fullStream) {
+  switch (event.type) {
+    case 'text-start':
+      console.log('📝 Text streaming started');
+      break;
+    case 'text-delta':
+      process.stdout.write(event.delta);
+      break;
+    case 'text-end':
+      console.log('\n📝 Text streaming ended');
+      break;
+    case 'tool-call':
+      console.log(`🔧 Calling tool: ${event.toolName}`);
+      console.log(`   Input: ${event.input}`);
+      break;
+    case 'tool-result':
+      console.log(`✅ Tool result from: ${event.toolName}`);
+      console.log(`   Output:`, event.result);
+      break;
+  }
+}
+```
+
+**Note**: Tool events are only emitted when the `x-emit-operations: true` header is set. Without this header, you'll only receive text lifecycle events (text-start, text-delta, text-end) and the final response.
+
+### Supported Stream Events
+
+The provider emits the following AI SDK v2 stream events:
+
+**Text Events** (always emitted):
+- `text-start` - Marks the beginning of a text stream
+- `text-delta` - Text content chunks as they arrive
+- `text-end` - Marks the end of a text stream
+
+**Tool Events** (requires `x-emit-operations: true` header):
+- `tool-call` - Agent is calling a tool
+- `tool-result` - Tool execution completed
+
+**Control Events** (always emitted):
+- `finish` - Stream completion with usage statistics
+- `error` - Stream error occurred
+
+## Model Identification
+
+Models are identified by agent ID in the format:
+- `agent-123` - Direct agent ID
+- `inkeep/agent-123` - With provider prefix (when used with custom factories)