Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/openai / OpenAiAdapterOptions

Interface: OpenAiAdapterOptions

Defined in: packages/openai/src/adapter.ts:54

Properties

PropertyTypeDescriptionDefined in
apiKey?stringShorthand for sdkOptions.apiKey; setting both is a ConfigError.packages/openai/src/adapter.ts:56
baseURL?stringShorthand for sdkOptions.baseURL; setting both is a ConfigError.packages/openai/src/adapter.ts:58
client?| OpenAiClientLike | OpenAIA preconstructed client instead of the construction options above (combining them is a ConfigError): the official OpenAI instance (production; it must be constructed with maxRetries: 0) or a structural OpenAiClientLike mock (tests).packages/openai/src/adapter.ts:67
sdkOptions?OpenAiSdkOptionsOfficial SDK construction options; see OpenAiSdkOptions.packages/openai/src/adapter.ts:60