Interface ChatOpenAICallOptions

Hierarchy

Properties

callbacks?: Callbacks

Callbacks for this call and any sub-calls (eg. a Chain calling an LLM). Tags are passed to all callbacks, metadata is passed to handle*Start callbacks.

function_call?: ChatCompletionFunctionCallOption
functions?: Function[]
metadata?: Record<string, unknown>

Metadata for this call and any sub-calls (eg. a Chain calling an LLM). Keys should be strings, values should be JSON-serializable.

options?: OpenAICoreRequestOptions<Record<string, unknown>>

Additional options to pass to the underlying axios request.

promptIndex?: number
response_format?: {
    type: "json_object";
}

Type declaration

  • type: "json_object"
runName?: string

Name for the tracer run for this call. Defaults to the name of the class.

seed?: number
signal?: AbortSignal

Abort signal for this call. If provided, the call will be aborted when the signal is aborted.

stop?: string[]

Stop tokens to use for this call. If not provided, the default stop tokens for the model will be used.

tags?: string[]

Tags for this call and any sub-calls (eg. a Chain calling an LLM). You can use these to filter calls.

timeout?: number

Timeout for this call in milliseconds.

tool_choice?: ChatCompletionToolChoiceOption
tools?: StructuredTool<ZodObject<any, any, any, any, {}>>[] | ChatCompletionTool[]

Generated using TypeDoc