Google Cloud Contact Center Insights V1 Client - Class CalculateStatsResponse (1.2.1)

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

The response for calculating conversation statistics.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ average_duration Google\Protobuf\Duration

The average duration of all conversations. The average is calculated using only conversations that have a time duration.

↳ average_turn_count int

The average number of turns per conversation.

↳ conversation_count int

The total number of conversations.

↳ smart_highlighter_matches array|Google\Protobuf\Internal\MapField

A map associating each smart highlighter display name with its respective number of matches in the set of conversations.

↳ custom_highlighter_matches array|Google\Protobuf\Internal\MapField

A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.

↳ issue_matches array|Google\Protobuf\Internal\MapField

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID> Deprecated, use issue_matches_stats field instead.

↳ issue_matches_stats array|Google\Protobuf\Internal\MapField

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>

↳ conversation_count_time_series Google\Cloud\ContactCenterInsights\V1\CalculateStatsResponse\TimeSeries

A time series representing the count of conversations created over time that match that requested filter criteria.

getAverageDuration

The average duration of all conversations. The average is calculated using only conversations that have a time duration.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasAverageDuration

clearAverageDuration

setAverageDuration

The average duration of all conversations. The average is calculated using only conversations that have a time duration.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getAverageTurnCount

The average number of turns per conversation.

Returns
TypeDescription
int

setAverageTurnCount

The average number of turns per conversation.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getConversationCount

The total number of conversations.

Returns
TypeDescription
int

setConversationCount

The total number of conversations.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSmartHighlighterMatches

A map associating each smart highlighter display name with its respective number of matches in the set of conversations.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setSmartHighlighterMatches

A map associating each smart highlighter display name with its respective number of matches in the set of conversations.

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

getCustomHighlighterMatches

A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setCustomHighlighterMatches

A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.

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

getIssueMatches

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID> Deprecated, use issue_matches_stats field instead.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setIssueMatches

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID> Deprecated, use issue_matches_stats field instead.

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

getIssueMatchesStats

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setIssueMatchesStats

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>

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

getConversationCountTimeSeries

A time series representing the count of conversations created over time that match that requested filter criteria.

Returns
TypeDescription
Google\Cloud\ContactCenterInsights\V1\CalculateStatsResponse\TimeSeries|null

hasConversationCountTimeSeries

clearConversationCountTimeSeries

setConversationCountTimeSeries

A time series representing the count of conversations created over time that match that requested filter criteria.

Parameter
NameDescription
var Google\Cloud\ContactCenterInsights\V1\CalculateStatsResponse\TimeSeries
Returns
TypeDescription
$this