Package com.google.cloud.contactcenterinsights.v1

Interface ArticleSuggestionDataOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ArticleSuggestionData, ArticleSuggestionData.Builder
    public interface ArticleSuggestionDataOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsMetadata​(String key)
      Map that contains metadata about the Article Suggestion and the document that it originates from.
      float getConfidenceScore()
      The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
      Map<String,​String> getMetadata()
      Deprecated.
      int getMetadataCount()
      Map that contains metadata about the Article Suggestion and the document that it originates from.
      Map<String,​String> getMetadataMap()
      Map that contains metadata about the Article Suggestion and the document that it originates from.
      String getMetadataOrDefault​(String key, String defaultValue)
      Map that contains metadata about the Article Suggestion and the document that it originates from.
      String getMetadataOrThrow​(String key)
      Map that contains metadata about the Article Suggestion and the document that it originates from.
      String getQueryRecord()
      The name of the answer record.
      com.google.protobuf.ByteString getQueryRecordBytes()
      The name of the answer record.
      String getSource()
      The knowledge document that this answer was extracted from.
      com.google.protobuf.ByteString getSourceBytes()
      The knowledge document that this answer was extracted from.
      String getTitle()
      Article title.
      com.google.protobuf.ByteString getTitleBytes()
      Article title.
      String getUri()
      Article URI.
      com.google.protobuf.ByteString getUriBytes()
      Article URI.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getTitle

        String getTitle()
         Article title.
        string title = 1;
        Returns:
        The title.

      • getTitleBytes

        com.google.protobuf.ByteString getTitleBytes()
         Article title.
        string title = 1;
        Returns:
        The bytes for title.

      • getUri

        String getUri()
         Article URI.
        string uri = 2;
        Returns:
        The uri.

      • getUriBytes

        com.google.protobuf.ByteString getUriBytes()
         Article URI.
        string uri = 2;
        Returns:
        The bytes for uri.

      • getConfidenceScore

        float getConfidenceScore()
         The system's confidence score that this article is a good match for this
 conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
 certain).
        float confidence_score = 3;
        Returns:
        The confidenceScore.

      • getMetadataCount

        int getMetadataCount()
         Map that contains metadata about the Article Suggestion and the document
 that it originates from.
        map<string, string> metadata = 4;

      • containsMetadata

        boolean containsMetadata​(String key)
         Map that contains metadata about the Article Suggestion and the document
 that it originates from.
        map<string, string> metadata = 4;

      • getMetadataMap

        Map<String,​String> getMetadataMap()
         Map that contains metadata about the Article Suggestion and the document
 that it originates from.
        map<string, string> metadata = 4;

      • getMetadataOrDefault

        String getMetadataOrDefault​(String key,
                            String defaultValue)
         Map that contains metadata about the Article Suggestion and the document
 that it originates from.
        map<string, string> metadata = 4;

      • getMetadataOrThrow

        String getMetadataOrThrow​(String key)
         Map that contains metadata about the Article Suggestion and the document
 that it originates from.
        map<string, string> metadata = 4;

      • getQueryRecord

        String getQueryRecord()
         The name of the answer record.
 Format:
 projects/{project}/locations/{location}/answerRecords/{answer_record}
        string query_record = 5;
        Returns:
        The queryRecord.

      • getQueryRecordBytes

        com.google.protobuf.ByteString getQueryRecordBytes()
         The name of the answer record.
 Format:
 projects/{project}/locations/{location}/answerRecords/{answer_record}
        string query_record = 5;
        Returns:
        The bytes for queryRecord.

      • getSource

        String getSource()
         The knowledge document that this answer was extracted from.
 Format:
 projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
        string source = 6;
        Returns:
        The source.

      • getSourceBytes

        com.google.protobuf.ByteString getSourceBytes()
         The knowledge document that this answer was extracted from.
 Format:
 projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
        string source = 6;
        Returns:
        The bytes for source.