Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::CompanionSuggestion::Guidance.
Represents guidance for companion suggestion.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#explanation
def explanation() -> ::String
Returns
- (::String) — Optional. A brief explanation of why the action is suggested.
#explanation=
def explanation=(value) -> ::String
Parameter
- value (::String) — Optional. A brief explanation of why the action is suggested.
Returns
- (::String) — Optional. A brief explanation of why the action is suggested.
#grounding_metadata
def grounding_metadata() -> ::Google::Cloud::Dialogflow::V2::GroundingMetadata
Returns
- (::Google::Cloud::Dialogflow::V2::GroundingMetadata) — Optional. Grounding metadata for the generated guidance.
#grounding_metadata=
def grounding_metadata=(value) -> ::Google::Cloud::Dialogflow::V2::GroundingMetadata
Parameter
- value (::Google::Cloud::Dialogflow::V2::GroundingMetadata) — Optional. Grounding metadata for the generated guidance.
Returns
- (::Google::Cloud::Dialogflow::V2::GroundingMetadata) — Optional. Grounding metadata for the generated guidance.
#instruction_source
def instruction_source() -> ::Google::Cloud::Dialogflow::V2::GuidanceInstruction
Returns
- (::Google::Cloud::Dialogflow::V2::GuidanceInstruction) — Guidance instruction source.
#instruction_source=
def instruction_source=(value) -> ::Google::Cloud::Dialogflow::V2::GuidanceInstruction
Parameter
- value (::Google::Cloud::Dialogflow::V2::GuidanceInstruction) — Guidance instruction source.
Returns
- (::Google::Cloud::Dialogflow::V2::GuidanceInstruction) — Guidance instruction source.
#knowledge_sources
def knowledge_sources() -> ::Array<::Google::Cloud::Dialogflow::V2::CompanionSuggestion::Guidance::KnowledgeSource>
Returns
- (::Array<::Google::Cloud::Dialogflow::V2::CompanionSuggestion::Guidance::KnowledgeSource>) — Knowledge sources.
#knowledge_sources=
def knowledge_sources=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::CompanionSuggestion::Guidance::KnowledgeSource>
Parameter
- value (::Array<::Google::Cloud::Dialogflow::V2::CompanionSuggestion::Guidance::KnowledgeSource>) — Knowledge sources.
Returns
- (::Array<::Google::Cloud::Dialogflow::V2::CompanionSuggestion::Guidance::KnowledgeSource>) — Knowledge sources.
#suggested_action
def suggested_action() -> ::String
Returns
- (::String) — Suggested action to human agent. For example, "Ask the customer for their shipping address" or "Create a new case for the customer".
#suggested_action=
def suggested_action=(value) -> ::String
Parameter
- value (::String) — Suggested action to human agent. For example, "Ask the customer for their shipping address" or "Create a new case for the customer".
Returns
- (::String) — Suggested action to human agent. For example, "Ask the customer for their shipping address" or "Create a new case for the customer".
#suggested_reply
def suggested_reply() -> ::String
Returns
- (::String) — Suggested reply for the agent to respond to the customer.
#suggested_reply=
def suggested_reply=(value) -> ::String
Parameter
- value (::String) — Suggested reply for the agent to respond to the customer.
Returns
- (::String) — Suggested reply for the agent to respond to the customer.
#tool_calls
def tool_calls() -> ::Array<::Google::Cloud::Dialogflow::V2::ToolCallSuggestion>
Returns
- (::Array<::Google::Cloud::Dialogflow::V2::ToolCallSuggestion>) — Optional. Rich structured tool calls and their associated citations delivered directly as suggestions.
#tool_calls=
def tool_calls=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::ToolCallSuggestion>
Parameter
- value (::Array<::Google::Cloud::Dialogflow::V2::ToolCallSuggestion>) — Optional. Rich structured tool calls and their associated citations delivered directly as suggestions.
Returns
- (::Array<::Google::Cloud::Dialogflow::V2::ToolCallSuggestion>) — Optional. Rich structured tool calls and their associated citations delivered directly as suggestions.
#triggering_tool_call_answer_records
def triggering_tool_call_answer_records() -> ::Array<::String>
Returns
-
(::Array<::String>) — Optional. The AnswerRecords of the tool calls that triggered this
guidance.
Format:
projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>.
#triggering_tool_call_answer_records=
def triggering_tool_call_answer_records=(value) -> ::Array<::String>
Parameter
-
value (::Array<::String>) — Optional. The AnswerRecords of the tool calls that triggered this
guidance.
Format:
projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>.
Returns
-
(::Array<::String>) — Optional. The AnswerRecords of the tool calls that triggered this
guidance.
Format:
projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>.