public final class DataStoreConnectionSignals extends GeneratedMessageV3 implements DataStoreConnectionSignalsOrBuilder
Data store connection feature output signals.
Might be only partially field if processing stop before the final answer.
Reasons for this can be, but are not limited to: empty UCS search results,
positive RAI check outcome, grounding failure, ...
Protobuf type google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ANSWER_FIELD_NUMBER
public static final int ANSWER_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
ANSWER_GENERATION_MODEL_CALL_SIGNALS_FIELD_NUMBER
public static final int ANSWER_GENERATION_MODEL_CALL_SIGNALS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
ANSWER_PARTS_FIELD_NUMBER
public static final int ANSWER_PARTS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
CITED_SNIPPETS_FIELD_NUMBER
public static final int CITED_SNIPPETS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
GROUNDING_SIGNALS_FIELD_NUMBER
public static final int GROUNDING_SIGNALS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
REWRITER_MODEL_CALL_SIGNALS_FIELD_NUMBER
public static final int REWRITER_MODEL_CALL_SIGNALS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
REWRITTEN_QUERY_FIELD_NUMBER
public static final int REWRITTEN_QUERY_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
SAFETY_SIGNALS_FIELD_NUMBER
public static final int SAFETY_SIGNALS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
SEARCH_SNIPPETS_FIELD_NUMBER
public static final int SEARCH_SNIPPETS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DataStoreConnectionSignals getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DataStoreConnectionSignals.Builder newBuilder()
newBuilder(DataStoreConnectionSignals prototype)
public static DataStoreConnectionSignals.Builder newBuilder(DataStoreConnectionSignals prototype)
public static DataStoreConnectionSignals parseDelimitedFrom(InputStream input)
public static DataStoreConnectionSignals parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DataStoreConnectionSignals parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataStoreConnectionSignals parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DataStoreConnectionSignals parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataStoreConnectionSignals parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataStoreConnectionSignals parseFrom(CodedInputStream input)
public static DataStoreConnectionSignals parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DataStoreConnectionSignals parseFrom(InputStream input)
public static DataStoreConnectionSignals parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DataStoreConnectionSignals parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataStoreConnectionSignals parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DataStoreConnectionSignals> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getAnswer()
public String getAnswer()
Optional. The final compiled answer.
string answer = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
String |
The answer.
|
getAnswerBytes()
public ByteString getAnswerBytes()
Optional. The final compiled answer.
string answer = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
ByteString |
The bytes for answer.
|
getAnswerGenerationModelCallSignals()
public DataStoreConnectionSignals.AnswerGenerationModelCallSignals getAnswerGenerationModelCallSignals()
Optional. Diagnostic info related to the answer generation model call.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerGenerationModelCallSignals answer_generation_model_call_signals = 4 [(.google.api.field_behavior) = OPTIONAL];
getAnswerGenerationModelCallSignalsOrBuilder()
public DataStoreConnectionSignals.AnswerGenerationModelCallSignalsOrBuilder getAnswerGenerationModelCallSignalsOrBuilder()
Optional. Diagnostic info related to the answer generation model call.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerGenerationModelCallSignals answer_generation_model_call_signals = 4 [(.google.api.field_behavior) = OPTIONAL];
getAnswerParts(int index)
public DataStoreConnectionSignals.AnswerPart getAnswerParts(int index)
Optional. Answer parts with relevant citations.
Concatenation of texts should add up the answer
(not counting
whitespaces).
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter |
Name |
Description |
index |
int
|
getAnswerPartsCount()
public int getAnswerPartsCount()
Optional. Answer parts with relevant citations.
Concatenation of texts should add up the answer
(not counting
whitespaces).
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
int |
|
getAnswerPartsList()
public List<DataStoreConnectionSignals.AnswerPart> getAnswerPartsList()
Optional. Answer parts with relevant citations.
Concatenation of texts should add up the answer
(not counting
whitespaces).
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL];
getAnswerPartsOrBuilder(int index)
public DataStoreConnectionSignals.AnswerPartOrBuilder getAnswerPartsOrBuilder(int index)
Optional. Answer parts with relevant citations.
Concatenation of texts should add up the answer
(not counting
whitespaces).
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter |
Name |
Description |
index |
int
|
getAnswerPartsOrBuilderList()
public List<? extends DataStoreConnectionSignals.AnswerPartOrBuilder> getAnswerPartsOrBuilderList()
Optional. Answer parts with relevant citations.
Concatenation of texts should add up the answer
(not counting
whitespaces).
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerPartOrBuilder> |
|
getCitedSnippets(int index)
public DataStoreConnectionSignals.CitedSnippet getCitedSnippets(int index)
Optional. Snippets cited by the answer generation model from the most to
least relevant.
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL];
Parameter |
Name |
Description |
index |
int
|
getCitedSnippetsCount()
public int getCitedSnippetsCount()
Optional. Snippets cited by the answer generation model from the most to
least relevant.
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
int |
|
getCitedSnippetsList()
public List<DataStoreConnectionSignals.CitedSnippet> getCitedSnippetsList()
Optional. Snippets cited by the answer generation model from the most to
least relevant.
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL];
getCitedSnippetsOrBuilder(int index)
public DataStoreConnectionSignals.CitedSnippetOrBuilder getCitedSnippetsOrBuilder(int index)
Optional. Snippets cited by the answer generation model from the most to
least relevant.
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL];
Parameter |
Name |
Description |
index |
int
|
getCitedSnippetsOrBuilderList()
public List<? extends DataStoreConnectionSignals.CitedSnippetOrBuilder> getCitedSnippetsOrBuilderList()
Optional. Snippets cited by the answer generation model from the most to
least relevant.
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.CitedSnippetOrBuilder> |
|
getDefaultInstanceForType()
public DataStoreConnectionSignals getDefaultInstanceForType()
getGroundingSignals()
public DataStoreConnectionSignals.GroundingSignals getGroundingSignals()
Optional. Grounding signals.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL];
getGroundingSignalsOrBuilder()
public DataStoreConnectionSignals.GroundingSignalsOrBuilder getGroundingSignalsOrBuilder()
Optional. Grounding signals.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<DataStoreConnectionSignals> getParserForType()
Overrides
getRewriterModelCallSignals()
public DataStoreConnectionSignals.RewriterModelCallSignals getRewriterModelCallSignals()
Optional. Diagnostic info related to the rewriter model call.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.RewriterModelCallSignals rewriter_model_call_signals = 1 [(.google.api.field_behavior) = OPTIONAL];
getRewriterModelCallSignalsOrBuilder()
public DataStoreConnectionSignals.RewriterModelCallSignalsOrBuilder getRewriterModelCallSignalsOrBuilder()
Optional. Diagnostic info related to the rewriter model call.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.RewriterModelCallSignals rewriter_model_call_signals = 1 [(.google.api.field_behavior) = OPTIONAL];
getRewrittenQuery()
public String getRewrittenQuery()
Optional. Rewritten string query used for search.
string rewritten_query = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
String |
The rewrittenQuery.
|
getRewrittenQueryBytes()
public ByteString getRewrittenQueryBytes()
Optional. Rewritten string query used for search.
string rewritten_query = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
ByteString |
The bytes for rewrittenQuery.
|
getSafetySignals()
public DataStoreConnectionSignals.SafetySignals getSafetySignals()
Optional. Safety check result.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL];
getSafetySignalsOrBuilder()
public DataStoreConnectionSignals.SafetySignalsOrBuilder getSafetySignalsOrBuilder()
Optional. Safety check result.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL];
getSearchSnippets(int index)
public DataStoreConnectionSignals.SearchSnippet getSearchSnippets(int index)
Optional. Search snippets included in the answer generation prompt.
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter |
Name |
Description |
index |
int
|
getSearchSnippetsCount()
public int getSearchSnippetsCount()
Optional. Search snippets included in the answer generation prompt.
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
int |
|
getSearchSnippetsList()
public List<DataStoreConnectionSignals.SearchSnippet> getSearchSnippetsList()
Optional. Search snippets included in the answer generation prompt.
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL];
getSearchSnippetsOrBuilder(int index)
public DataStoreConnectionSignals.SearchSnippetOrBuilder getSearchSnippetsOrBuilder(int index)
Optional. Search snippets included in the answer generation prompt.
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter |
Name |
Description |
index |
int
|
getSearchSnippetsOrBuilderList()
public List<? extends DataStoreConnectionSignals.SearchSnippetOrBuilder> getSearchSnippetsOrBuilderList()
Optional. Search snippets included in the answer generation prompt.
repeated .google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SearchSnippetOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
hasAnswerGenerationModelCallSignals()
public boolean hasAnswerGenerationModelCallSignals()
Optional. Diagnostic info related to the answer generation model call.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.AnswerGenerationModelCallSignals answer_generation_model_call_signals = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
boolean |
Whether the answerGenerationModelCallSignals field is set.
|
hasGroundingSignals()
public boolean hasGroundingSignals()
Optional. Grounding signals.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
boolean |
Whether the groundingSignals field is set.
|
hasRewriterModelCallSignals()
public boolean hasRewriterModelCallSignals()
Optional. Diagnostic info related to the rewriter model call.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.RewriterModelCallSignals rewriter_model_call_signals = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
boolean |
Whether the rewriterModelCallSignals field is set.
|
hasSafetySignals()
public boolean hasSafetySignals()
Optional. Safety check result.
.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
boolean |
Whether the safetySignals field is set.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DataStoreConnectionSignals.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataStoreConnectionSignals.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public DataStoreConnectionSignals.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides