Module: GroqRuby

Defined in:
lib/groq_ruby.rb,
lib/groq_ruby/mcp.rb,
lib/groq_ruby/client.rb,
lib/groq_ruby/request.rb,
lib/groq_ruby/version.rb,
lib/groq_ruby/mcp/tool.rb,
lib/groq_ruby/response.rb,
lib/groq_ruby/multipart.rb,
lib/groq_ruby/transport.rb,
lib/groq_ruby/mcp/bridge.rb,
lib/groq_ruby/mcp/client.rb,
lib/groq_ruby/mcp/prompt.rb,
lib/groq_ruby/error_mapper.rb,
lib/groq_ruby/errors/error.rb,
lib/groq_ruby/mcp/json_rpc.rb,
lib/groq_ruby/mcp/resource.rb,
lib/groq_ruby/models/model.rb,
lib/groq_ruby/models/usage.rb,
lib/groq_ruby/configuration.rb,
lib/groq_ruby/mcp/transport.rb,
lib/groq_ruby/resources/base.rb,
lib/groq_ruby/resources/chat.rb,
lib/groq_ruby/resources/audio.rb,
lib/groq_ruby/resources/files.rb,
lib/groq_ruby/errors/api_error.rb,
lib/groq_ruby/mcp/errors/error.rb,
lib/groq_ruby/resources/models.rb,
lib/groq_ruby/mcp/server_config.rb,
lib/groq_ruby/models/model_list.rb,
lib/groq_ruby/resources/batches.rb,
lib/groq_ruby/mcp/transports/stdio.rb,
lib/groq_ruby/models/batches/batch.rb,
lib/groq_ruby/models/model_deleted.rb,
lib/groq_ruby/models/model_factory.rb,
lib/groq_ruby/resources/embeddings.rb,
lib/groq_ruby/errors/conflict_error.rb,
lib/groq_ruby/errors/not_found_error.rb,
lib/groq_ruby/errors/parameter_error.rb,
lib/groq_ruby/models/files/file_list.rb,
lib/groq_ruby/resources/audio/speech.rb,
lib/groq_ruby/streaming/chunk_stream.rb,
lib/groq_ruby/streaming/event_parser.rb,
lib/groq_ruby/errors/api_status_error.rb,
lib/groq_ruby/errors/rate_limit_error.rb,
lib/groq_ruby/errors/api_timeout_error.rb,
lib/groq_ruby/errors/bad_request_error.rb,
lib/groq_ruby/mcp/errors/timeout_error.rb,
lib/groq_ruby/models/audio/translation.rb,
lib/groq_ruby/models/files/file_object.rb,
lib/groq_ruby/errors/api_response_error.rb,
lib/groq_ruby/mcp/claude_desktop_config.rb,
lib/groq_ruby/mcp/errors/json_rpc_error.rb,
lib/groq_ruby/mcp/errors/protocol_error.rb,
lib/groq_ruby/models/batches/batch_list.rb,
lib/groq_ruby/models/files/file_deleted.rb,
lib/groq_ruby/errors/configuration_error.rb,
lib/groq_ruby/mcp/errors/transport_error.rb,
lib/groq_ruby/models/audio/transcription.rb,
lib/groq_ruby/resources/chat/completions.rb,
lib/groq_ruby/errors/api_connection_error.rb,
lib/groq_ruby/errors/authentication_error.rb,
lib/groq_ruby/models/chat/chat_completion.rb,
lib/groq_ruby/models/embeddings/embedding.rb,
lib/groq_ruby/errors/internal_server_error.rb,
lib/groq_ruby/resources/audio/translations.rb,
lib/groq_ruby/mcp/errors/unknown_tool_error.rb,
lib/groq_ruby/errors/permission_denied_error.rb,
lib/groq_ruby/resources/audio/transcriptions.rb,
lib/groq_ruby/errors/unprocessable_entity_error.rb,
lib/groq_ruby/models/chat/chat_completion_chunk.rb,
lib/groq_ruby/models/chat/chat_completion_delta.rb,
lib/groq_ruby/models/embeddings/embedding_usage.rb,
lib/groq_ruby/models/chat/chat_completion_choice.rb,
lib/groq_ruby/models/batches/batch_request_counts.rb,
lib/groq_ruby/models/chat/chat_completion_message.rb,
lib/groq_ruby/models/chat/chat_completion_chunk_choice.rb,
lib/groq_ruby/models/embeddings/create_embedding_response.rb

Overview

Idiomatic Ruby client for the Groq API. See Client for the main entry point and the ‘examples/` directory for end-to-end snippets.

Defined Under Namespace

Modules: MCP, Models, Resources, Streaming Classes: APIConnectionError, APIError, APIResponseError, APIStatusError, APITimeoutError, AuthenticationError, BadRequestError, Client, Configuration, ConfigurationError, ConflictError, Error, ErrorMapper, InternalServerError, Multipart, NotFoundError, ParameterError, PermissionDeniedError, RateLimitError, Request, Response, Transport, UnprocessableEntityError

Constant Summary collapse

VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.client(**opts) ⇒ Client

Convenience constructor — ‘GroqRuby.client` reads configuration from the `GROQ_API_KEY` and `GROQ_BASE_URL` env vars by default.

Returns:



33
34
35
 
# File 'lib/groq_ruby.rb', line 33

def self.client(**opts)
  Client.new(**opts)
end