Package com.google.cloud.aiplatform.v1beta1

Interface ExamplesOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Examples, Examples.Builder
    public interface ExamplesOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Examples.ConfigCase getConfigCase()  
      Examples.ExampleGcsSource getExampleGcsSource()
      The Cloud Storage input instances.
      Examples.ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder()
      The Cloud Storage input instances.
      GcsSource getGcsSource()
      The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
      GcsSourceOrBuilder getGcsSourceOrBuilder()
      The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
      com.google.protobuf.Value getNearestNeighborSearchConfig()
      The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
      com.google.protobuf.ValueOrBuilder getNearestNeighborSearchConfigOrBuilder()
      The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
      int getNeighborCount()
      The number of neighbors to return when querying for examples.
      Presets getPresets()
      Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
      PresetsOrBuilder getPresetsOrBuilder()
      Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
      Examples.SourceCase getSourceCase()  
      boolean hasExampleGcsSource()
      The Cloud Storage input instances.
      boolean hasGcsSource()
      The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
      boolean hasNearestNeighborSearchConfig()
      The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
      boolean hasPresets()
      Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasExampleGcsSource

        boolean hasExampleGcsSource()
         The Cloud Storage input instances.
        .google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
        Returns:
        Whether the exampleGcsSource field is set.

      • getExampleGcsSource

        Examples.ExampleGcsSource getExampleGcsSource()
         The Cloud Storage input instances.
        .google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
        Returns:
        The exampleGcsSource.

      • getExampleGcsSourceOrBuilder

        Examples.ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder()
         The Cloud Storage input instances.
        .google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

      • hasNearestNeighborSearchConfig

        boolean hasNearestNeighborSearchConfig()
         The full configuration for the generated index, the semantics are the
 same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
 should match
 [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
        .google.protobuf.Value nearest_neighbor_search_config = 2;
        Returns:
        Whether the nearestNeighborSearchConfig field is set.

      • getNearestNeighborSearchConfig

        com.google.protobuf.Value getNearestNeighborSearchConfig()
         The full configuration for the generated index, the semantics are the
 same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
 should match
 [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
        .google.protobuf.Value nearest_neighbor_search_config = 2;
        Returns:
        The nearestNeighborSearchConfig.

      • getNearestNeighborSearchConfigOrBuilder

        com.google.protobuf.ValueOrBuilder getNearestNeighborSearchConfigOrBuilder()
         The full configuration for the generated index, the semantics are the
 same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
 should match
 [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
        .google.protobuf.Value nearest_neighbor_search_config = 2;

      • hasPresets

        boolean hasPresets()
         Simplified preset configuration, which automatically sets configuration
 values based on the desired query speed-precision trade-off and modality.
        .google.cloud.aiplatform.v1beta1.Presets presets = 4;
        Returns:
        Whether the presets field is set.

      • getPresets

        Presets getPresets()
         Simplified preset configuration, which automatically sets configuration
 values based on the desired query speed-precision trade-off and modality.
        .google.cloud.aiplatform.v1beta1.Presets presets = 4;
        Returns:
        The presets.

      • getPresetsOrBuilder

        PresetsOrBuilder getPresetsOrBuilder()
         Simplified preset configuration, which automatically sets configuration
 values based on the desired query speed-precision trade-off and modality.
        .google.cloud.aiplatform.v1beta1.Presets presets = 4;

      • hasGcsSource

        boolean hasGcsSource()
         The Cloud Storage locations that contain the instances to be
 indexed for approximate nearest neighbor search.
        .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;
        Returns:
        Whether the gcsSource field is set.

      • getGcsSource

        GcsSource getGcsSource()
         The Cloud Storage locations that contain the instances to be
 indexed for approximate nearest neighbor search.
        .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;
        Returns:
        The gcsSource.

      • getGcsSourceOrBuilder

        GcsSourceOrBuilder getGcsSourceOrBuilder()
         The Cloud Storage locations that contain the instances to be
 indexed for approximate nearest neighbor search.
        .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

      • getNeighborCount

        int getNeighborCount()
         The number of neighbors to return when querying for examples.
        int32 neighbor_count = 3;
        Returns:
        The neighborCount.