Defined in: packages/integrations/src/model-provider/openai-compatible/index.ts:8
Options for a provider that speaks the OpenAI chat completions API.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
apiKey |
string |
API key of the provider. | packages/integrations/src/model-provider/openai-compatible/index.ts:10 |
baseURL? |
string |
API base URL. Defaults to https://api.openai.com/v1. |
packages/integrations/src/model-provider/openai-compatible/index.ts:14 |
dangerouslyAllowBrowser? |
boolean |
Allows the OpenAI client to run in a browser. Defaults to false. |
packages/integrations/src/model-provider/openai-compatible/index.ts:33 |
maxTokens? |
number |
Maximum number of generated tokens. | packages/integrations/src/model-provider/openai-compatible/index.ts:20 |
model |
string |
Model name, for example gpt-4o-mini, qwen-plus or llama3.1. |
packages/integrations/src/model-provider/openai-compatible/index.ts:12 |
name? |
string |
Provider name used in errors and logs. Defaults to The model API. |
packages/integrations/src/model-provider/openai-compatible/index.ts:16 |
rawTools? |
DeepseekRawTool[] |
Tools given as { name, description, parameters } objects. When this list is not empty, it takes precedence over tools. |
packages/integrations/src/model-provider/openai-compatible/index.ts:29 |
systemPrompt? |
string |
System prompt added before every request. | packages/integrations/src/model-provider/openai-compatible/index.ts:24 |
temperature? |
number |
Sampling temperature. Defaults to 0.7. |
packages/integrations/src/model-provider/openai-compatible/index.ts:18 |
tools? |
unknown[] |
Tools in the OpenAI-compatible { type: 'function', function } format. |
packages/integrations/src/model-provider/openai-compatible/index.ts:31 |
topP? |
number |
Nucleus sampling probability. | packages/integrations/src/model-provider/openai-compatible/index.ts:22 |
verbose? |
boolean |
Logs API errors to the console. Defaults to false. |
packages/integrations/src/model-provider/openai-compatible/index.ts:35 |