Send feedback
  
   
 
  
    
      Class Examples (3.6.0)
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 3.6.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  Examples   extends   GeneratedMessageV3   implements   ExamplesOrBuilder  
   
   Example-based explainability that returns the nearest neighbors from the
 provided dataset.
 Protobuf type google.cloud.aiplatform.v1beta1.Examples
 
  
  
  
  Static Fields
   
  
  
    
public   static   final   int   GCS_SOURCE_FIELD_NUMBER  
   
  Field Value 
  
  
  
    
public   static   final   int   NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER  
   
  Field Value 
  
  
  
    
public   static   final   int   NEIGHBOR_COUNT_FIELD_NUMBER  
   
  Field Value 
  
  
  
    
public   static   final   int   PRESETS_FIELD_NUMBER  
   
  Field Value 
  
  Static Methods
   
   
  
  
    
public   static   Examples   getDefaultInstance ()  
   
  Returns 
  
   
  
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  Returns 
  
   
  
  
    
public   static   Examples . Builder   newBuilder ()  
   
  Returns 
  
   
  
  
    
public   static   Examples . Builder   newBuilder ( Examples   prototype )  
   
  Parameter 
  
  Returns 
  
   
  
  
    
public   static   Examples   parseDelimitedFrom ( InputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseFrom ( byte []   data )  
   
  Parameter 
  
    
      
        Name  
        Description  
       
      
        data  
        byte [] 
       
     
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseFrom ( ByteString   data )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseFrom ( CodedInputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseFrom ( InputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseFrom ( ByteBuffer   data )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Examples   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  
  
    
public   static   Parser<Examples>   parser ()  
   
  Returns 
  
  Methods
   
   
  
  
    
public   boolean   equals ( Object   obj )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  
  
    
public   Examples . ConfigCase   getConfigCase ()  
   
  Returns 
  
   
  
  
    
public   Examples   getDefaultInstanceForType ()  
   
  Returns 
  
   
  
  
    
public   GcsSource   getGcsSource ()  
   
   The Cloud Storage location for the input instances.
 .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;
 
  Returns 
  
   
  
  
    
public   GcsSourceOrBuilder   getGcsSourceOrBuilder ()  
   
   The Cloud Storage location for the input instances.
 .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;
 
  Returns 
  
   
  
  
    
public   Value   getNearestNeighborSearchConfig ()  
   
   The configuration for the generated index, the semantics are the same as
 metadata  and should match NearestNeighborSearchConfig.
 .google.protobuf.Value nearest_neighbor_search_config = 2;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        Value  
        The nearestNeighborSearchConfig.
 
       
     
  
   
  
  
    
public   ValueOrBuilder   getNearestNeighborSearchConfigOrBuilder ()  
   
   The configuration for the generated index, the semantics are the same as
 metadata  and should match NearestNeighborSearchConfig.
 .google.protobuf.Value nearest_neighbor_search_config = 2;
 
  Returns 
  
   
  
  
    
public   int   getNeighborCount ()  
   
   The number of neighbors to return.
 int32 neighbor_count = 3;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        int  
        The neighborCount.
 
       
     
  
   
  
  
    
public   Parser<Examples>   getParserForType ()  
   
  Returns 
  
  Overrides 
  
   
  
  
    
public   Presets   getPresets ()  
   
   Preset config based on the desired query speed-precision trade-off
 and modality
 .google.cloud.aiplatform.v1beta1.Presets presets = 4;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        Presets  
        The presets.
 
       
     
  
   
  
  
    
public   PresetsOrBuilder   getPresetsOrBuilder ()  
   
   Preset config based on the desired query speed-precision trade-off
 and modality
 .google.cloud.aiplatform.v1beta1.Presets presets = 4;
 
  Returns 
  
   
  
  
    
public   int   getSerializedSize ()  
   
  Returns 
  
  Overrides 
  
   
  
  
    
public   final   UnknownFieldSet   getUnknownFields ()  
   
  Returns 
  
  Overrides 
  
   
  
  
    
public   boolean   hasGcsSource ()  
   
   The Cloud Storage location for the input instances.
 .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        boolean  
        Whether the gcsSource field is set.
 
       
     
  
   
  
  
    
public   boolean   hasNearestNeighborSearchConfig ()  
   
   The configuration for the generated index, the semantics are the same as
 metadata  and should match NearestNeighborSearchConfig.
 .google.protobuf.Value nearest_neighbor_search_config = 2;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        boolean  
        Whether the nearestNeighborSearchConfig field is set.
 
       
     
  
   
  
  
    
public   boolean   hasPresets ()  
   
   Preset config based on the desired query speed-precision trade-off
 and modality
 .google.cloud.aiplatform.v1beta1.Presets presets = 4;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        boolean  
        Whether the presets field is set.
 
       
     
  
   
  
  
  Returns 
  
  Overrides 
  
   
  
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  Returns 
  
  Overrides 
  
   
  
  
    
public   final   boolean   isInitialized ()  
   
  Returns 
  
  Overrides 
  
   
  
  
    
public   Examples . Builder   newBuilderForType ()  
   
  Returns 
  
   
  
  
    
protected   Examples . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  
  
    
public   Examples . Builder   toBuilder ()  
   
  Returns 
  
   
  
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  Parameter 
  
  Overrides 
  
  Exceptions 
  
 
     
    
  
  
  
     
  
 
  
    
    
      
    
     
  
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-30 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]