Module: LLM::Contract::Completion Abstract

Extended by:
LLM::Contract
Defined in:
lib/llm/contract/completion.rb

Overview

This module is abstract.

Defines the interface all completion responses must implement

Constant Summary

Constants included from LLM::Contract

ContractError

Instance Method Summary collapse

Methods included from LLM::Contract

included

Instance Method Details

#model ⇒ String

Returns the model name

Returns:

  • (String) —

    Returns the model name

Raises:

  • (NotImplementedError)


75
76
77
 
# File 'lib/llm/contract/completion.rb', line 75

def model
  raise NotImplementedError, "#{self.class} does not implement '#{__method__}'"
end

#input_tokens ⇒ Integer

Returns the number of input tokens

Returns:

  • (Integer) —

    Returns the number of input tokens

Raises:

  • (NotImplementedError)


21
22
23
 
# File 'lib/llm/contract/completion.rb', line 21

def input_tokens
  raise NotImplementedError, "#{self.class} does not implement '#{__method__}'"
end

#output_tokens ⇒ Integer

Returns the number of output tokens

Returns:

  • (Integer) —

    Returns the number of output tokens

Raises:

  • (NotImplementedError)


28
29
30
 
# File 'lib/llm/contract/completion.rb', line 28

def output_tokens
  raise NotImplementedError, "#{self.class} does not implement '#{__method__}'"
end

#reasoning_tokens ⇒ Integer

Returns the number of reasoning tokens

Returns:

  • (Integer)

Raises:

  • (NotImplementedError)


35
36
37
 
# File 'lib/llm/contract/completion.rb', line 35

def reasoning_tokens
  raise NotImplementedError, "#{self.class} does not implement '#{__method__}'"
end

#total_tokens ⇒ Integer

Returns the total number of tokens

Returns:

  • (Integer) —

    Returns the total number of tokens

Raises:

  • (NotImplementedError)


42
43
44
 
# File 'lib/llm/contract/completion.rb', line 42

def total_tokens
  raise NotImplementedError, "#{self.class} does not implement '#{__method__}'"
end

#content ⇒ String

Returns the LLM response

Returns:

  • (String) —

    Returns the LLM response



49
50
51
 
# File 'lib/llm/contract/completion.rb', line 49

def content
  messages.find(&:assistant?).content
end

#content! ⇒ Hash

Returns the LLM response after parsing it as JSON

Returns:

  • (Hash) —

    Returns the LLM response after parsing it as JSON



56
57
58
 
# File 'lib/llm/contract/completion.rb', line 56

def content!
  LLM.json.load(content)
end

#usage ⇒ LLM::Usage

Returns usage information

Returns:



63
64
65
66
67
68
69
70
 
# File 'lib/llm/contract/completion.rb', line 63

def usage
  LLM::Usage.new(
    input_tokens:,
    output_tokens:,
    reasoning_tokens:,
    total_tokens:
  )
end

#messages ⇒ Array<LLM::Messsage> Also known as: choices

Returns one or more messages

Returns:

  • (Array<LLM::Messsage>) —

    Returns one or more messages

Raises:

  • (NotImplementedError)


13
14
15
 
# File 'lib/llm/contract/completion.rb', line 13

def messages
  raise NotImplementedError, "#{self.class} does not implement '#{__method__}'"
end