Class DataStoreConnectionSignals (0.65.0)

See more code actions.
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

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()
Returns
Type Description
DataStoreConnectionSignals

getDescriptor()

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

newBuilder()

public static DataStoreConnectionSignals.Builder newBuilder()
Returns
Type Description
DataStoreConnectionSignals.Builder

newBuilder(DataStoreConnectionSignals prototype)

public static DataStoreConnectionSignals.Builder newBuilder(DataStoreConnectionSignals prototype)
Parameter
Name Description
prototype DataStoreConnectionSignals
Returns
Type Description
DataStoreConnectionSignals.Builder

parseDelimitedFrom(InputStream input)

public static DataStoreConnectionSignals parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreConnectionSignals parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DataStoreConnectionSignals parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataStoreConnectionSignals parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataStoreConnectionSignals parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataStoreConnectionSignals parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataStoreConnectionSignals parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreConnectionSignals parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DataStoreConnectionSignals parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreConnectionSignals parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DataStoreConnectionSignals parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataStoreConnectionSignals parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreConnectionSignals
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DataStoreConnectionSignals> parser()
Returns
Type Description
Parser<DataStoreConnectionSignals>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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];

Returns
Type Description
DataStoreConnectionSignals.AnswerGenerationModelCallSignals

The answerGenerationModelCallSignals.

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
Returns
Type Description
DataStoreConnectionSignals.AnswerPart

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];

Returns
Type Description
List<AnswerPart>

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
Returns
Type Description
DataStoreConnectionSignals.CitedSnippet

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];

Returns
Type Description
List<CitedSnippet>

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()
Returns
Type Description
DataStoreConnectionSignals

getGroundingSignals()

public DataStoreConnectionSignals.GroundingSignals getGroundingSignals()

Optional. Grounding signals.

.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreConnectionSignals.GroundingSignals

The groundingSignals.

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()
Returns
Type Description
Parser<DataStoreConnectionSignals>
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];

Returns
Type Description
DataStoreConnectionSignals.RewriterModelCallSignals

The rewriterModelCallSignals.

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];

Returns
Type Description
DataStoreConnectionSignals.SafetySignals

The safetySignals.

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
Returns
Type Description
DataStoreConnectionSignals.SearchSnippet

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];

Returns
Type Description
List<SearchSnippet>

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DataStoreConnectionSignals.Builder newBuilderForType()
Returns
Type Description
DataStoreConnectionSignals.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataStoreConnectionSignals.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataStoreConnectionSignals.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DataStoreConnectionSignals.Builder toBuilder()
Returns
Type Description
DataStoreConnectionSignals.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException