Module chat 

Structs

ChatChoice

ChatChoiceLogprobs

ChatChoiceStream

ChatCompletionAllowedTools

ChatCompletionAllowedToolsChoice

ChatCompletionAudio

ChatCompletionDeleted

Response when deleting a chat completion.

ChatCompletionFunctionsDeprecated

ChatCompletionFunctionsArgs

Builder for ChatCompletionFunctions.

ChatCompletionList

An object representing a list of Chat Completions.

ChatCompletionMessageCustomToolCall

ChatCompletionMessageList

An object representing a list of chat completion messages.

ChatCompletionMessageListItem

A chat completion message with additional fields for listing.

ChatCompletionMessageToolCall

ChatCompletionMessageToolCallChunk

ChatCompletionNamedToolChoice

Specifies a tool the model should use. Use to force the model to call a specific function.

ChatCompletionNamedToolChoiceCustom

ChatCompletionRequestAssistantMessage

ChatCompletionRequestAssistantMessageArgs

Builder for ChatCompletionRequestAssistantMessage.

ChatCompletionRequestAssistantMessageAudio

ChatCompletionRequestDeveloperMessage

ChatCompletionRequestDeveloperMessageArgs

Builder for ChatCompletionRequestDeveloperMessage.

ChatCompletionRequestFunctionMessage

ChatCompletionRequestFunctionMessageArgs

Builder for ChatCompletionRequestFunctionMessage.

ChatCompletionRequestMessageContentPartAudio

Learn about audio inputs.

ChatCompletionRequestMessageContentPartAudioArgs

Builder for ChatCompletionRequestMessageContentPartAudio.

ChatCompletionRequestMessageContentPartFile

ChatCompletionRequestMessageContentPartImage

ChatCompletionRequestMessageContentPartImageArgs

Builder for ChatCompletionRequestMessageContentPartImage.

ChatCompletionRequestMessageContentPartRefusal

ChatCompletionRequestMessageContentPartRefusalBuilder

Builder for ChatCompletionRequestMessageContentPartRefusal.

ChatCompletionRequestMessageContentPartText

ChatCompletionRequestMessageContentPartTextArgs

Builder for ChatCompletionRequestMessageContentPartText.

ChatCompletionRequestSystemMessage

ChatCompletionRequestSystemMessageArgs

Builder for ChatCompletionRequestSystemMessage.

ChatCompletionRequestToolMessage

Tool message

ChatCompletionRequestToolMessageArgs

Builder for ChatCompletionRequestToolMessage.

ChatCompletionRequestUserMessage

ChatCompletionRequestUserMessageArgs

Builder for ChatCompletionRequestUserMessage.

ChatCompletionResponseMessage

A chat completion message generated by the model.

ChatCompletionResponseMessageAudio

ChatCompletionStreamOptions

Options for streaming response. Only set this when you set stream: true.

ChatCompletionStreamResponseDelta

A chat completion delta generated by streamed model responses.

ChatCompletionTokenLogprob

ChatCompletionTool

Choice

CompletionTokensDetails

Breakdown of tokens used in a completion.

CompletionUsage

Usage statistics for the completion request.

CreateChatCompletionRequest

CreateChatCompletionRequestArgs

Builder for CreateChatCompletionRequest.

CreateChatCompletionResponse

Represents a chat completion response returned by model, based on the provided input.

CreateChatCompletionStreamResponse

Represents a streamed chunk of a chat completion response returned by the model, based on the provided input. Learn more.

CustomName

CustomTool

CustomToolChatCompletions

CustomToolProperties

FileObject

FunctionCall

The name and arguments of a function that should be called, as generated by the model.

FunctionCallStream

FunctionName

FunctionObject

FunctionObjectArgs

Builder for FunctionObject.

ImageUrl

ImageUrlArgs

Builder for ImageUrl.

InputAudio

Logprobs

PromptTokensDetails

Breakdown of tokens used in a completion.

ResponseFormatJsonSchema

TopLogprobs

UpdateChatCompletionRequest

Request to update a chat completion.

UpdateChatCompletionRequestArgs

Builder for UpdateChatCompletionRequest.

UrlCitation

WebSearchLocation

Approximate location parameters for the search.

WebSearchOptions

Options for the web search tool.

WebSearchUserLocation

Enums

ChatCompletionAudioFormat

ChatCompletionAudioVoice

ChatCompletionFunctionCall

ChatCompletionMessageToolCalls

ChatCompletionRequestAssistantMessageContent

ChatCompletionRequestAssistantMessageContentPart

ChatCompletionRequestDeveloperMessageContent

ChatCompletionRequestDeveloperMessageContentPart

ChatCompletionRequestMessage

ChatCompletionRequestMessageContentPartRefusalBuilderError

Error type for ChatCompletionRequestMessageContentPartRefusalBuilder

ChatCompletionRequestSystemMessageContent

ChatCompletionRequestSystemMessageContentPart

ChatCompletionRequestToolMessageContent

ChatCompletionRequestToolMessageContentPart

ChatCompletionRequestUserMessageContent

ChatCompletionRequestUserMessageContentPart

ChatCompletionResponseMessageAnnotation

ChatCompletionToolChoiceOption

Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

ChatCompletionTools

CompletionFinishReason

ContentPart

CustomToolPropertiesFormat

FinishReason

FunctionType

ImageDetail

InputAudioFormat

PredictionContent

Static predicted output content, such as the content of a text file that is being regenerated.

PredictionContentContent

The content that should be matched when generating a model response. If generated tokens would match this content, the entire model response can be returned much more quickly.

Prompt

ReasoningEffort

ResponseFormat

ResponseModalities

Output types that you would like the model to generate for this request.

Role

ServiceTier

StopConfiguration

ToolChoiceAllowedMode

ToolChoiceOptions

Verbosity

Constrains the verbosity of the model’s response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are low, medium, and high.

WebSearchContextSize

The amount of context window space to use for the search.

WebSearchUserLocationType

Type Aliases

ChatCompletionResponseStream

Parsed server side events stream until an [DONE] is received from server.