Class Tool.ExaAiSearch.Builder (3.100.0)

public static final class Tool.ExaAiSearch.Builder extends GeneratedMessage.Builder<Tool.ExaAiSearch.Builder> implements Tool.ExaAiSearchOrBuilder

ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding.

Protobuf type google.cloud.aiplatform.v1.Tool.ExaAiSearch

Static Methods

getDescriptor()

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

Methods

build()

public Tool.ExaAiSearch build()
Returns
Type Description
Tool.ExaAiSearch

buildPartial()

public Tool.ExaAiSearch buildPartial()
Returns
Type Description
Tool.ExaAiSearch

clear()

public Tool.ExaAiSearch.Builder clear()
Returns
Type Description
Tool.ExaAiSearch.Builder
Overrides

clearApiKey()

public Tool.ExaAiSearch.Builder clearApiKey()

Required. The API key for ExaAiSearch.

string api_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Tool.ExaAiSearch.Builder

This builder for chaining.

clearCustomConfigs()

public Tool.ExaAiSearch.Builder clearCustomConfigs()

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

.google.protobuf.Struct custom_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Tool.ExaAiSearch.Builder

getApiKey()

public String getApiKey()

Required. The API key for ExaAiSearch.

string api_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The apiKey.

getApiKeyBytes()

public ByteString getApiKeyBytes()

Required. The API key for ExaAiSearch.

string api_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for apiKey.

getCustomConfigs()

public Struct getCustomConfigs()

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

.google.protobuf.Struct custom_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The customConfigs.

getCustomConfigsBuilder()

public Struct.Builder getCustomConfigsBuilder()

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

.google.protobuf.Struct custom_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getCustomConfigsOrBuilder()

public StructOrBuilder getCustomConfigsOrBuilder()

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

.google.protobuf.Struct custom_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getDefaultInstanceForType()

public Tool.ExaAiSearch getDefaultInstanceForType()
Returns
Type Description
Tool.ExaAiSearch

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

hasCustomConfigs()

public boolean hasCustomConfigs()

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

.google.protobuf.Struct custom_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the customConfigs field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCustomConfigs(Struct value)

public Tool.ExaAiSearch.Builder mergeCustomConfigs(Struct value)

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

.google.protobuf.Struct custom_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
Tool.ExaAiSearch.Builder

mergeFrom(Tool.ExaAiSearch other)

public Tool.ExaAiSearch.Builder mergeFrom(Tool.ExaAiSearch other)
Parameter
Name Description
other Tool.ExaAiSearch
Returns
Type Description
Tool.ExaAiSearch.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Tool.ExaAiSearch.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool.ExaAiSearch.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Tool.ExaAiSearch.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Tool.ExaAiSearch.Builder
Overrides

setApiKey(String value)

public Tool.ExaAiSearch.Builder setApiKey(String value)

Required. The API key for ExaAiSearch.

string api_key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The apiKey to set.

Returns
Type Description
Tool.ExaAiSearch.Builder

This builder for chaining.

setApiKeyBytes(ByteString value)

public Tool.ExaAiSearch.Builder setApiKeyBytes(ByteString value)

Required. The API key for ExaAiSearch.

string api_key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for apiKey to set.

Returns
Type Description
Tool.ExaAiSearch.Builder

This builder for chaining.

setCustomConfigs(Struct value)

public Tool.ExaAiSearch.Builder setCustomConfigs(Struct value)

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

.google.protobuf.Struct custom_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
Tool.ExaAiSearch.Builder

setCustomConfigs(Struct.Builder builderForValue)

public Tool.ExaAiSearch.Builder setCustomConfigs(Struct.Builder builderForValue)

Optional. This field can be used to pass any parameter from the Exa.ai Search API.

.google.protobuf.Struct custom_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Tool.ExaAiSearch.Builder