Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::Answer.
Defines an answer.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#answer_skipped_reasons
def answer_skipped_reasons() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::AnswerSkippedReason>
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::AnswerSkippedReason>) — Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
#answer_skipped_reasons=
def answer_skipped_reasons=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::AnswerSkippedReason>
Parameter
- value (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::AnswerSkippedReason>) — Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::AnswerSkippedReason>) — Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
#answer_text
def answer_text() -> ::String
Returns
- (::String) — The textual answer.
#answer_text=
def answer_text=(value) -> ::String
Parameter
- value (::String) — The textual answer.
Returns
- (::String) — The textual answer.
#citations
def citations() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Citation>
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Citation>) — Citations.
#citations=
def citations=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Citation>
Parameter
- value (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Citation>) — Citations.
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Citation>) — Citations.
#complete_time
def complete_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Answer completed timestamp.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Answer creation timestamp.
#name
def name() -> ::String
Returns
-
(::String) — Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
Returns
-
(::String) — Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
#query_understanding_info
def query_understanding_info() -> ::Google::Cloud::DiscoveryEngine::V1::Answer::QueryUnderstandingInfo
Returns
- (::Google::Cloud::DiscoveryEngine::V1::Answer::QueryUnderstandingInfo) — Query understanding information.
#query_understanding_info=
def query_understanding_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Answer::QueryUnderstandingInfo
Parameter
- value (::Google::Cloud::DiscoveryEngine::V1::Answer::QueryUnderstandingInfo) — Query understanding information.
Returns
- (::Google::Cloud::DiscoveryEngine::V1::Answer::QueryUnderstandingInfo) — Query understanding information.
#references
def references() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Reference>
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Reference>) — References.
#references=
def references=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Reference>
Parameter
- value (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Reference>) — References.
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Reference>) — References.
#related_questions
def related_questions() -> ::Array<::String>
Returns
- (::Array<::String>) — Suggested related questions.
#related_questions=
def related_questions=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Suggested related questions.
Returns
- (::Array<::String>) — Suggested related questions.
#state
def state() -> ::Google::Cloud::DiscoveryEngine::V1::Answer::State
Returns
- (::Google::Cloud::DiscoveryEngine::V1::Answer::State) — The state of the answer generation.
#state=
def state=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Answer::State
Parameter
- value (::Google::Cloud::DiscoveryEngine::V1::Answer::State) — The state of the answer generation.
Returns
- (::Google::Cloud::DiscoveryEngine::V1::Answer::State) — The state of the answer generation.
#steps
def steps() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step>
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step>) — Answer generation steps.
#steps=
def steps=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step>
Parameter
- value (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step>) — Answer generation steps.
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step>) — Answer generation steps.