com.google.cloud.aiplatform.v1beta1

Interface SearchExamplesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchExamplesRequest, SearchExamplesRequest.Builder

public interface SearchExamplesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getExampleStore() Required.
com.google.protobuf.ByteString	getExampleStoreBytes() Required.
SearchExamplesRequest.ParametersCase	getParametersCase()
StoredContentsExampleParameters	getStoredContentsExampleParameters() The parameters of StoredContentsExamples to be searched.
StoredContentsExampleParametersOrBuilder	getStoredContentsExampleParametersOrBuilder() The parameters of StoredContentsExamples to be searched.
long	getTopK() Optional.
boolean	hasStoredContentsExampleParameters() The parameters of StoredContentsExamples to be searched.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasStoredContentsExampleParameters

boolean hasStoredContentsExampleParameters()

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

Returns:

Whether the storedContentsExampleParameters field is set.

getStoredContentsExampleParameters

StoredContentsExampleParameters getStoredContentsExampleParameters()

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

Returns:

The storedContentsExampleParameters.

getStoredContentsExampleParametersOrBuilder

StoredContentsExampleParametersOrBuilder getStoredContentsExampleParametersOrBuilder()

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

getExampleStore

String getExampleStore()

 Required. The name of the ExampleStore resource that examples are retrieved
 from. Format:
 `projects/{project}/locations/{location}/exampleStores/{example_store}`
 

string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The exampleStore.

getExampleStoreBytes

com.google.protobuf.ByteString getExampleStoreBytes()

 Required. The name of the ExampleStore resource that examples are retrieved
 from. Format:
 `projects/{project}/locations/{location}/exampleStores/{example_store}`
 

string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for exampleStore.

getTopK

long getTopK()

 Optional. The number of similar examples to return.
 

int64 top_k = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The topK.

getParametersCase

SearchExamplesRequest.ParametersCase getParametersCase()