Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Examples (v1.27.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Examples.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#example_gcs_source

def example_gcs_source() -> ::Google::Cloud::AIPlatform::V1::Examples::ExampleGcsSource
Returns

#example_gcs_source=

def example_gcs_source=(value) -> ::Google::Cloud::AIPlatform::V1::Examples::ExampleGcsSource
Parameter
Returns

#nearest_neighbor_search_config

def nearest_neighbor_search_config() -> ::Google::Protobuf::Value
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.

#nearest_neighbor_search_config=

def nearest_neighbor_search_config=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::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.

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.

#neighbor_count

def neighbor_count() -> ::Integer
Returns
  • (::Integer) — The number of neighbors to return when querying for examples.

#neighbor_count=

def neighbor_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of neighbors to return when querying for examples.
Returns
  • (::Integer) — The number of neighbors to return when querying for examples.

#presets

def presets() -> ::Google::Cloud::AIPlatform::V1::Presets
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.

#presets=

def presets=(value) -> ::Google::Cloud::AIPlatform::V1::Presets
Parameter
  • value (::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.

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.