Class OpenAiModel

constructor

• new OpenAiModel(id, model, enableStreaming, apiKey, apiVersion, supportsStructuredOutput, url, openAiModelUtils, developerMessageSettings?, tokenUsageService?): OpenAiModel

• Parameters

  • id: string

    the unique id for this language model. It will be used to identify the model in the UI.
  • model: string

    the model id as it is used by the OpenAI API
  • enableStreaming: boolean

    whether the streaming API shall be used
  • apiKey: (() => undefined | string)

    a function that returns the API key to use for this model, called on each request

    • • (): undefined | string

      • Returns undefined | string

  • apiVersion: (() => undefined | string)

    a function that returns the OpenAPI version to use for this model, called on each request

    • • (): undefined | string

      • Returns undefined | string

  • supportsStructuredOutput: boolean
  • url: undefined | string

    the OpenAI API compatible endpoint where the model is hosted. If not provided the default OpenAI endpoint will be used.
  • openAiModelUtils: OpenAiModelUtils
  • developerMessageSettings: DeveloperMessageSettings = 'developer'

    how to handle system messages
  • Optional tokenUsageService: TokenUsageService

  Returns OpenAiModel

apiKey

apiVersion

developerMessageSettings

enableStreaming

Readonly id

model

openAiModelUtils

supportsStructuredOutput

url

request

• request(request, cancellationToken?): Promise<LanguageModelResponse>

• Parameters

  • request: UserRequest
  • Optional cancellationToken: CancellationToken

  Returns Promise<LanguageModelResponse>