Class: RubyLLM::Protocols::ChatCompletions

Inherits:

RubyLLM::Protocol

• Object
• RubyLLM::Protocol
• RubyLLM::Protocols::ChatCompletions

Includes:

ChatCompletions::Chat, ChatCompletions::Embeddings, ChatCompletions::Images, ChatCompletions::Media, ChatCompletions::Models, ChatCompletions::Moderation, ChatCompletions::Speech, ChatCompletions::Streaming, ChatCompletions::Tools, ChatCompletions::Transcription

Defined in:

lib/ruby_llm/protocols/chat_completions.rb,
lib/ruby_llm/protocols/chat_completions/chat.rb,
lib/ruby_llm/protocols/chat_completions/media.rb,
lib/ruby_llm/protocols/chat_completions/tools.rb,
lib/ruby_llm/protocols/chat_completions/images.rb,
lib/ruby_llm/protocols/chat_completions/models.rb,
lib/ruby_llm/protocols/chat_completions/rerank.rb,
lib/ruby_llm/protocols/chat_completions/speech.rb,
lib/ruby_llm/protocols/chat_completions/batches.rb,
lib/ruby_llm/protocols/chat_completions/streaming.rb,
lib/ruby_llm/protocols/chat_completions/embeddings.rb,
lib/ruby_llm/protocols/chat_completions/moderation.rb,
lib/ruby_llm/protocols/chat_completions/transcription.rb,
lib/ruby_llm/protocols/chat_completions/embedding_batches.rb

Overview

The OpenAI Chat Completions API — the lingua franca of LLM APIs.

Direct Known Subclasses

Mistral::Conversations, Perplexity::Router, Responses, RubyLLM::Providers::Azure::ChatCompletions, RubyLLM::Providers::Bedrock::Mantle::ChatCompletions, RubyLLM::Providers::DeepSeek::ChatCompletions, RubyLLM::Providers::GPUStack::ChatCompletions, RubyLLM::Providers::Mistral::ChatCompletions, RubyLLM::Providers::Ollama::ChatCompletions, RubyLLM::Providers::OpenRouter::ChatCompletions, RubyLLM::Providers::Perplexity::ChatCompletions, RubyLLM::Providers::VertexAI::ChatCompletions, RubyLLM::Providers::VertexAI::Mistral, RubyLLM::Providers::XAI::ChatCompletions

Defined Under Namespace

Modules: Batches, Chat, EmbeddingBatches, Embeddings, Images, Media, Models, Moderation, Rerank, Speech, Streaming, Tools, Transcription

Instance Attribute Summary

Attributes inherited from RubyLLM::Protocol

#config, #connection, #model, #provider

Method Summary

Methods inherited from RubyLLM::Protocol

abstract, #animate_later, #apply_compaction, #apply_compaction_headers, #apply_end_user, #cache_content, #compact, #complete, #count_tokens, #delete_cache, #embed, #extend_cache, #find_cache, #initialize, #list_models, #moderate, #ocr, #paint, #parse_error, #parse_image_responses, #post_image, #post_video, #preprocess_message, #raise_transcription_streaming_unsupported, #refresh_video_job, #render, #render_embedding, #render_transcription_options, #render_video_extension_payload, #rerank, #server_tool_aliases, #speak, #stream_speech, #stream_speech_response, #stream_transcription, #supports_embedding_media?, #tokenize, #tool_approval_response, #transcribe, #video_extension_attachment, #video_extension_url, #video_request_url

Methods included from RubyLLM::Protocol::BinaryStreaming

#stream_binary

Methods included from RubyLLM::Protocol::Streaming

build_on_data_handler, build_stream_error_response, error_chunk?, failed_http_status, faraday_1?, handle_data, handle_error_chunk, handle_error_event, handle_failed_response, handle_json_error_chunk, handle_sse, handle_stream, json_error_payload?, parse_error_from_json, parse_streaming_error, process_stream_chunk, raise_stream_error, stream_events, stream_response, stream_state

Constructor Details

This class inherits a constructor from RubyLLM::Protocol