Class StreamAssistRequest.ToolsSpec.VertexAiSearchSpec (0.66.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

Static Fields

DATA_STORE_SPECS_FIELD_NUMBER

public static final int DATA_STORE_SPECS_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec getDefaultInstance()
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilder()
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

newBuilder(StreamAssistRequest.ToolsSpec.VertexAiSearchSpec prototype)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilder(StreamAssistRequest.ToolsSpec.VertexAiSearchSpec prototype)
Parameter
Name Description
prototype StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

parseDelimitedFrom(InputStream input)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StreamAssistRequest.ToolsSpec.VertexAiSearchSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec> parser()
Returns
Type Description
Parser<VertexAiSearchSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDataStoreSpecs(int index)

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
Returns
Type Description
SearchRequest.DataStoreSpec

getDataStoreSpecsCount()

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

getDataStoreSpecsList()

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];

Returns
Type Description
List<DataStoreSpec>

getDataStoreSpecsOrBuilder(int index)

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
Returns
Type Description
SearchRequest.DataStoreSpecOrBuilder

getDataStoreSpecsOrBuilderList()

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>

getDefaultInstanceForType()

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec getDefaultInstanceForType()
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

getFilter()

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.

getFilterBytes()

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.

getParserForType()

public Parser<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec> getParserForType()
Returns
Type Description
Parser<VertexAiSearchSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilderForType()
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder toBuilder()
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException