public interface CheckGroundingRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsUserLabels(String key)
public abstract boolean containsUserLabels(String key)The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 5;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAnswerCandidate()
public abstract String getAnswerCandidate()Answer candidate to check. It can have a maximum length of 4096 tokens.
string answer_candidate = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The answerCandidate. |
getAnswerCandidateBytes()
public abstract ByteString getAnswerCandidateBytes()Answer candidate to check. It can have a maximum length of 4096 tokens.
string answer_candidate = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for answerCandidate. |
getFacts(int index)
public abstract GroundingFact getFacts(int index)List of facts for the grounding check. We support up to 200 facts.
repeated .google.cloud.discoveryengine.v1beta.GroundingFact facts = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GroundingFact |
|
getFactsCount()
public abstract int getFactsCount()List of facts for the grounding check. We support up to 200 facts.
repeated .google.cloud.discoveryengine.v1beta.GroundingFact facts = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
getFactsList()
public abstract List<GroundingFact> getFactsList()List of facts for the grounding check. We support up to 200 facts.
repeated .google.cloud.discoveryengine.v1beta.GroundingFact facts = 3;
| Returns | |
|---|---|
| Type | Description |
List<GroundingFact> |
|
getFactsOrBuilder(int index)
public abstract GroundingFactOrBuilder getFactsOrBuilder(int index)List of facts for the grounding check. We support up to 200 facts.
repeated .google.cloud.discoveryengine.v1beta.GroundingFact facts = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GroundingFactOrBuilder |
|
getFactsOrBuilderList()
public abstract List<? extends GroundingFactOrBuilder> getFactsOrBuilderList()List of facts for the grounding check. We support up to 200 facts.
repeated .google.cloud.discoveryengine.v1beta.GroundingFact facts = 3;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1beta.GroundingFactOrBuilder> |
|
getGroundingConfig()
public abstract String getGroundingConfig() Required. The resource name of the grounding config, such as
projects/*/locations/global/groundingConfigs/default_grounding_config.
string grounding_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The groundingConfig. |
getGroundingConfigBytes()
public abstract ByteString getGroundingConfigBytes() Required. The resource name of the grounding config, such as
projects/*/locations/global/groundingConfigs/default_grounding_config.
string grounding_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for groundingConfig. |
getGroundingSpec()
public abstract CheckGroundingSpec getGroundingSpec()Configuration of the grounding check.
.google.cloud.discoveryengine.v1beta.CheckGroundingSpec grounding_spec = 4;
| Returns | |
|---|---|
| Type | Description |
CheckGroundingSpec |
The groundingSpec. |
getGroundingSpecOrBuilder()
public abstract CheckGroundingSpecOrBuilder getGroundingSpecOrBuilder()Configuration of the grounding check.
.google.cloud.discoveryengine.v1beta.CheckGroundingSpec grounding_spec = 4;
| Returns | |
|---|---|
| Type | Description |
CheckGroundingSpecOrBuilder |
|
getUserLabels() (deprecated)
public abstract Map<String,String> getUserLabels()Use #getUserLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getUserLabelsCount()
public abstract int getUserLabelsCount()The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getUserLabelsMap()
public abstract Map<String,String> getUserLabelsMap()The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 5;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getUserLabelsOrDefault(String key, String defaultValue)
public abstract String getUserLabelsOrDefault(String key, String defaultValue)The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 5;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getUserLabelsOrThrow(String key)
public abstract String getUserLabelsOrThrow(String key)The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 5;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
hasGroundingSpec()
public abstract boolean hasGroundingSpec()Configuration of the grounding check.
.google.cloud.discoveryengine.v1beta.CheckGroundingSpec grounding_spec = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the groundingSpec field is set. |