answers

Creates, updates, deletes, gets or lists an answers resource.

Overview

Name	answers
Type	Resource
Id	google.discoveryengine.answers

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_data_stores_sessions_answers_get

Successful response

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
answerSkippedReasons	array	Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
answerText	string	The textual answer.
citations	array	Citations.
completeTime	string (google-datetime)	Output only. Answer completed timestamp.
createTime	string (google-datetime)	Output only. Answer creation timestamp.
groundingScore	number (double)	A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
groundingSupports	array	Optional. Grounding supports.
queryUnderstandingInfo	object	Query understanding information. (id: GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo)
references	array	References.
relatedQuestions	array	Suggested related questions.
safetyRatings	array	Optional. Safety ratings.
state	string	The state of the answer generation.
steps	array	Answer generation steps.

projects_locations_collections_engines_sessions_answers_get

Successful response

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
answerSkippedReasons	array	Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
answerText	string	The textual answer.
citations	array	Citations.
completeTime	string (google-datetime)	Output only. Answer completed timestamp.
createTime	string (google-datetime)	Output only. Answer creation timestamp.
groundingScore	number (double)	A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
groundingSupports	array	Optional. Grounding supports.
queryUnderstandingInfo	object	Query understanding information. (id: GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo)
references	array	References.
relatedQuestions	array	Suggested related questions.
safetyRatings	array	Optional. Safety ratings.
state	string	The state of the answer generation.
steps	array	Answer generation steps.

projects_locations_data_stores_sessions_answers_get

Successful response

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
answerSkippedReasons	array	Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
answerText	string	The textual answer.
citations	array	Citations.
completeTime	string (google-datetime)	Output only. Answer completed timestamp.
createTime	string (google-datetime)	Output only. Answer creation timestamp.
groundingScore	number (double)	A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
groundingSupports	array	Optional. Grounding supports.
queryUnderstandingInfo	object	Query understanding information. (id: GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo)
references	array	References.
relatedQuestions	array	Suggested related questions.
safetyRatings	array	Optional. Safety ratings.
state	string	The state of the answer generation.
steps	array	Answer generation steps.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_data_stores_sessions_answers_get	select	projectsId, locationsId, collectionsId, dataStoresId, sessionsId, answersId		Gets a Answer.
projects_locations_collections_engines_sessions_answers_get	select	projectsId, locationsId, collectionsId, enginesId, sessionsId, answersId		Gets a Answer.
projects_locations_data_stores_sessions_answers_get	select	projectsId, locationsId, dataStoresId, sessionsId, answersId		Gets a Answer.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
answersId	string
collectionsId	string
dataStoresId	string
enginesId	string
locationsId	string
projectsId	string
sessionsId	string

SELECT examples

projects_locations_collections_data_stores_sessions_answers_get

Gets a Answer.

SELECT
name,
answerSkippedReasons,
answerText,
citations,
completeTime,
createTime,
groundingScore,
groundingSupports,
queryUnderstandingInfo,
references,
relatedQuestions,
safetyRatings,
state,
steps
FROM google.discoveryengine.answers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND sessionsId = '{{ sessionsId }}' -- required
AND answersId = '{{ answersId }}' -- required;

projects_locations_collections_engines_sessions_answers_get

Gets a Answer.

SELECT
name,
answerSkippedReasons,
answerText,
citations,
completeTime,
createTime,
groundingScore,
groundingSupports,
queryUnderstandingInfo,
references,
relatedQuestions,
safetyRatings,
state,
steps
FROM google.discoveryengine.answers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND enginesId = '{{ enginesId }}' -- required
AND sessionsId = '{{ sessionsId }}' -- required
AND answersId = '{{ answersId }}' -- required;

projects_locations_data_stores_sessions_answers_get

Gets a Answer.

SELECT
name,
answerSkippedReasons,
answerText,
citations,
completeTime,
createTime,
groundingScore,
groundingSupports,
queryUnderstandingInfo,
references,
relatedQuestions,
safetyRatings,
state,
steps
FROM google.discoveryengine.answers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND sessionsId = '{{ sessionsId }}' -- required
AND answersId = '{{ answersId }}' -- required;