Interface OpenAiModelDescription

interface OpenAiModelDescription {
    apiKey: undefined | string | true;
    defaultRequestSettings?: {
        [key: string]: unknown;
    };
    enableStreaming: boolean;
    id: string;
    model: string;
    url?: string;
}

Properties

apiKey defaultRequestSettings? enableStreaming id model url?

Properties

apiKey

apiKey: undefined | string | true

The key for the model. If 'true' is provided the global OpenAI API key will be used.

Optional defaultRequestSettings

defaultRequestSettings?: {
    [key: string]: unknown;
}

Default request settings for the OpenAI model.

Type declaration

  • [key: string]: unknown

enableStreaming

enableStreaming: boolean

Indicate whether the streaming API shall be used.

id

id: string

The identifier of the model which will be shown in the UI.

model

model: string

The model ID as used by the OpenAI API.

Optional url

url?: string

The OpenAI API compatible endpoint where the model is hosted. If not provided the default OpenAI endpoint will be used.

Settings

Member Visibility

Theme

On This Page

apiKeydefaultRequestSettingsenableStreamingidmodelurl