Class: OpenAI::Resources::Evals::Runs::OutputItems

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/evals/runs/output_items.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ OutputItems

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of OutputItems.

Parameters:



84
85
86
 
# File 'lib/openai/resources/evals/runs/output_items.rb', line 84

def initialize(client:)
  @client = client
end

Instance Method Details

#list(run_id, eval_id: , after: nil, limit: nil, order: nil, status: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Evals::Runs::OutputItemListResponse>

Some parameter documentations has been truncated, see Models::Evals::Runs::OutputItemListParams for more details.

Get a list of output items for an evaluation run.

Parameters:

  • run_id (String) —

    Path param: The ID of the run to retrieve output items for.

  • eval_id (String) —

    Path param: The ID of the evaluation to retrieve runs for.

  • after (String) —

    Query param: Identifier for the last output item from the previous pagination re

  • limit (Integer) —

    Query param: Number of output items to retrieve.

  • order (Symbol, OpenAI::Models::Evals::Runs::OutputItemListParams::Order) —

    Query param: Sort order for output items by timestamp. Use ‘asc` for ascending o

  • status (Symbol, OpenAI::Models::Evals::Runs::OutputItemListParams::Status) —

    Query param: Filter output items by status. Use ‘failed` to filter by failed out

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/openai/resources/evals/runs/output_items.rb', line 65

def list(run_id, params)
  parsed, options = OpenAI::Evals::Runs::OutputItemListParams.dump_request(params)
  eval_id =
    parsed.delete(:eval_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["evals/%1$s/runs/%2$s/output_items", eval_id, run_id],
    query: parsed,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Models::Evals::Runs::OutputItemListResponse,
    options: options
  )
end

#retrieve(output_item_id, eval_id: , run_id: , request_options: {}) ⇒ OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse

Get an evaluation run output item by ID.

Parameters:

  • output_item_id (String) —

    The ID of the output item to retrieve.

  • eval_id (String) —

    The ID of the evaluation to retrieve runs for.

  • run_id (String) —

    The ID of the run to retrieve.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/openai/resources/evals/runs/output_items.rb', line 23

def retrieve(output_item_id, params)
  parsed, options = OpenAI::Evals::Runs::OutputItemRetrieveParams.dump_request(params)
  eval_id =
    parsed.delete(:eval_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  run_id =
    parsed.delete(:run_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["evals/%1$s/runs/%2$s/output_items/%3$s", eval_id, run_id, output_item_id],
    model: OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse,
    options: options
  )
end