Google Cloud Contact Center Insights V1 Client - Class ArticleSuggestionData (1.8.0)

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

Agent Assist Article Suggestion data.

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

Namespace

Google \ Cloud \ ContactCenterInsights \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ title string

Article title.

↳ uri string

Article URI.

↳ confidence_score float

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

↳ metadata array|Google\Protobuf\Internal\MapField

Map that contains metadata about the Article Suggestion 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}

getTitle

Article title.

Returns
TypeDescription
string

setTitle

Article title.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUri

Article URI.

Returns
TypeDescription
string

setUri

Article URI.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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

Returns
TypeDescription
float

setConfidenceScore

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

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getMetadata

Map that contains metadata about the Article Suggestion and the document that it originates from.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setMetadata

Map that contains metadata about the Article Suggestion 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