Interface SearchExamplesRequestOrBuilder (3.77.0)

public interface SearchExamplesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExampleStore()

public abstract 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
Type	Description
String	The exampleStore.

getExampleStoreBytes()

public abstract 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
Type	Description
ByteString	The bytes for exampleStore.

getParametersCase()

public abstract SearchExamplesRequest.ParametersCase getParametersCase()

Returns
Type	Description
SearchExamplesRequest.ParametersCase

getStoredContentsExampleParameters()

public abstract StoredContentsExampleParameters getStoredContentsExampleParameters()

The parameters of StoredContentsExamples to be searched.

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

Returns
Type	Description
StoredContentsExampleParameters	The storedContentsExampleParameters.

getStoredContentsExampleParametersOrBuilder()

public abstract StoredContentsExampleParametersOrBuilder getStoredContentsExampleParametersOrBuilder()

The parameters of StoredContentsExamples to be searched.

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

Returns
Type	Description
StoredContentsExampleParametersOrBuilder

getTopK()

public abstract long getTopK()

Optional. The number of similar examples to return.

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

Returns
Type	Description
long	The topK.

hasStoredContentsExampleParameters()

public abstract boolean hasStoredContentsExampleParameters()

The parameters of StoredContentsExamples to be searched.

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

Returns
Type	Description
boolean	Whether the storedContentsExampleParameters field is set.