Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class DataStoreConnectionSignals.
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, ...
Generated from protobuf message google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ rewriter_model_call_signals |
DataStoreConnectionSignals\RewriterModelCallSignals
Optional. Diagnostic info related to the rewriter model call. |
↳ rewritten_query |
string
Optional. Rewritten string query used for search. |
↳ search_snippets |
array<DataStoreConnectionSignals\SearchSnippet>
Optional. Search snippets included in the answer generation prompt. |
↳ answer_generation_model_call_signals |
DataStoreConnectionSignals\AnswerGenerationModelCallSignals
Optional. Diagnostic info related to the answer generation model call. |
↳ answer |
string
Optional. The final compiled answer. |
↳ answer_parts |
array<DataStoreConnectionSignals\AnswerPart>
Optional. Answer parts with relevant citations. Concatenation of texts should add up the |
↳ cited_snippets |
array<DataStoreConnectionSignals\CitedSnippet>
Optional. Snippets cited by the answer generation model from the most to least relevant. |
↳ grounding_signals |
DataStoreConnectionSignals\GroundingSignals
Optional. Grounding signals. |
↳ safety_signals |
DataStoreConnectionSignals\SafetySignals
Optional. Safety check result. |
getRewriterModelCallSignals
Optional. Diagnostic info related to the rewriter model call.
| Returns | |
|---|---|
| Type | Description |
DataStoreConnectionSignals\RewriterModelCallSignals|null |
|
hasRewriterModelCallSignals
clearRewriterModelCallSignals
setRewriterModelCallSignals
Optional. Diagnostic info related to the rewriter model call.
| Parameter | |
|---|---|
| Name | Description |
var |
DataStoreConnectionSignals\RewriterModelCallSignals
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRewrittenQuery
Optional. Rewritten string query used for search.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRewrittenQuery
Optional. Rewritten string query used for search.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSearchSnippets
Optional. Search snippets included in the answer generation prompt.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSearchSnippets
Optional. Search snippets included in the answer generation prompt.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DataStoreConnectionSignals\SearchSnippet>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnswerGenerationModelCallSignals
Optional. Diagnostic info related to the answer generation model call.
| Returns | |
|---|---|
| Type | Description |
DataStoreConnectionSignals\AnswerGenerationModelCallSignals|null |
|
hasAnswerGenerationModelCallSignals
clearAnswerGenerationModelCallSignals
setAnswerGenerationModelCallSignals
Optional. Diagnostic info related to the answer generation model call.
| Parameter | |
|---|---|
| Name | Description |
var |
DataStoreConnectionSignals\AnswerGenerationModelCallSignals
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnswer
Optional. The final compiled answer.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAnswer
Optional. The final compiled answer.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnswerParts
Optional. Answer parts with relevant citations.
Concatenation of texts should add up the answer (not counting
whitespaces).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAnswerParts
Optional. Answer parts with relevant citations.
Concatenation of texts should add up the answer (not counting
whitespaces).
| Parameter | |
|---|---|
| Name | Description |
var |
array<DataStoreConnectionSignals\AnswerPart>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCitedSnippets
Optional. Snippets cited by the answer generation model from the most to least relevant.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCitedSnippets
Optional. Snippets cited by the answer generation model from the most to least relevant.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DataStoreConnectionSignals\CitedSnippet>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGroundingSignals
Optional. Grounding signals.
| Returns | |
|---|---|
| Type | Description |
DataStoreConnectionSignals\GroundingSignals|null |
|
hasGroundingSignals
clearGroundingSignals
setGroundingSignals
Optional. Grounding signals.
| Parameter | |
|---|---|
| Name | Description |
var |
DataStoreConnectionSignals\GroundingSignals
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSafetySignals
Optional. Safety check result.
| Returns | |
|---|---|
| Type | Description |
DataStoreConnectionSignals\SafetySignals|null |
|
hasSafetySignals
clearSafetySignals
setSafetySignals
Optional. Safety check result.
| Parameter | |
|---|---|
| Name | Description |
var |
DataStoreConnectionSignals\SafetySignals
|
| Returns | |
|---|---|
| Type | Description |
$this |
|