Google Cloud Contact Center Insights V1 Client - Class FaqAnswerData (1.5.0)

Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class FaqAnswerData.

Agent Assist frequently-asked-question answer data.

Generated from protobuf message google.cloud.contactcenterinsights.v1.FaqAnswerData

Namespace

Google \ Cloud \ ContactCenterInsights \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ 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).

↳ question string

The corresponding FAQ question.

↳ metadata array|Google\Protobuf\Internal\MapField

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

↳ query_record string

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

↳ source string

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

getAnswer

The piece of text from the source knowledge base document.

Returns
TypeDescription
string

setAnswer

The piece of text from the source knowledge base document.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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).

Returns
TypeDescription
float

setConfidenceScore

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).

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getQuestion

The corresponding FAQ question.

Returns
TypeDescription
string

setQuestion

The corresponding FAQ question.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMetadata

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

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setMetadata

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

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getQueryRecord

The name of the answer record.

Format: projects/{project}/locations/{location}/answerRecords/{answer_record}

Returns
TypeDescription
string

setQueryRecord

The name of the answer record.

Format: projects/{project}/locations/{location}/answerRecords/{answer_record}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSource

The knowledge document that this answer was extracted from.

Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.

Returns
TypeDescription
string

setSource

The knowledge document that this answer was extracted from.

Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this