@ai-sdk/open-responses 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @ai-sdk/open-responses
+
+## 1.0.0
+
+### Major Changes
+
+- 8a4f19d: feat(open-responses): add Open Responses provider

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,57 @@
+# AI SDK - Open Responses Provider
+
+The **[Open Responses provider](https://ai-sdk.dev/providers/ai-sdk-providers/open-responses)** for the [AI SDK](https://ai-sdk.dev/docs)
+contains language model support for [Open Responses](https://www.openresponses.org/) compatible APIs.
+
+## Setup
+
+The Open Responses provider is available in the `@ai-sdk/open-responses` module. You can install it with
+
+```bash
+npm i @ai-sdk/open-responses
+```
+
+## Skill for Coding Agents
+
+If you use coding agents such as Claude Code or Cursor, we highly recommend adding the AI SDK skill to your repository:
+
+```shell
+npx skills add vercel/ai
+```
+
+## Provider Instance
+
+Create an Open Responses provider instance using `createOpenResponses`:
+
+```ts
+import { createOpenResponses } from '@ai-sdk/open-responses';
+
+const openResponses = createOpenResponses({
+  name: 'aProvider',
+  url: 'http://localhost:1234/v1/responses',
+});
+```
+
+You can use this instance to access models served by any Open Responses compatible endpoint.
+
+## Example
+
+```ts
+import { createOpenResponses } from '@ai-sdk/open-responses';
+import { generateText } from 'ai';
+
+const openResponses = createOpenResponses({
+  name: 'aProvider',
+  url: 'http://localhost:1234/v1/responses',
+});
+
+const { text } = await generateText({
+  model: openResponses('mistralai/ministral-3-14b-reasoning'),
+  prompt: 'Invent a new holiday and describe its traditions.',
+  maxOutputTokens: 100,
+});
+```
+
+## Documentation
+
+Please check out the **[Open Responses provider documentation](https://ai-sdk.dev/providers/ai-sdk-providers/open-responses)** for more information.

package/dist/index.d.mts

@@ -0,0 +1,34 @@
+import { ProviderV3, LanguageModelV3 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+
+declare const VERSION: string;
+
+interface OpenResponsesProvider extends ProviderV3 {
+    (modelId: string): LanguageModelV3;
+}
+interface OpenResponsesProviderSettings {
+    /**
+     * URL for the Open Responses API POST endpoint.
+     */
+    url: string;
+    /**
+     * Provider name. Used as key for provider options and metadata.
+     */
+    name: string;
+    /**
+     * API key for authenticating requests.
+     */
+    apiKey?: string;
+    /**
+     * Custom headers to include in the requests.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom fetch implementation. You can use it as a middleware to intercept requests,
+     * or to provide a custom fetch implementation for e.g. testing.
+     */
+    fetch?: FetchFunction;
+}
+declare function createOpenResponses(options: OpenResponsesProviderSettings): OpenResponsesProvider;
+
+export { VERSION, createOpenResponses };

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import { ProviderV3, LanguageModelV3 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+
+declare const VERSION: string;
+
+interface OpenResponsesProvider extends ProviderV3 {
+    (modelId: string): LanguageModelV3;
+}
+interface OpenResponsesProviderSettings {
+    /**
+     * URL for the Open Responses API POST endpoint.
+     */
+    url: string;
+    /**
+     * Provider name. Used as key for provider options and metadata.
+     */
+    name: string;
+    /**
+     * API key for authenticating requests.
+     */
+    apiKey?: string;
+    /**
+     * Custom headers to include in the requests.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom fetch implementation. You can use it as a middleware to intercept requests,
+     * or to provide a custom fetch implementation for e.g. testing.
+     */
+    fetch?: FetchFunction;
+}
+declare function createOpenResponses(options: OpenResponsesProviderSettings): OpenResponsesProvider;
+
+export { VERSION, createOpenResponses };