@ai-sdk/openai-compatible 2.0.20 → 2.0.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/dist/index.d.mts +19 -19
- package/dist/index.d.ts +19 -19
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/dist/internal/index.d.mts +4 -4
- package/dist/internal/index.d.ts +4 -4
- package/docs/index.mdx +579 -0
- package/package.json +7 -3
- package/src/chat/openai-compatible-metadata-extractor.ts +4 -4
- package/src/embedding/openai-compatible-embedding-model.ts +3 -3
- package/src/openai-compatible-provider.ts +12 -12
|
@@ -48,41 +48,41 @@ export interface OpenAICompatibleProvider<
|
|
|
48
48
|
|
|
49
49
|
export interface OpenAICompatibleProviderSettings {
|
|
50
50
|
/**
|
|
51
|
-
Base URL for the API calls.
|
|
51
|
+
* Base URL for the API calls.
|
|
52
52
|
*/
|
|
53
53
|
baseURL: string;
|
|
54
54
|
|
|
55
55
|
/**
|
|
56
|
-
Provider name.
|
|
56
|
+
* Provider name.
|
|
57
57
|
*/
|
|
58
58
|
name: string;
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
|
-
API key for authenticating requests. If specified, adds an `Authorization`
|
|
62
|
-
header to request headers with the value `Bearer <apiKey>`. This will be added
|
|
63
|
-
before any headers potentially specified in the `headers` option.
|
|
61
|
+
* API key for authenticating requests. If specified, adds an `Authorization`
|
|
62
|
+
* header to request headers with the value `Bearer <apiKey>`. This will be added
|
|
63
|
+
* before any headers potentially specified in the `headers` option.
|
|
64
64
|
*/
|
|
65
65
|
apiKey?: string;
|
|
66
66
|
|
|
67
67
|
/**
|
|
68
|
-
Optional custom headers to include in requests. These will be added to request headers
|
|
69
|
-
after any headers potentially added by use of the `apiKey` option.
|
|
68
|
+
* Optional custom headers to include in requests. These will be added to request headers
|
|
69
|
+
* after any headers potentially added by use of the `apiKey` option.
|
|
70
70
|
*/
|
|
71
71
|
headers?: Record<string, string>;
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
|
-
Optional custom url query parameters to include in request urls.
|
|
74
|
+
* Optional custom url query parameters to include in request urls.
|
|
75
75
|
*/
|
|
76
76
|
queryParams?: Record<string, string>;
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
Custom fetch implementation. You can use it as a middleware to intercept requests,
|
|
80
|
-
or to provide a custom fetch implementation for e.g. testing.
|
|
79
|
+
* Custom fetch implementation. You can use it as a middleware to intercept requests,
|
|
80
|
+
* or to provide a custom fetch implementation for e.g. testing.
|
|
81
81
|
*/
|
|
82
82
|
fetch?: FetchFunction;
|
|
83
83
|
|
|
84
84
|
/**
|
|
85
|
-
Include usage information in streaming responses.
|
|
85
|
+
* Include usage information in streaming responses.
|
|
86
86
|
*/
|
|
87
87
|
includeUsage?: boolean;
|
|
88
88
|
|
|
@@ -107,7 +107,7 @@ Include usage information in streaming responses.
|
|
|
107
107
|
}
|
|
108
108
|
|
|
109
109
|
/**
|
|
110
|
-
Create an OpenAICompatible provider instance.
|
|
110
|
+
* Create an OpenAICompatible provider instance.
|
|
111
111
|
*/
|
|
112
112
|
export function createOpenAICompatible<
|
|
113
113
|
CHAT_MODEL_IDS extends string,
|