Class OpenAiModel

constructor

• new OpenAiModel(
      id: string,
      model: string,
      status: LanguageModelStatus,
      enableStreaming: boolean,
      apiKey: () => undefined | string,
      apiVersion: () => undefined | string,
      supportsStructuredOutput: boolean,
      url: undefined | string,
      deployment: undefined | string,
      openAiModelUtils: OpenAiModelUtils,
      responseApiUtils: OpenAiResponseApiUtils,
      developerMessageSettings?: DeveloperMessageSettings,
      maxRetries?: number,
      useResponseApi?: boolean,
      proxy?: string,
      reasoningSupport?: ReasoningSupport,
  ): 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

  • status: LanguageModelStatus
  • 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

  • apiVersion: () => undefined | string

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

  • 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.

  • deployment: undefined | string
  • openAiModelUtils: OpenAiModelUtils
  • responseApiUtils: OpenAiResponseApiUtils
  • developerMessageSettings: DeveloperMessageSettings = 'developer'

    how to handle system messages

  • maxRetries: number = 3

    the maximum number of retry attempts when a request fails

  • useResponseApi: boolean = false

    whether to use the newer OpenAI Response API instead of the Chat Completion API

  • Optionalproxy: string
  • OptionalreasoningSupport: ReasoningSupport

  Returns OpenAiModel

apiKey

apiVersion

deployment

developerMessageSettings

enableStreaming

Readonlyid

maxRetries

model

openAiModelUtils

Optionalproxy

OptionalreasoningSupport

responseApiUtils

status

supportsStructuredOutput

url

useResponseApi

request

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

  Parameters

  • request: UserRequest
  • OptionalcancellationToken: CancellationToken

  Returns Promise<LanguageModelResponse>