Class: Openlayer::Resources::InferencePipelines

Inherits:
Object
  • Object
show all
Defined in:
lib/openlayer/resources/inference_pipelines.rb,
lib/openlayer/resources/inference_pipelines/data.rb,
lib/openlayer/resources/inference_pipelines/rows.rb,
lib/openlayer/resources/inference_pipelines/test_results.rb

Defined Under Namespace

Classes: Data, Rows, TestResults

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InferencePipelines

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 InferencePipelines.

Parameters:



197
198
199
200
201
202
 
# File 'lib/openlayer/resources/inference_pipelines.rb', line 197

def initialize(client:)
  @client = client
  @data = Openlayer::Resources::InferencePipelines::Data.new(client: client)
  @rows = Openlayer::Resources::InferencePipelines::Rows.new(client: client)
  @test_results = Openlayer::Resources::InferencePipelines::TestResults.new(client: client)
end

Instance Attribute Details

#data ⇒ Openlayer::Resources::InferencePipelines::Data (readonly)

Returns:



7
8
9
 
# File 'lib/openlayer/resources/inference_pipelines.rb', line 7

def data
  @data
end

#rows ⇒ Openlayer::Resources::InferencePipelines::Rows (readonly)

Returns:



10
11
12
 
# File 'lib/openlayer/resources/inference_pipelines.rb', line 10

def rows
  @rows
end

#test_results ⇒ Openlayer::Resources::InferencePipelines::TestResults (readonly)

Returns:



13
14
15
 
# File 'lib/openlayer/resources/inference_pipelines.rb', line 13

def test_results
  @test_results
end

Instance Method Details

#delete(inference_pipeline_id, request_options: {}) ⇒ nil

Delete inference pipeline.

Parameters:

  • inference_pipeline_id (String) —

    The inference pipeline id (a UUID).

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

Returns:

  • (nil)

See Also:



82
83
84
85
86
87
88
89
 
# File 'lib/openlayer/resources/inference_pipelines.rb', line 82

def delete(inference_pipeline_id, params = {})
  @client.request(
    method: :delete,
    path: ["inference-pipelines/%1$s", inference_pipeline_id],
    model: NilClass,
    options: params[:request_options]
  )
end

#retrieve(inference_pipeline_id, expand: nil, request_options: {}) ⇒ Openlayer::Models::InferencePipelineRetrieveResponse

Retrieve inference pipeline.

Parameters:

Returns:

See Also:



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/openlayer/resources/inference_pipelines.rb', line 28

def retrieve(inference_pipeline_id, params = {})
  parsed, options = Openlayer::InferencePipelineRetrieveParams.dump_request(params)
  query = Openlayer::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["inference-pipelines/%1$s", inference_pipeline_id],
    query: query,
    model: Openlayer::Models::InferencePipelineRetrieveResponse,
    options: options
  )
end

#retrieve_sessions(inference_pipeline_id, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {}) ⇒ Openlayer::Models::InferencePipelineRetrieveSessionsResponse

Get aggregated session data for an inference pipeline with pagination and metadata.

Returns a list of sessions for the inference pipeline, including activity statistics such as record counts, token usage, cost, latency, and the first and last records.

Parameters:

Returns:

See Also:



129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/openlayer/resources/inference_pipelines.rb', line 129

def retrieve_sessions(inference_pipeline_id, params = {})
  query_params = [:asc, :page, :per_page, :sort_column]
  parsed, options = Openlayer::InferencePipelineRetrieveSessionsParams.dump_request(params)
  query = Openlayer::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: ["inference-pipelines/%1$s/sessions", inference_pipeline_id],
    query: query.transform_keys(per_page: "perPage", sort_column: "sortColumn"),
    body: parsed.except(*query_params),
    model: Openlayer::Models::InferencePipelineRetrieveSessionsResponse,
    options: options
  )
end

#retrieve_users(inference_pipeline_id, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {}) ⇒ Openlayer::Models::InferencePipelineRetrieveUsersResponse

Get aggregated user data for an inference pipeline with pagination and metadata.

Returns a list of users who have interacted with the inference pipeline, including their activity statistics such as session counts, record counts, token usage, and costs.

Parameters:

Returns:

See Also:



180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/openlayer/resources/inference_pipelines.rb', line 180

def retrieve_users(inference_pipeline_id, params = {})
  query_params = [:asc, :page, :per_page, :sort_column]
  parsed, options = Openlayer::InferencePipelineRetrieveUsersParams.dump_request(params)
  query = Openlayer::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: ["inference-pipelines/%1$s/users", inference_pipeline_id],
    query: query.transform_keys(per_page: "perPage", sort_column: "sortColumn"),
    body: parsed.except(*query_params),
    model: Openlayer::Models::InferencePipelineRetrieveUsersResponse,
    options: options
  )
end

#update(inference_pipeline_id, description: nil, name: nil, reference_dataset_uri: nil, request_options: {}) ⇒ Openlayer::Models::InferencePipelineUpdateResponse

Some parameter documentations has been truncated, see Models::InferencePipelineUpdateParams for more details.

Update inference pipeline.

Parameters:

  • inference_pipeline_id (String) —

    The inference pipeline id (a UUID).

  • description (String, nil) —

    The inference pipeline description.

  • name (String) —

    The inference pipeline name.

  • reference_dataset_uri (String, nil) —

    The storage uri of your reference dataset. We recommend using the Python SDK or

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

Returns:

See Also:



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/openlayer/resources/inference_pipelines.rb', line 60

def update(inference_pipeline_id, params = {})
  parsed, options = Openlayer::InferencePipelineUpdateParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["inference-pipelines/%1$s", inference_pipeline_id],
    body: parsed,
    model: Openlayer::Models::InferencePipelineUpdateResponse,
    options: options
  )
end