Class: Google::Cloud::DiscoveryEngine::V1::AssistAnswer

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb

Overview

AssistAnswer resource, main part of [AssistResponse][google.cloud.discoveryengine.v1.AssistResponse].

Defined Under Namespace

Modules: AssistSkippedReason, State Classes: Reply

Instance Attribute Summary collapse

Instance Attribute Details

#assist_skipped_reasons ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::AssistSkippedReason>

Returns Reasons for not answering the assist call.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb', line 43

class AssistAnswer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # One part of the multi-part response of the assist call.
  # @!attribute [rw] grounded_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent]
  #     Possibly grounded response text or media from the assistant.
  class Reply
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the answer generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Assist operation is currently in progress.
    IN_PROGRESS = 1

    # Assist operation has failed.
    FAILED = 2

    # Assist operation has succeeded.
    SUCCEEDED = 3

    # Assist operation has been skipped.
    SKIPPED = 4
  end

  # Possible reasons for not answering an assist call.
  module AssistSkippedReason
    # Default value. Skip reason is not specified.
    ASSIST_SKIPPED_REASON_UNSPECIFIED = 0

    # The assistant ignored the query, because it did not appear to be
    # answer-seeking.
    NON_ASSIST_SEEKING_QUERY_IGNORED = 1

    # The assistant ignored the query or refused to answer because of a
    # customer policy violation (e.g., the query or the answer contained a
    # banned phrase).
    CUSTOMER_POLICY_VIOLATION = 2
  end
end

#name ⇒ ::String

Returns Immutable. Resource name of the AssistAnswer. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Returns:

  • (::String) —

    Immutable. Resource name of the AssistAnswer. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

    This field must be a UTF-8 encoded string with a length limit of 1024 characters.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb', line 43

class AssistAnswer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # One part of the multi-part response of the assist call.
  # @!attribute [rw] grounded_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent]
  #     Possibly grounded response text or media from the assistant.
  class Reply
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the answer generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Assist operation is currently in progress.
    IN_PROGRESS = 1

    # Assist operation has failed.
    FAILED = 2

    # Assist operation has succeeded.
    SUCCEEDED = 3

    # Assist operation has been skipped.
    SKIPPED = 4
  end

  # Possible reasons for not answering an assist call.
  module AssistSkippedReason
    # Default value. Skip reason is not specified.
    ASSIST_SKIPPED_REASON_UNSPECIFIED = 0

    # The assistant ignored the query, because it did not appear to be
    # answer-seeking.
    NON_ASSIST_SEEKING_QUERY_IGNORED = 1

    # The assistant ignored the query or refused to answer because of a
    # customer policy violation (e.g., the query or the answer contained a
    # banned phrase).
    CUSTOMER_POLICY_VIOLATION = 2
  end
end

#replies ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::Reply>

Returns Replies of the assistant.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb', line 43

class AssistAnswer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # One part of the multi-part response of the assist call.
  # @!attribute [rw] grounded_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent]
  #     Possibly grounded response text or media from the assistant.
  class Reply
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the answer generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Assist operation is currently in progress.
    IN_PROGRESS = 1

    # Assist operation has failed.
    FAILED = 2

    # Assist operation has succeeded.
    SUCCEEDED = 3

    # Assist operation has been skipped.
    SKIPPED = 4
  end

  # Possible reasons for not answering an assist call.
  module AssistSkippedReason
    # Default value. Skip reason is not specified.
    ASSIST_SKIPPED_REASON_UNSPECIFIED = 0

    # The assistant ignored the query, because it did not appear to be
    # answer-seeking.
    NON_ASSIST_SEEKING_QUERY_IGNORED = 1

    # The assistant ignored the query or refused to answer because of a
    # customer policy violation (e.g., the query or the answer contained a
    # banned phrase).
    CUSTOMER_POLICY_VIOLATION = 2
  end
end

#state ⇒ ::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::State

Returns State of the answer generation.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb', line 43

class AssistAnswer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # One part of the multi-part response of the assist call.
  # @!attribute [rw] grounded_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent]
  #     Possibly grounded response text or media from the assistant.
  class Reply
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the answer generation.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Assist operation is currently in progress.
    IN_PROGRESS = 1

    # Assist operation has failed.
    FAILED = 2

    # Assist operation has succeeded.
    SUCCEEDED = 3

    # Assist operation has been skipped.
    SKIPPED = 4
  end

  # Possible reasons for not answering an assist call.
  module AssistSkippedReason
    # Default value. Skip reason is not specified.
    ASSIST_SKIPPED_REASON_UNSPECIFIED = 0

    # The assistant ignored the query, because it did not appear to be
    # answer-seeking.
    NON_ASSIST_SEEKING_QUERY_IGNORED = 1

    # The assistant ignored the query or refused to answer because of a
    # customer policy violation (e.g., the query or the answer contained a
    # banned phrase).
    CUSTOMER_POLICY_VIOLATION = 2
  end
end