Expand description
OpenAI model provider plugin for elizaOS.
This crate provides:
- A typed OpenAI HTTP client (
OpenAIClient) - Convenience wrappers (
OpenAIPlugin) - A helper to construct an elizaOS plugin definition
Re-exports§
pub use audio::detect_audio_mime_type;pub use audio::get_filename_for_data;pub use audio::AudioMimeType;pub use client::OpenAIClient;pub use error::OpenAIError;pub use error::Result;pub use tokenization::count_tokens;pub use tokenization::detokenize;pub use tokenization::tokenize;pub use tokenization::truncate_to_token_limit;pub use types::ChatCompletionChoice;pub use types::ChatCompletionResponse;pub use types::ChatMessage;pub use types::EmbeddingData;pub use types::EmbeddingParams;pub use types::EmbeddingResponse;pub use types::ImageData;pub use types::ImageDescriptionParams;pub use types::ImageDescriptionResult;pub use types::ImageGenerationParams;pub use types::ImageGenerationResponse;pub use types::ImageGenerationResult;pub use types::ImageQuality;pub use types::ImageSize;pub use types::ImageStyle;pub use types::ModelInfo;pub use types::ModelsResponse;pub use types::OpenAIConfig;pub use types::ResearchAnnotation;pub use types::ResearchParams;pub use types::ResearchResult;pub use types::ResponsesApiError;pub use types::ResponsesApiResponse;pub use types::TTSOutputFormat;pub use types::TTSVoice;pub use types::TextGenerationParams;pub use types::TextToSpeechParams;pub use types::TranscriptionParams;pub use types::TranscriptionResponse;pub use types::TranscriptionResponseFormat;
Modules§
- audio
- Audio helpers and endpoints.
- client
- OpenAI API client implementation.
- error
- Error types and result aliases.
- tokenization
- Tokenization helpers.
- types
- Typed request/response models.
Structs§
- OpenAI
Plugin - High-level OpenAI plugin wrapper around an
OpenAIClient.
Functions§
- create_
openai_ elizaos_ plugin - Create an elizaOS
elizaos::types::Pluginwired to OpenAI model handlers. - get_
openai_ plugin - Construct an
OpenAIPluginfrom environment variables.