Class: Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation

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

Overview

An annotation that was generated during the customer and agent interaction.

Defined Under Namespace

Classes: UserInput

Instance Attribute Summary collapse

Instance Attribute Details

#annotation_id ⇒ ::String

Returns The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}.

Returns:

  • (::String) —

    The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#answer_feedback ⇒ ::Google::Cloud::ContactCenterInsights::V1::AnswerFeedback

Returns The feedback that the customer has about the answer in data.

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#article_suggestion ⇒ ::Google::Cloud::ContactCenterInsights::V1::ArticleSuggestionData

Returns Agent Assist Article Suggestion data.

Note: The following fields are mutually exclusive: article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::ContactCenterInsights::V1::ArticleSuggestionData) —

    Agent Assist Article Suggestion data.

    Note: The following fields are mutually exclusive: article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#conversation_summarization_suggestion ⇒ ::Google::Cloud::ContactCenterInsights::V1::ConversationSummarizationSuggestionData

Returns Conversation summarization suggestion data.

Note: The following fields are mutually exclusive: conversation_summarization_suggestion, article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, dialogflow_interaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::ContactCenterInsights::V1::ConversationSummarizationSuggestionData) —

    Conversation summarization suggestion data.

    Note: The following fields are mutually exclusive: conversation_summarization_suggestion, article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, dialogflow_interaction. If a field in that set is populated, all other fields in the set will automatically be cleared.



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns The time at which this annotation was created.

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#dialogflow_interaction ⇒ ::Google::Cloud::ContactCenterInsights::V1::DialogflowInteractionData

Returns Dialogflow interaction data.

Note: The following fields are mutually exclusive: dialogflow_interaction, article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::ContactCenterInsights::V1::DialogflowInteractionData) —

    Dialogflow interaction data.

    Note: The following fields are mutually exclusive: dialogflow_interaction, article_suggestion, faq_answer, smart_reply, smart_compose_suggestion, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#end_boundary ⇒ ::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary

Returns The boundary in the conversation where the annotation ends, inclusive.

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#faq_answer ⇒ ::Google::Cloud::ContactCenterInsights::V1::FaqAnswerData

Returns Agent Assist FAQ answer data.

Note: The following fields are mutually exclusive: faq_answer, article_suggestion, smart_reply, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::ContactCenterInsights::V1::FaqAnswerData) —

    Agent Assist FAQ answer data.

    Note: The following fields are mutually exclusive: faq_answer, article_suggestion, smart_reply, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#smart_compose_suggestion ⇒ ::Google::Cloud::ContactCenterInsights::V1::SmartComposeSuggestionData

Returns Agent Assist Smart Compose suggestion data.

Note: The following fields are mutually exclusive: smart_compose_suggestion, article_suggestion, faq_answer, smart_reply, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::ContactCenterInsights::V1::SmartComposeSuggestionData) —

    Agent Assist Smart Compose suggestion data.

    Note: The following fields are mutually exclusive: smart_compose_suggestion, article_suggestion, faq_answer, smart_reply, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#smart_reply ⇒ ::Google::Cloud::ContactCenterInsights::V1::SmartReplyData

Returns Agent Assist Smart Reply data.

Note: The following fields are mutually exclusive: smart_reply, article_suggestion, faq_answer, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::ContactCenterInsights::V1::SmartReplyData) —

    Agent Assist Smart Reply data.

    Note: The following fields are mutually exclusive: smart_reply, article_suggestion, faq_answer, smart_compose_suggestion, dialogflow_interaction, conversation_summarization_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#start_boundary ⇒ ::Google::Cloud::ContactCenterInsights::V1::AnnotationBoundary

Returns The boundary in the conversation where the annotation starts, inclusive.

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end

#user_input ⇒ ::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput

Returns Explicit input used for generating the answer.

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 1335

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

  # Explicit input used for generating the answer
  # @!attribute [rw] query
  #   @return [::String]
  #     Query text. Article Search uses this to store the input query used
  #     to generate the search results.
  # @!attribute [rw] generator_name
  #   @return [::String]
  #     The resource name of associated generator. Format:
  #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
  # @!attribute [rw] query_source
  #   @return [::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation::UserInput::QuerySource]
  #     Query source for the answer.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The source of the query.
    module QuerySource
      # Unknown query source.
      QUERY_SOURCE_UNSPECIFIED = 0

      # The query is from agents.
      AGENT_QUERY = 1

      # The query is a query from previous suggestions, e.g. from a preceding
      # SuggestKnowledgeAssist response.
      SUGGESTED_QUERY = 2
    end
  end
end