Expand description
Own namespace of the module.
Structs§
- Audio
Response Format - Represents audio response format options.
- Chat
Completion Stream Options - Represents options for streaming chat completions.
- Completion
Tokens Details - Detailed breakdown of completion tokens.
- Completion
Usage - Represents usage statistics for completions, including token details.
- Coordinate
- Represents a 2D coordinate (x, y).
- Default
Project Error Response - Represents the structure for a default project error response.
- Delete
Assistant Response - Represents the structure for a deleted assistant confirmation.
- Delete
File Response - Represents the structure for a deleted file confirmation.
- Delete
Fine Tuning Checkpoint Permission Response - Represents the structure for a deleted fine-tuning checkpoint permission confirmation.
- Delete
Message Response - Represents the structure for a deleted message confirmation.
- Delete
Model Response - Represents the structure for a deleted model confirmation.
- Delete
Response - Represents the structure for a deleted response confirmation.
- Delete
Thread Response - Represents the structure for a deleted thread confirmation.
- Delete
Vector Store File Response - Represents the structure for a deleted vector store file confirmation.
- Delete
Vector Store Response - Represents the structure for a deleted vector store confirmation.
- Error
- Represents a generic API error structure, used in top-level error responses.
- Error
Response - Represents a generic error response wrapper containing an
Errorobject. - Includable
- Represents includable fields in Responses API calls.
- Invite
Delete Response - Represents the structure for a deleted invite confirmation.
- List
Query - Represents query parameters for listing operations, specifically for pagination.
- LogProb
- Represents log probability information, including top alternative tokens.
- LogProb
Properties - Represents log probability properties for a token.
- Metadata
- Represents metadata as key-value pairs, allowing attachment of custom information.
- Model
IdsResponses - Represents model identifiers specific to the Responses API.
- Model
IdsShared - Represents model identifiers shared across multiple API endpoints.
- Model
Response Properties - Represents the properties common to model responses across different APIs.
- Parallel
Tool Calls - Represents parallel tool call settings.
- Project
ApiKey Delete Response - Represents the structure for a deleted project API key confirmation.
- Project
Delete Response - Represents the structure for a deleted project confirmation (Note : Projects are archived, not deleted). This might represent the response from an archive operation.
- Project
Service Account Delete Response - Represents the structure for a deleted project service account confirmation.
- Project
User Delete Response - Represents the structure for a deleted project user confirmation.
- Prompt
Tokens Details - Detailed breakdown of prompt tokens.
- Reasoning
- Represents the reasoning configuration for o-series models.
- Reasoning
Effort - Represents reasoning effort options for o-series models.
- Response
Error - Represents an error object returned in specific contexts, like
last_error. - Response
Format Json Object - Represents the JSON object response format configuration.
- Response
Format Json Schema - Represents the JSON schema response format configuration.
- Response
Format Json Schema Schema - Represents the JSON schema object used within
ResponseFormatJsonSchema. - Response
Format Json Schema Schema Details - Details for the JSON schema response format.
- Response
Properties - Represents the properties specific to the main Response object.
- Response
Usage - Represents token usage statistics for a completed response.
- Text
Response Format Configuration - Configuration for the text response format.
- Transcription
Include - Represents options for including additional data in transcription responses.
- User
Delete Response - Represents the structure for a deleted user confirmation.
- Vector
Store File Attributes - Represents attributes for a vector store file.
- Voice
IdsShared - Represents voice options for text-to-speech generation.
Enums§
- Model
Ids - Represents all possible model identifiers, handling different enum subsets.
- Stop
Configuration - Represents stop sequence configuration for completions.
- Text
Response Format Configuration Options - Represents the overall text response format configuration options.