public static final class DataStoreTool.GroundingConfig extends GeneratedMessage implements DataStoreTool.GroundingConfigOrBuilderGrounding configuration.
Protobuf type google.cloud.ces.v1.DataStoreTool.GroundingConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > DataStoreTool.GroundingConfigImplements
DataStoreTool.GroundingConfigOrBuilderStatic Fields
DISABLED_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
GROUNDING_LEVEL_FIELD_NUMBER
public static final int GROUNDING_LEVEL_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static DataStoreTool.GroundingConfig getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static DataStoreTool.GroundingConfig.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig.Builder |
|
newBuilder(DataStoreTool.GroundingConfig prototype)
public static DataStoreTool.GroundingConfig.Builder newBuilder(DataStoreTool.GroundingConfig prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
DataStoreTool.GroundingConfig |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig.Builder |
|
parseDelimitedFrom(InputStream input)
public static DataStoreTool.GroundingConfig parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DataStoreTool.GroundingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static DataStoreTool.GroundingConfig parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataStoreTool.GroundingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static DataStoreTool.GroundingConfig parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataStoreTool.GroundingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static DataStoreTool.GroundingConfig parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DataStoreTool.GroundingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static DataStoreTool.GroundingConfig parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DataStoreTool.GroundingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static DataStoreTool.GroundingConfig parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataStoreTool.GroundingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<DataStoreTool.GroundingConfig> parser()| Returns | |
|---|---|
| Type | Description |
Parser<GroundingConfig> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public DataStoreTool.GroundingConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig |
|
getDisabled()
public boolean getDisabled()Optional. Whether grounding is disabled.
bool disabled = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The disabled. |
getGroundingLevel()
public float getGroundingLevel()Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only.
For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
float grounding_level = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
float |
The groundingLevel. |
getParserForType()
public Parser<DataStoreTool.GroundingConfig> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<GroundingConfig> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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 DataStoreTool.GroundingConfig.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected DataStoreTool.GroundingConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig.Builder |
|
toBuilder()
public DataStoreTool.GroundingConfig.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.GroundingConfig.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|