OpenAIProvider
Generated by TypeDoc. Do not edit this page directly.
Class: OpenAIProvider
Section titled “Class: OpenAIProvider”Defined in: packages/provider-openai/src/index.ts:35
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OpenAIProvider(input?): OpenAIProvider;Defined in: packages/provider-openai/src/index.ts:38
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | ObjectOutput |
Returns
Section titled “Returns”OpenAIProvider
Overrides
Section titled “Overrides”AiSdkModelProvider.constructor
Properties
Section titled “Properties”| Property | Modifier | Type | Default value | Inherited from | Defined in |
|---|---|---|---|---|---|
configSchema | readonly | ObjectSchema<{ apiKey: OptionalSchema<unknown, string | undefined>; apiKeyEnv: OptionalSchema<unknown, string | undefined>; baseURL: OptionalSchema<unknown, string | undefined>; headers: OptionalSchema<Record<string, unknown> | undefined, Record<string, string> | undefined>; id: OptionalSchema<unknown, string | undefined>; models: OptionalSchema< | ObjectInput<{ id: StringSchema; label: OptionalSchema<unknown, string | undefined>; metadata: OptionalSchema<unknown, unknown>; provider: OptionalSchema<unknown, string | undefined>; }>[] | undefined, | ObjectOutput<{ id: StringSchema; label: OptionalSchema<unknown, string | undefined>; metadata: OptionalSchema<unknown, unknown>; provider: OptionalSchema<unknown, string | undefined>; }>[] | undefined>; }> | openAIProviderConfigSchema | - | packages/provider-openai/src/index.ts:36 |
id? | readonly | string | undefined | AiSdkModelProvider.id | packages/provider-ai-sdk/src/index.ts:9 |
namespace | readonly | string | undefined | AiSdkModelProvider.namespace | packages/provider-ai-sdk/src/index.ts:8 |
Methods
Section titled “Methods”getInfo()
Section titled “getInfo()”getInfo(): ModelProviderInfo;Defined in: packages/provider-ai-sdk/src/index.ts:20
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”getModels()
Section titled “getModels()”getModels(): ModelInfo[];Defined in: packages/provider-ai-sdk/src/index.ts:28
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”run(input): Promise<ModelProviderRunResult>;Defined in: packages/provider-ai-sdk/src/index.ts:36
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | ModelProviderRunInput |
Returns
Section titled “Returns”Promise<ModelProviderRunResult>
Inherited from
Section titled “Inherited from”supportsRole()
Section titled “supportsRole()”supportsRole(roleId): boolean;Defined in: packages/provider-ai-sdk/src/index.ts:32
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
roleId | string |
Returns
Section titled “Returns”boolean