@ai-sdk/groq 0.0.1

package/CHANGELOG.md

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

package/dist/index.d.mts

@@ -0,0 +1,63 @@
+import { ProviderV1, LanguageModelV1 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+
+type GroqChatModelId = 'gemma2-9b-it' | 'gemma-7b-it' | 'llama3-groq-70b-8192-tool-use-preview' | 'llama3-groq-8b-8192-tool-use-preview' | 'llama-3.1-70b-versatile' | 'llama-3.1-8b-instant' | 'llama-3.2-1b-preview' | 'llama-3.2-3b-preview' | 'llama-3.2-11b-vision-preview' | 'llama-guard-3-8b' | 'llava-v1.5-7b-4096-preview' | 'llama3-70b-8192' | 'llama3-8b-8192' | 'mixtral-8x7b-32768' | (string & {});
+interface GroqChatSettings {
+    /**
+  Whether to enable parallel function calling during tool use. Default to true.
+     */
+    parallelToolCalls?: boolean;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+  */
+    user?: string;
+    /**
+  Automatically download images and pass the image as data to the model.
+  Groq supports image URLs for public models, so this is only needed for
+  private models or when the images are not publicly accessible.
+  
+  Defaults to `false`.
+     */
+    downloadImages?: boolean;
+}
+
+interface GroqProvider extends ProviderV1 {
+    /**
+  Creates a model for text generation.
+  */
+    (modelId: GroqChatModelId, settings?: GroqChatSettings): LanguageModelV1;
+    /**
+  Creates an Groq chat model for text generation.
+     */
+    languageModel(modelId: GroqChatModelId, settings?: GroqChatSettings): LanguageModelV1;
+}
+interface GroqProviderSettings {
+    /**
+  Base URL for the Groq 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 Groq provider instance.
+ */
+declare function createGroq(options?: GroqProviderSettings): GroqProvider;
+/**
+Default Groq provider instance.
+ */
+declare const groq: GroqProvider;
+
+export { type GroqProvider, type GroqProviderSettings, createGroq, groq };

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+import { ProviderV1, LanguageModelV1 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+
+type GroqChatModelId = 'gemma2-9b-it' | 'gemma-7b-it' | 'llama3-groq-70b-8192-tool-use-preview' | 'llama3-groq-8b-8192-tool-use-preview' | 'llama-3.1-70b-versatile' | 'llama-3.1-8b-instant' | 'llama-3.2-1b-preview' | 'llama-3.2-3b-preview' | 'llama-3.2-11b-vision-preview' | 'llama-guard-3-8b' | 'llava-v1.5-7b-4096-preview' | 'llama3-70b-8192' | 'llama3-8b-8192' | 'mixtral-8x7b-32768' | (string & {});
+interface GroqChatSettings {
+    /**
+  Whether to enable parallel function calling during tool use. Default to true.
+     */
+    parallelToolCalls?: boolean;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+  */
+    user?: string;
+    /**
+  Automatically download images and pass the image as data to the model.
+  Groq supports image URLs for public models, so this is only needed for
+  private models or when the images are not publicly accessible.
+  
+  Defaults to `false`.
+     */
+    downloadImages?: boolean;
+}
+
+interface GroqProvider extends ProviderV1 {
+    /**
+  Creates a model for text generation.
+  */
+    (modelId: GroqChatModelId, settings?: GroqChatSettings): LanguageModelV1;
+    /**
+  Creates an Groq chat model for text generation.
+     */
+    languageModel(modelId: GroqChatModelId, settings?: GroqChatSettings): LanguageModelV1;
+}
+interface GroqProviderSettings {
+    /**
+  Base URL for the Groq 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 Groq provider instance.
+ */
+declare function createGroq(options?: GroqProviderSettings): GroqProvider;
+/**
+Default Groq provider instance.
+ */
+declare const groq: GroqProvider;
+
+export { type GroqProvider, type GroqProviderSettings, createGroq, groq };