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

Inherits:

Object

• Object
• Google::Cloud::AIPlatform::V1::Examples

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

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

  The Cloud Storage input instances.

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

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

• #neighbor_count ⇒ ::Integer

  The number of neighbors to return when querying for examples.

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

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

Instance Attribute Details

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

# 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

# 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

# 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

# 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