Interface DataStoreConnectionSignalsOrBuilder (0.66.0)

public interface DataStoreConnectionSignalsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnswer()

public abstract String getAnswer()

Optional. The final compiled answer.

string answer = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The answer.

getAnswerBytes()

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

Returns
Type Description
DataStoreConnectionSignals.AnswerGenerationModelCallSignalsOrBuilder

getAnswerParts(int index)

public abstract 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 abstract 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 abstract 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 abstract 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
Returns
Type Description
DataStoreConnectionSignals.AnswerPartOrBuilder

getAnswerPartsOrBuilderList()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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
Returns
Type Description
DataStoreConnectionSignals.CitedSnippetOrBuilder

getCitedSnippetsOrBuilderList()

public abstract 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>

getGroundingSignals()

public abstract 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 abstract DataStoreConnectionSignals.GroundingSignalsOrBuilder getGroundingSignalsOrBuilder()

Optional. Grounding signals.

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

Returns
Type Description
DataStoreConnectionSignals.GroundingSignalsOrBuilder

getRewriterModelCallSignals()

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

Returns
Type Description
DataStoreConnectionSignals.RewriterModelCallSignalsOrBuilder

getRewrittenQuery()

public abstract 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 abstract 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 abstract 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 abstract DataStoreConnectionSignals.SafetySignalsOrBuilder getSafetySignalsOrBuilder()

Optional. Safety check result.

.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreConnectionSignals.SafetySignalsOrBuilder

getSearchSnippets(int index)

public abstract 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 abstract 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 abstract 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 abstract 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
Returns
Type Description
DataStoreConnectionSignals.SearchSnippetOrBuilder

getSearchSnippetsOrBuilderList()

public abstract 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>

hasAnswerGenerationModelCallSignals()

public abstract 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 abstract 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 abstract 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 abstract 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.