Google Cloud Contact Center Insights V1 Client - Class ArticleSuggestionData (2.2.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
Name Description
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
Type Description
string

setTitle

Article title.

Parameter
Name Description
var string
Returns
Type Description
$this

getUri

Article URI.

Returns
Type Description
string

setUri

Article URI.

Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var float
Returns
Type Description
$this

getMetadata

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

Returns
Type Description
Google\Protobuf\Internal\MapField

setMetadata

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getQueryRecord

The name of the answer record.

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

Returns
Type Description
string

setQueryRecord

The name of the answer record.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSource

The knowledge document that this answer was extracted from.

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

Returns
Type Description
string

setSource

The knowledge document that this answer was extracted from.

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

Parameter
Name Description
var string
Returns
Type Description
$this