Class: HermesAgent::Client::Entities::ChatChoice

Inherits:
HermesAgent::Client::Entity show all
Defined in:
lib/hermes_agent/client/entities/chat_completion.rb

Overview

One choice in a chat completion (one entry of HermesAgent::Client::Entities::ChatCompletion#choices).

Instance Method Summary collapse

Methods inherited from HermesAgent::Client::Entity

#==, #[], #eql?, #hash, #to_h

Instance Method Details

#finish_reason ⇒ String?

Why generation stopped, e.g. "stop".

Returns:

  • (String, nil) 


78
79
80
 
# File 'lib/hermes_agent/client/entities/chat_completion.rb', line 78

def finish_reason
  self["finish_reason"]
end

#index ⇒ Integer?

The position of this choice in the list.

Returns:

  • (Integer, nil) 


70
71
72
 
# File 'lib/hermes_agent/client/entities/chat_completion.rb', line 70

def index
  self["index"]
end

#message ⇒ ChatMessage?

The generated message, wrapped in a HermesAgent::Client::Entities::ChatMessage. Returns nil when the field is absent.

Returns:



87
88
89
90
 
# File 'lib/hermes_agent/client/entities/chat_completion.rb', line 87

def message
  raw = self["message"]
  raw.is_a?(::Hash) ? ChatMessage.new(raw) : nil
end