Class: Google::Cloud::AIPlatform::V1::Examples

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/explanation.rb

Overview

Example-based explainability that returns the nearest neighbors from the provided dataset.

Defined Under Namespace

Classes: ExampleGcsSource

Instance Attribute Summary collapse

Instance Attribute Details

#example_gcs_source ⇒ ::Google::Cloud::AIPlatform::V1::Examples::ExampleGcsSource

Returns The Cloud Storage input instances.

Returns:



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'proto_docs/google/cloud/aiplatform/v1/explanation.rb', line 486

class Examples
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The Cloud Storage input instances.
  # @!attribute [rw] data_format
  #   @return [::Google::Cloud::AIPlatform::V1::Examples::ExampleGcsSource::DataFormat]
  #     The format in which instances are given, if not specified, assume it's
  #     JSONL format. Currently only JSONL format is supported.
  # @!attribute [rw] gcs_source
  #   @return [::Google::Cloud::AIPlatform::V1::GcsSource]
  #     The Cloud Storage location for the input instances.
  class ExampleGcsSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The format of the input example instances.
    module DataFormat
      # Format unspecified, used when unset.
      DATA_FORMAT_UNSPECIFIED = 0

      # Examples are stored in JSONL files.
      JSONL = 1
    end
  end
end

#nearest_neighbor_search_config ⇒ ::Google::Protobuf::Value

Returns The full configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

Note: The following fields are mutually exclusive: nearest_neighbor_search_config, presets. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::Value) —

    The full configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

    Note: The following fields are mutually exclusive: nearest_neighbor_search_config, presets. If a field in that set is populated, all other fields in the set will automatically be cleared.



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'proto_docs/google/cloud/aiplatform/v1/explanation.rb', line 486

class Examples
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The Cloud Storage input instances.
  # @!attribute [rw] data_format
  #   @return [::Google::Cloud::AIPlatform::V1::Examples::ExampleGcsSource::DataFormat]
  #     The format in which instances are given, if not specified, assume it's
  #     JSONL format. Currently only JSONL format is supported.
  # @!attribute [rw] gcs_source
  #   @return [::Google::Cloud::AIPlatform::V1::GcsSource]
  #     The Cloud Storage location for the input instances.
  class ExampleGcsSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The format of the input example instances.
    module DataFormat
      # Format unspecified, used when unset.
      DATA_FORMAT_UNSPECIFIED = 0

      # Examples are stored in JSONL files.
      JSONL = 1
    end
  end
end

#neighbor_count ⇒ ::Integer

Returns The number of neighbors to return when querying for examples.

Returns:

  • (::Integer) —

    The number of neighbors to return when querying for examples.



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'proto_docs/google/cloud/aiplatform/v1/explanation.rb', line 486

class Examples
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The Cloud Storage input instances.
  # @!attribute [rw] data_format
  #   @return [::Google::Cloud::AIPlatform::V1::Examples::ExampleGcsSource::DataFormat]
  #     The format in which instances are given, if not specified, assume it's
  #     JSONL format. Currently only JSONL format is supported.
  # @!attribute [rw] gcs_source
  #   @return [::Google::Cloud::AIPlatform::V1::GcsSource]
  #     The Cloud Storage location for the input instances.
  class ExampleGcsSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The format of the input example instances.
    module DataFormat
      # Format unspecified, used when unset.
      DATA_FORMAT_UNSPECIFIED = 0

      # Examples are stored in JSONL files.
      JSONL = 1
    end
  end
end

#presets ⇒ ::Google::Cloud::AIPlatform::V1::Presets

Returns Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

Note: The following fields are mutually exclusive: presets, nearest_neighbor_search_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::Presets) —

    Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

    Note: The following fields are mutually exclusive: presets, nearest_neighbor_search_config. If a field in that set is populated, all other fields in the set will automatically be cleared.



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'proto_docs/google/cloud/aiplatform/v1/explanation.rb', line 486

class Examples
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The Cloud Storage input instances.
  # @!attribute [rw] data_format
  #   @return [::Google::Cloud::AIPlatform::V1::Examples::ExampleGcsSource::DataFormat]
  #     The format in which instances are given, if not specified, assume it's
  #     JSONL format. Currently only JSONL format is supported.
  # @!attribute [rw] gcs_source
  #   @return [::Google::Cloud::AIPlatform::V1::GcsSource]
  #     The Cloud Storage location for the input instances.
  class ExampleGcsSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The format of the input example instances.
    module DataFormat
      # Format unspecified, used when unset.
      DATA_FORMAT_UNSPECIFIED = 0

      # Examples are stored in JSONL files.
      JSONL = 1
    end
  end
end