Package com.google.cloud.contactcenterinsights.v1

Class FaqAnswerData

  • All Implemented Interfaces:
    FaqAnswerDataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class FaqAnswerData
extends com.google.protobuf.GeneratedMessageV3
implements FaqAnswerDataOrBuilder
     Agent Assist frequently-asked-question answer data.
    Protobuf type google.cloud.contactcenterinsights.v1.FaqAnswerData
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FaqAnswerData.Builder
      Agent Assist frequently-asked-question answer data.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getAnswer

        public String getAnswer()
         The piece of text from the `source` knowledge base document.
        string answer = 1;
        Specified by:
        getAnswer in interface FaqAnswerDataOrBuilder
        Returns:
        The answer.

      • getAnswerBytes

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

      • getConfidenceScore

        public 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;
        Specified by:
        getConfidenceScore in interface FaqAnswerDataOrBuilder
        Returns:
        The confidenceScore.

      • getQuestionBytes

        public com.google.protobuf.ByteString getQuestionBytes()
         The corresponding FAQ question.
        string question = 3;
        Specified by:
        getQuestionBytes in interface FaqAnswerDataOrBuilder
        Returns:
        The bytes for question.

      • getMetadataCount

        public int getMetadataCount()
        Description copied from interface: FaqAnswerDataOrBuilder
         Map that contains metadata about the FAQ answer and the document that
 it originates from.
        map<string, string> metadata = 4;
        Specified by:
        getMetadataCount in interface FaqAnswerDataOrBuilder

      • containsMetadata

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

      • getMetadataMap

        public Map<String,​String> getMetadataMap()
         Map that contains metadata about the FAQ answer and the document that
 it originates from.
        map<string, string> metadata = 4;
        Specified by:
        getMetadataMap in interface FaqAnswerDataOrBuilder

      • getMetadataOrThrow

        public String getMetadataOrThrow​(String key)
         Map that contains metadata about the FAQ answer and the document that
 it originates from.
        map<string, string> metadata = 4;
        Specified by:
        getMetadataOrThrow in interface FaqAnswerDataOrBuilder

      • getQueryRecord

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

      • getQueryRecordBytes

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

      • getSource

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

      • getSourceBytes

        public 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;
        Specified by:
        getSourceBytes in interface FaqAnswerDataOrBuilder
        Returns:
        The bytes for source.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static FaqAnswerData parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FaqAnswerData parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FaqAnswerData parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FaqAnswerData parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FaqAnswerData parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FaqAnswerData parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FaqAnswerData parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public FaqAnswerData.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public FaqAnswerData.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected FaqAnswerData.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static FaqAnswerData getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<FaqAnswerData> parser()

      • getParserForType

        public com.google.protobuf.Parser<FaqAnswerData> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public FaqAnswerData getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder