Skip to main content

Module openai

Module openai 

Source
Expand description

OpenAI API compatibility types

This module defines types that match the OpenAI API specification for chat completions, completions, and model management.

Structs§

ChatChoice
Chat choice
ChatCompletionsRequest
Chat completions request (OpenAI compatible)
ChatCompletionsResponse
Chat completions response
ChatMessage
Chat message
CompletionChoice
Completion choice
CompletionsRequest
Legacy completions request
CompletionsResponse
Completions response
EmbeddingData
Single embedding result
EmbeddingItem
A single embedding input item — text or image.
EmbeddingUsage
Token usage for embeddings
EmbeddingsRequest
Embeddings request (OpenAI-compatible, extended for images)
EmbeddingsResponse
Embeddings response (OpenAI-compatible)
ModelInfo
Model information
ModelListResponse
Model list response
ModelPermission
Model permission
OpenAiError
OpenAI API error
OpenAiErrorDetail
OpenAI error detail
OpenAiResponseFormat
OpenAI-compatible response format specifier.
SseEvent
Server-sent event for streaming
TranscriptionResponse
Transcription response (OpenAI-compatible)
Usage
Token usage information

Enums§

EmbeddingInput
Polymorphic embedding input. Supports: single string, array of strings, single object, array of objects.
MessageRole
Message roles
OpenAiErrorType
OpenAI error types