Class: Openlayer::Models::InferencePipelines::DataStreamParams::Config::TextClassificationData

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openlayer/models/inference_pipelines/data_stream_params.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(class_names: , inference_id_column_name: nil, label_column_name: nil, latency_column_name: nil, metadata: nil, predictions_column_name: nil, prediction_scores_column_name: nil, text_column_name: nil, timestamp_column_name: nil) ⇒ Object

Some parameter documentations has been truncated, see Openlayer::Models::InferencePipelines::DataStreamParams::Config::TextClassificationData for more details.

**zero-index

probabilitie

Parameters:

  • class_names (Array<String>) (defaults to: ) —

    List of class names indexed by label integer in the dataset. E.g. [“Retained”, “

  • inference_id_column_name (String) (defaults to: nil) —

    Name of the column with the inference ids. This is useful if you want to update

  • label_column_name (String) (defaults to: nil) —

    Name of the column with the labels. The data in this column must be

  • latency_column_name (String) (defaults to: nil) —

    Name of the column with the latencies.

  • metadata (Object) (defaults to: nil) —

    Object with metadata.

  • predictions_column_name (String) (defaults to: nil) —

    Name of the column with the model’s predictions as **zero-indexed integers**.

  • prediction_scores_column_name (String) (defaults to: nil) —

    Name of the column with the model’s predictions as **lists of class

  • text_column_name (String) (defaults to: nil) —

    Name of the column with the text data.

  • timestamp_column_name (String) (defaults to: nil) —

    Name of the column with the timestamps. Timestamps must be in UNIX sec format. I




# File 'lib/openlayer/models/inference_pipelines/data_stream_params.rb', line 431

Instance Attribute Details

#class_names ⇒ Array<String>

List of class names indexed by label integer in the dataset. E.g. [“Retained”, “Exited”] when 0, 1 are in your label column.

Returns:

  • (Array<String>) 


376
 
# File 'lib/openlayer/models/inference_pipelines/data_stream_params.rb', line 376

required :class_names, Openlayer::Internal::Type::ArrayOf[String], api_name: :classNames

#inference_id_column_name ⇒ String?

Name of the column with the inference ids. This is useful if you want to update rows at a later point in time. If not provided, a unique id is generated by Openlayer.

Returns:

  • (String, nil) 


384
 
# File 'lib/openlayer/models/inference_pipelines/data_stream_params.rb', line 384

optional :inference_id_column_name, String, api_name: :inferenceIdColumnName

#label_column_name ⇒ String?

Name of the column with the labels. The data in this column must be **zero-indexed integers**, matching the list provided in ‘classNames`.

Returns:

  • (String, nil) 


391
 
# File 'lib/openlayer/models/inference_pipelines/data_stream_params.rb', line 391

optional :label_column_name, String, api_name: :labelColumnName

#latency_column_name ⇒ String?

Name of the column with the latencies.

Returns:

  • (String, nil) 


397
 
# File 'lib/openlayer/models/inference_pipelines/data_stream_params.rb', line 397

optional :latency_column_name, String, api_name: :latencyColumnName

#metadata ⇒ Object?

Object with metadata.

Returns:

  • (Object, nil) 


403
 
# File 'lib/openlayer/models/inference_pipelines/data_stream_params.rb', line 403

optional :metadata, Openlayer::Internal::Type::Unknown

#prediction_scores_column_name ⇒ String?

Name of the column with the model’s predictions as **lists of class probabilities**.

Returns:

  • (String, nil) 


416
 
# File 'lib/openlayer/models/inference_pipelines/data_stream_params.rb', line 416

optional :prediction_scores_column_name, String, api_name: :predictionScoresColumnName

#predictions_column_name ⇒ String?

Name of the column with the model’s predictions as **zero-indexed integers**.

Returns:

  • (String, nil) 


409
 
# File 'lib/openlayer/models/inference_pipelines/data_stream_params.rb', line 409

optional :predictions_column_name, String, api_name: :predictionsColumnName

#text_column_name ⇒ String?

Name of the column with the text data.

Returns:

  • (String, nil) 


422
 
# File 'lib/openlayer/models/inference_pipelines/data_stream_params.rb', line 422

optional :text_column_name, String, api_name: :textColumnName

#timestamp_column_name ⇒ String?

Name of the column with the timestamps. Timestamps must be in UNIX sec format. If not provided, the upload timestamp is used.

Returns:

  • (String, nil) 


429
 
# File 'lib/openlayer/models/inference_pipelines/data_stream_params.rb', line 429

optional :timestamp_column_name, String, api_name: :timestampColumnName