Interface OpenAiModelDescription

interface OpenAiModelDescription {
    apiKey: undefined | string | true;
    apiVersion: undefined | string | true;
    developerMessageSettings?: "user" | "system" | "developer" | "mergeWithFollowingUserMessage" | "skip";
    enableStreaming: boolean;
    id: string;
    model: string;
    supportsStructuredOutput: boolean;
    url?: string;
}

Properties

apiKey apiVersion developerMessageSettings? enableStreaming id model supportsStructuredOutput url?

Properties

apiKey

apiKey: undefined | string | true

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

apiVersion

apiVersion: undefined | string | true

The version for the api. If 'true' is provided the global OpenAI version will be used.

Optional developerMessageSettings

developerMessageSettings?: "user" | "system" | "developer" | "mergeWithFollowingUserMessage" | "skip"

Property to configure the developer message of the model. Setting this property to 'user', 'system', or 'developer' will use that string as the role for the system message. Setting it to 'mergeWithFollowingUserMessage' will prefix the following user message with the system message or convert the system message to user if the following message is not a user message. 'skip' will remove the system message altogether. Defaults to 'developer'.

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.

supportsStructuredOutput

supportsStructuredOutput: boolean

Flag to configure whether the OpenAPI model supports structured output. Default is true.

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

apiKeyapiVersiondeveloperMessageSettingsenableStreamingidmodelsupportsStructuredOutputurl