Interface StoredContentsExampleOrBuilder (3.64.0)

public interface StoredContentsExampleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContentsExample()

public abstract ContentsExample getContentsExample()

Required. The example to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.ContentsExample contents_example = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ContentsExample

The contentsExample.

getContentsExampleOrBuilder()

public abstract ContentsExampleOrBuilder getContentsExampleOrBuilder()

Required. The example to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.ContentsExample contents_example = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ContentsExampleOrBuilder

getSearchKey()

public abstract String getSearchKey()

Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from contents_example.contents using the method provided by search_key_generation_method. The generated search key will be included in retrieved examples.

string search_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The searchKey.

getSearchKeyBytes()

public abstract ByteString getSearchKeyBytes()

Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from contents_example.contents using the method provided by search_key_generation_method. The generated search key will be included in retrieved examples.

string search_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for searchKey.

getSearchKeyGenerationMethod()

public abstract StoredContentsExample.SearchKeyGenerationMethod getSearchKeyGenerationMethod()

Optional. The method used to generate the search key from contents_example.contents. This is ignored when uploading an example if search_key is provided.

.google.cloud.aiplatform.v1beta1.StoredContentsExample.SearchKeyGenerationMethod search_key_generation_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StoredContentsExample.SearchKeyGenerationMethod

The searchKeyGenerationMethod.

getSearchKeyGenerationMethodOrBuilder()

public abstract StoredContentsExample.SearchKeyGenerationMethodOrBuilder getSearchKeyGenerationMethodOrBuilder()

Optional. The method used to generate the search key from contents_example.contents. This is ignored when uploading an example if search_key is provided.

.google.cloud.aiplatform.v1beta1.StoredContentsExample.SearchKeyGenerationMethod search_key_generation_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StoredContentsExample.SearchKeyGenerationMethodOrBuilder

hasContentsExample()

public abstract boolean hasContentsExample()

Required. The example to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.ContentsExample contents_example = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the contentsExample field is set.

hasSearchKeyGenerationMethod()

public abstract boolean hasSearchKeyGenerationMethod()

Optional. The method used to generate the search key from contents_example.contents. This is ignored when uploading an example if search_key is provided.

.google.cloud.aiplatform.v1beta1.StoredContentsExample.SearchKeyGenerationMethod search_key_generation_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the searchKeyGenerationMethod field is set.