- 3.64.0 (latest)
- 3.63.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class VertexAISearch.Builder extends GeneratedMessageV3.Builder<VertexAISearch.Builder> implements VertexAISearchOrBuilderRetrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
Protobuf type google.cloud.aiplatform.v1.VertexAISearch
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > VertexAISearch.BuilderImplements
VertexAISearchOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDataStoreSpecs(Iterable<? extends VertexAISearch.DataStoreSpec> values)
public VertexAISearch.Builder addAllDataStoreSpecs(Iterable<? extends VertexAISearch.DataStoreSpec> values)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec> |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
addDataStoreSpecs(VertexAISearch.DataStoreSpec value)
public VertexAISearch.Builder addDataStoreSpecs(VertexAISearch.DataStoreSpec value)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
VertexAISearch.DataStoreSpec |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
addDataStoreSpecs(VertexAISearch.DataStoreSpec.Builder builderForValue)
public VertexAISearch.Builder addDataStoreSpecs(VertexAISearch.DataStoreSpec.Builder builderForValue)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
VertexAISearch.DataStoreSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
addDataStoreSpecs(int index, VertexAISearch.DataStoreSpec value)
public VertexAISearch.Builder addDataStoreSpecs(int index, VertexAISearch.DataStoreSpec value)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
VertexAISearch.DataStoreSpec |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
addDataStoreSpecs(int index, VertexAISearch.DataStoreSpec.Builder builderForValue)
public VertexAISearch.Builder addDataStoreSpecs(int index, VertexAISearch.DataStoreSpec.Builder builderForValue)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
VertexAISearch.DataStoreSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
addDataStoreSpecsBuilder()
public VertexAISearch.DataStoreSpec.Builder addDataStoreSpecsBuilder()Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec.Builder |
|
addDataStoreSpecsBuilder(int index)
public VertexAISearch.DataStoreSpec.Builder addDataStoreSpecsBuilder(int index)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public VertexAISearch.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
build()
public VertexAISearch build()| Returns | |
|---|---|
| Type | Description |
VertexAISearch |
|
buildPartial()
public VertexAISearch buildPartial()| Returns | |
|---|---|
| Type | Description |
VertexAISearch |
|
clear()
public VertexAISearch.Builder clear()| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
clearDataStoreSpecs()
public VertexAISearch.Builder clearDataStoreSpecs()Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
clearDatastore()
public VertexAISearch.Builder clearDatastore() Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
clearEngine()
public VertexAISearch.Builder clearEngine() Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string engine = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public VertexAISearch.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
clearFilter()
public VertexAISearch.Builder clearFilter()Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
clearMaxResults()
public VertexAISearch.Builder clearMaxResults()Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
int32 max_results = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public VertexAISearch.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
clone()
public VertexAISearch.Builder clone()| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
getDataStoreSpecs(int index)
public VertexAISearch.DataStoreSpec getDataStoreSpecs(int index)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
getDataStoreSpecsBuilder(int index)
public VertexAISearch.DataStoreSpec.Builder getDataStoreSpecsBuilder(int index)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec.Builder |
|
getDataStoreSpecsBuilderList()
public List<VertexAISearch.DataStoreSpec.Builder> getDataStoreSpecsBuilderList()Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getDataStoreSpecsCount()
public int getDataStoreSpecsCount()Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getDataStoreSpecsList()
public List<VertexAISearch.DataStoreSpec> getDataStoreSpecsList()Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Returns | |
|---|---|
| Type | Description |
List<DataStoreSpec> |
|
getDataStoreSpecsOrBuilder(int index)
public VertexAISearch.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpecOrBuilder |
|
getDataStoreSpecsOrBuilderList()
public List<? extends VertexAISearch.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpecOrBuilder> |
|
getDatastore()
public String getDatastore() Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The datastore. |
getDatastoreBytes()
public ByteString getDatastoreBytes() Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for datastore. |
getDefaultInstanceForType()
public VertexAISearch getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
VertexAISearch |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEngine()
public String getEngine() Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string engine = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The engine. |
getEngineBytes()
public ByteString getEngineBytes() Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string engine = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for engine. |
getFilter()
public String getFilter()Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getMaxResults()
public int getMaxResults()Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
int32 max_results = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The maxResults. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(VertexAISearch other)
public VertexAISearch.Builder mergeFrom(VertexAISearch other)| Parameter | |
|---|---|
| Name | Description |
other |
VertexAISearch |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public VertexAISearch.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public VertexAISearch.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final VertexAISearch.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
removeDataStoreSpecs(int index)
public VertexAISearch.Builder removeDataStoreSpecs(int index)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
setDataStoreSpecs(int index, VertexAISearch.DataStoreSpec value)
public VertexAISearch.Builder setDataStoreSpecs(int index, VertexAISearch.DataStoreSpec value)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
VertexAISearch.DataStoreSpec |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
setDataStoreSpecs(int index, VertexAISearch.DataStoreSpec.Builder builderForValue)
public VertexAISearch.Builder setDataStoreSpecs(int index, VertexAISearch.DataStoreSpec.Builder builderForValue)Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
VertexAISearch.DataStoreSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
setDatastore(String value)
public VertexAISearch.Builder setDatastore(String value) Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe datastore to set. |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
setDatastoreBytes(ByteString value)
public VertexAISearch.Builder setDatastoreBytes(ByteString value) Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for datastore to set. |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
setEngine(String value)
public VertexAISearch.Builder setEngine(String value) Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string engine = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe engine to set. |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
setEngineBytes(ByteString value)
public VertexAISearch.Builder setEngineBytes(ByteString value) Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string engine = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for engine to set. |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public VertexAISearch.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
setFilter(String value)
public VertexAISearch.Builder setFilter(String value)Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public VertexAISearch.Builder setFilterBytes(ByteString value)Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
setMaxResults(int value)
public VertexAISearch.Builder setMaxResults(int value)Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
int32 max_results = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe maxResults to set. |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public VertexAISearch.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final VertexAISearch.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.Builder |
|