public static final class Tool.ParallelAiSearch extends GeneratedMessage implements Tool.ParallelAiSearchOrBuilder
ParallelAiSearch tool type.
A tool that uses the Parallel.ai search engine for grounding.
Protobuf type google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
public static final int API_KEY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CUSTOM_CONFIGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ENABLE_ZERO_DATA_RETENTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static Tool.ParallelAiSearch getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Tool.ParallelAiSearch.Builder newBuilder()
public static Tool.ParallelAiSearch.Builder newBuilder(Tool.ParallelAiSearch prototype)
public static Tool.ParallelAiSearch parseDelimitedFrom(InputStream input)
public static Tool.ParallelAiSearch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Tool.ParallelAiSearch parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static Tool.ParallelAiSearch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Tool.ParallelAiSearch parseFrom(ByteString data)
public static Tool.ParallelAiSearch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Tool.ParallelAiSearch parseFrom(CodedInputStream input)
public static Tool.ParallelAiSearch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Tool.ParallelAiSearch parseFrom(InputStream input)
public static Tool.ParallelAiSearch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Tool.ParallelAiSearch parseFrom(ByteBuffer data)
public static Tool.ParallelAiSearch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Tool.ParallelAiSearch> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public String getApiKey()
Optional. The API key for ParallelAiSearch.
If an API key is not provided, the system will attempt to verify access
by checking for an active Parallel.ai subscription through the Google
Cloud Marketplace.
See https://docs.parallel.ai/search/search-quickstart for more details.
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The apiKey.
|
public ByteString getApiKeyBytes()
Optional. The API key for ParallelAiSearch.
If an API key is not provided, the system will attempt to verify access
by checking for an active Parallel.ai subscription through the Google
Cloud Marketplace.
See https://docs.parallel.ai/search/search-quickstart for more details.
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for apiKey.
|
public Struct getCustomConfigs()
Optional. Custom configs for ParallelAiSearch.
This field can be used to pass any parameter from the Parallel.ai
Search API.
See the Parallel.ai documentation for the full list of available
parameters and their usage:
https://docs.parallel.ai/api-reference/search-beta/search
Currently only source_policy, excerpts, max_results, mode,
fetch_policy can be set via this field. For example:
{
"source_policy": {
"include_domains": ["google.com", "wikipedia.org"],
"exclude_domains": ["example.com"]
},
"fetch_policy": {
"max_age_seconds": 3600
}
}
.google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Struct |
The customConfigs.
|
public StructOrBuilder getCustomConfigsOrBuilder()
Optional. Custom configs for ParallelAiSearch.
This field can be used to pass any parameter from the Parallel.ai
Search API.
See the Parallel.ai documentation for the full list of available
parameters and their usage:
https://docs.parallel.ai/api-reference/search-beta/search
Currently only source_policy, excerpts, max_results, mode,
fetch_policy can be set via this field. For example:
{
"source_policy": {
"include_domains": ["google.com", "wikipedia.org"],
"exclude_domains": ["example.com"]
},
"fetch_policy": {
"max_age_seconds": 3600
}
}
.google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
public Tool.ParallelAiSearch getDefaultInstanceForType()
public boolean getEnableZeroDataRetention()
Optional. Instructs Vertex Grounding to use Parallel's Zero Data
Retention Marketplace product. If this value is "false" or omitted, the
Parallel Web Search for Grounding standard subscription will be used. If
this value is "true", the Parallel Web Search for Grounding - ZDR
subscription will be used.
bool enable_zero_data_retention = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The enableZeroDataRetention.
|
public Parser<Tool.ParallelAiSearch> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public boolean hasCustomConfigs()
Optional. Custom configs for ParallelAiSearch.
This field can be used to pass any parameter from the Parallel.ai
Search API.
See the Parallel.ai documentation for the full list of available
parameters and their usage:
https://docs.parallel.ai/api-reference/search-beta/search
Currently only source_policy, excerpts, max_results, mode,
fetch_policy can be set via this field. For example:
{
"source_policy": {
"include_domains": ["google.com", "wikipedia.org"],
"exclude_domains": ["example.com"]
},
"fetch_policy": {
"max_age_seconds": 3600
}
}
.google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the customConfigs field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Tool.ParallelAiSearch.Builder newBuilderForType()
protected Tool.ParallelAiSearch.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public Tool.ParallelAiSearch.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
