@ai-sdk/xai 1.0.0-canary.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @ai-sdk/xai
+
+## 1.0.0-canary.1
+
+### Patch Changes
+
+- 75d0065: feat (providers/xai): Initial xAI 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,36 @@
+# AI SDK - xAI Grok Provider
+
+The **[xAI Grok provider](https://sdk.vercel.ai/providers/ai-sdk-providers/xai)** for the [AI SDK](https://sdk.vercel.ai/docs)
+contains language model support for the xAI chat and completion APIs.
+
+## Setup
+
+The xAI Grok provider is available in the `@ai-sdk/xai` module. You can install it with
+
+```bash
+npm i @ai-sdk/xai
+```
+
+## Provider Instance
+
+You can import the default provider instance `xai` from `@ai-sdk/xai`:
+
+```ts
+import { xai } from '@ai-sdk/xai';
+```
+
+## Example
+
+```ts
+import { xai } from '@ai-sdk/xai';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: xai('grok-beta'),
+  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
+});
+```
+
+## Documentation
+
+Please check out the **[xAI Grok provider documentation](https://sdk.vercel.ai/providers/ai-sdk-providers/xai)** for more information.

package/dist/index.d.mts

@@ -0,0 +1,51 @@
+import { ProviderV1, LanguageModelV1 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+
+type XaiChatModelId = 'grok-beta' | (string & {});
+interface XaiChatSettings {
+    /**
+  A unique identifier representing your end-user, which can help xAI to
+  monitor and detect abuse.
+  */
+    user?: string;
+}
+
+interface XaiProvider extends ProviderV1 {
+    /**
+  Creates a model for text generation.
+  */
+    (modelId: XaiChatModelId, settings?: XaiChatSettings): LanguageModelV1;
+    /**
+  Creates an Xai chat model for text generation.
+     */
+    languageModel(modelId: XaiChatModelId, settings?: XaiChatSettings): LanguageModelV1;
+}
+interface XaiProviderSettings {
+    /**
+  Base URL for the xAI API calls.
+       */
+    baseURL?: 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;
+}
+/**
+Create an xAI provider instance.
+ */
+declare function createXai(options?: XaiProviderSettings): XaiProvider;
+/**
+Default xAI provider instance.
+ */
+declare const xai: XaiProvider;
+
+export { type XaiProvider, type XaiProviderSettings, createXai, xai };

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+import { ProviderV1, LanguageModelV1 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+
+type XaiChatModelId = 'grok-beta' | (string & {});
+interface XaiChatSettings {
+    /**
+  A unique identifier representing your end-user, which can help xAI to
+  monitor and detect abuse.
+  */
+    user?: string;
+}
+
+interface XaiProvider extends ProviderV1 {
+    /**
+  Creates a model for text generation.
+  */
+    (modelId: XaiChatModelId, settings?: XaiChatSettings): LanguageModelV1;
+    /**
+  Creates an Xai chat model for text generation.
+     */
+    languageModel(modelId: XaiChatModelId, settings?: XaiChatSettings): LanguageModelV1;
+}
+interface XaiProviderSettings {
+    /**
+  Base URL for the xAI API calls.
+       */
+    baseURL?: 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;
+}
+/**
+Create an xAI provider instance.
+ */
+declare function createXai(options?: XaiProviderSettings): XaiProvider;
+/**
+Default xAI provider instance.
+ */
+declare const xai: XaiProvider;
+
+export { type XaiProvider, type XaiProviderSettings, createXai, xai };