Method: OmniAI::OpenAI::Client#chat

Defined in:
lib/omniai/openai/client.rb

#chat(prompt = nil, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil, tools: nil) {|prompt| ... } ⇒ OmniAI::Chat::Completion

Parameters:

  • prompt (String, OmniAI::Chat::Prompt, nil) (defaults to: nil) —

    optional

  • model (String, nil) (defaults to: Chat::DEFAULT_MODEL) —

    optional

  • format (Symbol, OmniAI::Schema::Format, nil) (defaults to: nil) —

    optional (e.g. ‘:text`, `:json`, `OmniAI::Schema.format(…)`)

  • temperature (Float, nil) (defaults to: nil) —

    optional

  • stream (Proc, nil) (defaults to: nil) —

    optional

  • tools (Array<OmniAI::Tool>, nil) (defaults to: nil) —

    optional

Yields:

  • (prompt)

Yield Parameters:

  • prompt (OmniAI::Chat::Prompt)

Returns:

  • (OmniAI::Chat::Completion)

Raises:

  • (OmniAI::Error) 


85
86
87
 
# File 'lib/omniai/openai/client.rb', line 85

def chat(prompt = nil, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil, tools: nil, **, &)
  Chat.process!(prompt, model:, temperature:, format:, stream:, tools:, client: self, **, &)
end