public static final class Tool.ExaAiSearch extends GeneratedMessage implements Tool.ExaAiSearchOrBuilderExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding.
Protobuf type google.cloud.aiplatform.v1.Tool.ExaAiSearch
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Tool.ExaAiSearchImplements
Tool.ExaAiSearchOrBuilderStatic Fields
API_KEY_FIELD_NUMBER
public static final int API_KEY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_CONFIGS_FIELD_NUMBER
public static final int CUSTOM_CONFIGS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Tool.ExaAiSearch getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Tool.ExaAiSearch.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch.Builder |
|
newBuilder(Tool.ExaAiSearch prototype)
public static Tool.ExaAiSearch.Builder newBuilder(Tool.ExaAiSearch prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Tool.ExaAiSearch |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch.Builder |
|
parseDelimitedFrom(InputStream input)
public static Tool.ExaAiSearch parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Tool.ExaAiSearch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Tool.ExaAiSearch parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Tool.ExaAiSearch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Tool.ExaAiSearch parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Tool.ExaAiSearch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Tool.ExaAiSearch parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Tool.ExaAiSearch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Tool.ExaAiSearch parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Tool.ExaAiSearch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Tool.ExaAiSearch parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Tool.ExaAiSearch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Tool.ExaAiSearch> parser()| Returns | |
|---|---|
| Type | Description |
Parser<ExaAiSearch> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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. |
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 |
|
getParserForType()
public Parser<Tool.ExaAiSearch> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<ExaAiSearch> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Tool.ExaAiSearch.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Tool.ExaAiSearch.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch.Builder |
|
toBuilder()
public Tool.ExaAiSearch.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Tool.ExaAiSearch.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|