# Functions
NewMessageItem creates a new MessageItem with default values.
NewOutputItem creates a new OutputItem with default values.
NewResponse creates a new Response with default values.
# Constants
ItemStatusCompleted indicates the item has been fully processed.
ItemStatusIncomplete indicates the item is incomplete.
ItemStatusInProgress indicates the item is still being processed Deprecated: Used only in tests, not in the API.
MessageContentTypeAudio represents audio content Note: This is not in the official API specs, but is used internally.
MessageContentTypeInputAudio represents audio input from the user.
MessageContentTypeInputText represents text input from the user.
MessageContentTypeItemReference represents a reference to another item.
MessageContentTypeText represents plain text content from the assistant.
MessageContentTypeTranscript represents a transcript of audio content Note: This is not in the official API specs, but is used internally.
MessageItemTypeFunctionCall represents a function call.
MessageItemTypeFunctionCallOutput represents a function call output.
MessageItemTypeFunctionResponse is an alias for MessageItemTypeFunctionCallOutput Deprecated: Use MessageItemTypeFunctionCallOutput instead.
MessageItemTypeMessage represents a standard message.
MessageRoleAssistant represents a message from the assistant.
MessageRoleSystem represents a system message.
MessageRoleUser represents a message from the user.
ResponseErrorTypeCancelled indicates the response was cancelled.
ResponseErrorTypeCompleted indicates the response completed successfully.
ResponseErrorTypeFailed indicates the response failed.
ResponseErrorTypeIncomplete indicates the response was incomplete.
ResponseStatusCancelled indicates the response generation was cancelled.
ResponseStatusCompleted indicates the response has been fully generated.
ResponseStatusFailed indicates the response generation failed.
ResponseStatusIncomplete indicates the response generation was truncated.
ResponseStatusInProgress indicates the response is still being generated.
TranscriptionModelWhisper1 is the Whisper v1 model.
# Structs
Conversation represents a complete conversation.
ConversationItem represents an item in a conversation.
InputAudioTranscription contains options for audio transcription.
InputTokenDetails contains information about input token usage.
Message represents a complete message to be sent.
MessageContentPart represents a single part of a message's content.
MessageItem represents an item in a message.
OutputItem represents an item generated in a response.
RateLimit contains information about API rate limits.
Response represents a complete response from the API.
ResponseConfig contains configuration options for generating a response.
ResponseError describes an error that caused a response to fail.
ResponseMessageItem extends MessageItem with additional response-specific fields.
ResponseStatusDetails provides additional information about the response status.
TokenDetails contains information about token usage.
Usage contains information about token usage.
# Type aliases
CachedTokensDetails is an alias for TokenDetails.
ItemStatus represents the status of an item.
MessageContentType represents the type of content in a message.
MessageItemType represents the type of a message item.
MessageOption is a function that configures a Message.
MessageRole represents the role of a message participant.
OutputTokenDetails is an alias for TokenDetails.
ResponseErrorType represents the type of error in a response status.
ResponseStatus represents the status of a response.
TranscriptionModel specifies which model to use for transcription.