Class StreamAssistRequest.ToolsSpec.VertexAiSearchSpec (0.72.0)
public static final class StreamAssistRequest.ToolsSpec.VertexAiSearchSpec extends GeneratedMessageV3 implements StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder
Specification of the Vertex AI Search tool.
Protobuf type
google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DATA_STORE_SPECS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilder()
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilder(StreamAssistRequest.ToolsSpec.VertexAiSearchSpec prototype)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseDelimitedFrom(InputStream input)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(ByteString data)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(CodedInputStream input)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(InputStream input)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(ByteBuffer data)
public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public SearchRequest.DataStoreSpec getDataStoreSpecs(int index)
Optional. Specs defining
DataStores to filter on in
a search call and configurations for those data stores. This is only
considered for Engines with
multiple data stores.
repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public int getDataStoreSpecsCount()
Optional. Specs defining
DataStores to filter on in
a search call and configurations for those data stores. This is only
considered for Engines with
multiple data stores.
repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()
Optional. Specs defining
DataStores to filter on in
a search call and configurations for those data stores. This is only
considered for Engines with
multiple data stores.
repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];
public SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)
Optional. Specs defining
DataStores to filter on in
a search call and configurations for those data stores. This is only
considered for Engines with
multiple data stores.
repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()
Optional. Specs defining
DataStores to filter on in
a search call and configurations for those data stores. This is only
considered for Engines with
multiple data stores.
repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpecOrBuilder> |
|
public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec getDefaultInstanceForType()
public String getFilter()
Optional. The filter syntax consists of an expression language for
constructing a predicate from one or more fields of the documents being
filtered. Filter expression is case-sensitive.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
Filtering in Vertex AI Search is done by mapping the LHS filter key to
a key property defined in the Vertex AI Search backend -- this mapping
is defined by the customer in their schema. For example a media
customer might have a field 'name' in their schema. In this case the
filter would look like this: filter --> name:'ANY("king kong")'
For more information about filtering including syntax and filter
operators, see
Filter
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The filter.
|
public ByteString getFilterBytes()
Optional. The filter syntax consists of an expression language for
constructing a predicate from one or more fields of the documents being
filtered. Filter expression is case-sensitive.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
Filtering in Vertex AI Search is done by mapping the LHS filter key to
a key property defined in the Vertex AI Search backend -- this mapping
is defined by the customer in their schema. For example a media
customer might have a field 'name' in their schema. In this case the
filter would look like this: filter --> name:'ANY("king kong")'
For more information about filtering including syntax and filter
operators, see
Filter
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
public Parser<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilderForType()
protected StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
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-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
