Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class GroundingMetadata.
Grounding metadata contains sources, citations, and search entry points used to ground a generated answer or suggestion.
Generated from protobuf message google.cloud.dialogflow.v2.GroundingMetadata
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ web_search_queries |
string[]
Optional. The web search queries that were used to generate the content. |
↳ search_entry_point |
SearchEntryPoint
Optional. A web search entry point that can be used to display search results. |
↳ grounding_chunks |
array<GroundingChunk>
Optional. A list of supporting references retrieved from the grounding source. |
↳ grounding_supports |
array<GroundingSupport>
Optional. A list of grounding supports that connect the generated content to the grounding chunks. |
getWebSearchQueries
Optional. The web search queries that were used to generate the content.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setWebSearchQueries
Optional. The web search queries that were used to generate the content.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSearchEntryPoint
Optional. A web search entry point that can be used to display search results.
| Returns | |
|---|---|
| Type | Description |
SearchEntryPoint|null |
|
hasSearchEntryPoint
clearSearchEntryPoint
setSearchEntryPoint
Optional. A web search entry point that can be used to display search results.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchEntryPoint
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGroundingChunks
Optional. A list of supporting references retrieved from the grounding source.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<GroundingChunk> |
|
setGroundingChunks
Optional. A list of supporting references retrieved from the grounding source.
| Parameter | |
|---|---|
| Name | Description |
var |
array<GroundingChunk>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGroundingSupports
Optional. A list of grounding supports that connect the generated content to the grounding chunks.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<GroundingSupport> |
|
setGroundingSupports
Optional. A list of grounding supports that connect the generated content to the grounding chunks.
| Parameter | |
|---|---|
| Name | Description |
var |
array<GroundingSupport>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|