@ai-sdk/openai-compatible 2.0.21 → 2.0.22

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai-compatible
 
+## 2.0.22
+
+### Patch Changes
+
+- 9d056e6: chore(openai-compatible): add docs to package
+
 ## 2.0.21
 
 ### Patch Changes

package/dist/index.d.mts

@@ -27,10 +27,10 @@ declare const openaiCompatibleProviderOptions: z.ZodObject<{
 type OpenAICompatibleProviderOptions = z.infer<typeof openaiCompatibleProviderOptions>;
 
 /**
-Extracts provider-specific metadata from API responses.
-Used to standardize metadata handling across different LLM providers while allowing
-provider-specific metadata to be captured.
-*/
+ * Extracts provider-specific metadata from API responses.
+ * Used to standardize metadata handling across different LLM providers while allowing
+ * provider-specific metadata to be captured.
+ */
 type MetadataExtractor = {
     /**
      * Extracts provider metadata from a complete, non-streaming response.
@@ -160,12 +160,12 @@ type OpenAICompatibleEmbeddingProviderOptions = z.infer<typeof openaiCompatibleE
 
 type OpenAICompatibleEmbeddingConfig = {
     /**
-  Override the maximum number of embeddings per call.
+     * Override the maximum number of embeddings per call.
      */
     maxEmbeddingsPerCall?: number;
     /**
-  Override the parallelism of embedding calls.
-    */
+     * Override the parallelism of embedding calls.
+     */
     supportsParallelCalls?: boolean;
     provider: string;
     url: (options: {
@@ -232,35 +232,35 @@ interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPL
 }
 interface OpenAICompatibleProviderSettings {
     /**
-  Base URL for the API calls.
+     * Base URL for the API calls.
      */
     baseURL: string;
     /**
-  Provider name.
+     * Provider name.
      */
     name: string;
     /**
-  API key for authenticating requests. If specified, adds an `Authorization`
-  header to request headers with the value `Bearer <apiKey>`. This will be added
-  before any headers potentially specified in the `headers` option.
+     * API key for authenticating requests. If specified, adds an `Authorization`
+     * header to request headers with the value `Bearer <apiKey>`. This will be added
+     * before any headers potentially specified in the `headers` option.
      */
     apiKey?: string;
     /**
-  Optional custom headers to include in requests. These will be added to request headers
-  after any headers potentially added by use of the `apiKey` option.
+     * Optional custom headers to include in requests. These will be added to request headers
+     * after any headers potentially added by use of the `apiKey` option.
      */
     headers?: Record<string, string>;
     /**
-  Optional custom url query parameters to include in request urls.
+     * Optional custom url query parameters to include in request urls.
      */
     queryParams?: 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.
+     * 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;
     /**
-  Include usage information in streaming responses.
+     * Include usage information in streaming responses.
      */
     includeUsage?: boolean;
     /**
@@ -281,7 +281,7 @@ interface OpenAICompatibleProviderSettings {
     metadataExtractor?: MetadataExtractor;
 }
 /**
-Create an OpenAICompatible provider instance.
+ * Create an OpenAICompatible provider instance.
  */
 declare function createOpenAICompatible<CHAT_MODEL_IDS extends string, COMPLETION_MODEL_IDS extends string, EMBEDDING_MODEL_IDS extends string, IMAGE_MODEL_IDS extends string>(options: OpenAICompatibleProviderSettings): OpenAICompatibleProvider<CHAT_MODEL_IDS, COMPLETION_MODEL_IDS, EMBEDDING_MODEL_IDS, IMAGE_MODEL_IDS>;
 

package/dist/index.d.ts

@@ -27,10 +27,10 @@ declare const openaiCompatibleProviderOptions: z.ZodObject<{
 type OpenAICompatibleProviderOptions = z.infer<typeof openaiCompatibleProviderOptions>;
 
 /**
-Extracts provider-specific metadata from API responses.
-Used to standardize metadata handling across different LLM providers while allowing
-provider-specific metadata to be captured.
-*/
+ * Extracts provider-specific metadata from API responses.
+ * Used to standardize metadata handling across different LLM providers while allowing
+ * provider-specific metadata to be captured.
+ */
 type MetadataExtractor = {
     /**
      * Extracts provider metadata from a complete, non-streaming response.
@@ -160,12 +160,12 @@ type OpenAICompatibleEmbeddingProviderOptions = z.infer<typeof openaiCompatibleE
 
 type OpenAICompatibleEmbeddingConfig = {
     /**
-  Override the maximum number of embeddings per call.
+     * Override the maximum number of embeddings per call.
      */
     maxEmbeddingsPerCall?: number;
     /**
-  Override the parallelism of embedding calls.
-    */
+     * Override the parallelism of embedding calls.
+     */
     supportsParallelCalls?: boolean;
     provider: string;
     url: (options: {
@@ -232,35 +232,35 @@ interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPL
 }
 interface OpenAICompatibleProviderSettings {
     /**
-  Base URL for the API calls.
+     * Base URL for the API calls.
      */
     baseURL: string;
     /**
-  Provider name.
+     * Provider name.
      */
     name: string;
     /**
-  API key for authenticating requests. If specified, adds an `Authorization`
-  header to request headers with the value `Bearer <apiKey>`. This will be added
-  before any headers potentially specified in the `headers` option.
+     * API key for authenticating requests. If specified, adds an `Authorization`
+     * header to request headers with the value `Bearer <apiKey>`. This will be added
+     * before any headers potentially specified in the `headers` option.
      */
     apiKey?: string;
     /**
-  Optional custom headers to include in requests. These will be added to request headers
-  after any headers potentially added by use of the `apiKey` option.
+     * Optional custom headers to include in requests. These will be added to request headers
+     * after any headers potentially added by use of the `apiKey` option.
      */
     headers?: Record<string, string>;
     /**
-  Optional custom url query parameters to include in request urls.
+     * Optional custom url query parameters to include in request urls.
      */
     queryParams?: 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.
+     * 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;
     /**
-  Include usage information in streaming responses.
+     * Include usage information in streaming responses.
      */
     includeUsage?: boolean;
     /**
@@ -281,7 +281,7 @@ interface OpenAICompatibleProviderSettings {
     metadataExtractor?: MetadataExtractor;
 }
 /**
-Create an OpenAICompatible provider instance.
+ * Create an OpenAICompatible provider instance.
  */
 declare function createOpenAICompatible<CHAT_MODEL_IDS extends string, COMPLETION_MODEL_IDS extends string, EMBEDDING_MODEL_IDS extends string, IMAGE_MODEL_IDS extends string>(options: OpenAICompatibleProviderSettings): OpenAICompatibleProvider<CHAT_MODEL_IDS, COMPLETION_MODEL_IDS, EMBEDDING_MODEL_IDS, IMAGE_MODEL_IDS>;
 

package/dist/index.js

@@ -1661,7 +1661,7 @@ function toCamelCase(str) {
 var import_provider_utils6 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "2.0.21" : "0.0.0-test";
+var VERSION = true ? "2.0.22" : "0.0.0-test";
 
 // src/openai-compatible-provider.ts
 function createOpenAICompatible(options) {