Package com.google.cloud.contactcenterinsights.v1

Interface FaqAnswerDataOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    FaqAnswerData, FaqAnswerData.Builder
    public interface FaqAnswerDataOrBuilder
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 FAQ answer and the document that it originates from.
      String getAnswer()
      The piece of text from the `source` knowledge base document.
      com.google.protobuf.ByteString getAnswerBytes()
      The piece of text from the `source` knowledge base document.
      float getConfidenceScore()
      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).
      Map<String,​String> getMetadata()
      Deprecated.
      int getMetadataCount()
      Map that contains metadata about the FAQ answer and the document that it originates from.
      Map<String,​String> getMetadataMap()
      Map that contains metadata about the FAQ answer and the document that it originates from.
      String getMetadataOrDefault​(String key, String defaultValue)
      Map that contains metadata about the FAQ answer and the document that it originates from.
      String getMetadataOrThrow​(String key)
      Map that contains metadata about the FAQ answer 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 getQuestion()
      The corresponding FAQ question.
      com.google.protobuf.ByteString getQuestionBytes()
      The corresponding FAQ question.
      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.

      • 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

      • getAnswer

        String getAnswer()
         The piece of text from the `source` knowledge base document.
        string answer = 1;
        Returns:
        The answer.

      • getAnswerBytes

        com.google.protobuf.ByteString getAnswerBytes()
         The piece of text from the `source` knowledge base document.
        string answer = 1;
        Returns:
        The bytes for answer.

      • getConfidenceScore

        float getConfidenceScore()
         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).
        float confidence_score = 2;
        Returns:
        The confidenceScore.

      • getQuestion

        String getQuestion()
         The corresponding FAQ question.
        string question = 3;
        Returns:
        The question.

      • getQuestionBytes

        com.google.protobuf.ByteString getQuestionBytes()
         The corresponding FAQ question.
        string question = 3;
        Returns:
        The bytes for question.

      • getMetadataCount

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

      • containsMetadata

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

      • getMetadataMap

        Map<String,​String> getMetadataMap()
         Map that contains metadata about the FAQ answer 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 FAQ answer and the document that
 it originates from.
        map<string, string> metadata = 4;

      • getMetadataOrThrow

        String getMetadataOrThrow​(String key)
         Map that contains metadata about the FAQ answer 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.