Class: Google::Cloud::ContactCenterInsights::V1::FaqAnswerData

Inherits:

Object

• Object
• Google::Cloud::ContactCenterInsights::V1::FaqAnswerData

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/contactcenterinsights/v1/resources.rb

Overview

Agent Assist frequently-asked-question answer data.

Defined Under Namespace

Classes: MetadataEntry

Instance Attribute Summary

• #answer ⇒ ::String

  The piece of text from the source knowledge base document.

• #confidence_score ⇒ ::Float

  The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).

• #metadata ⇒ ::Google::Protobuf::Map{::String => ::String}

  Map that contains metadata about the FAQ answer and the document that it originates from.

• #query_record ⇒ ::String

  The name of the answer record.

• #question ⇒ ::String

  The corresponding FAQ question.

• #source ⇒ ::String

  The knowledge document that this answer was extracted from.

Instance Attribute Details

#answer ⇒ ::String

Returns The piece of text from the source knowledge base document.

Returns:

• (::String) —

  The piece of text from the source knowledge base document.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1120

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#confidence_score ⇒ ::Float

Returns The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).

Returns:

• (::Float) —

  The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1120

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metadata ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Map that contains metadata about the FAQ answer and the document that it originates from.

Returns:

• (::Google::Protobuf::Map{::String => ::String}) —

  Map that contains metadata about the FAQ answer and the document that it originates from.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1120

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query_record ⇒ ::String

Returns The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}.

Returns:

• (::String) —

  The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1120

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#question ⇒ ::String

Returns The corresponding FAQ question.

Returns:

• (::String) —

  The corresponding FAQ question.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1120

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#source ⇒ ::String

Returns The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.

Returns:

• (::String) —

  The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1120

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end