Blame - docs/dyn/contactcenterinsights_v1.projects.locations.phraseMatchers.html - platform/external/python/google-api-python-client

<h1><a href="contactcenterinsights_v1.html">Contact Center AI Insights API</a> . <a href="contactcenterinsights_v1.projects.html">projects</a> . <a href="contactcenterinsights_v1.projects.locations.html">locations</a> . <a href="contactcenterinsights_v1.projects.locations.phraseMatchers.html">phraseMatchers</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

81

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Creates a phrase matcher.</p>

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes a phrase matcher.</p>

86

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Gets a phrase matcher.</p>

89

90

<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

91

<p class="firstline">Lists phrase matchers.</p>

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

<h3>Method Details</h3>

96

97

<code class="details" id="close">close()</code>

98

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

103

<pre>Creates a phrase matcher.

104

105

Args:

106

parent: string, Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/` (required)

107

body: object, The request body.

108

The object takes the form of:

109

110

{ # The phrase matcher resource.

111

"activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated.

112

"active": True or False, # Applies the phrase matcher only when it is active.

113

"displayName": "A String", # The human-readable name of the phrase matcher.

114

"name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

115

"phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher.

116

{ # A message representing a rule in the phrase matcher.

117

"phraseMatchRules": [ # A list of phase match rules that are included in this group.

118

{ # The data for a phrase match rule.

119

"config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.

120

"exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule.

121

"caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match.

122

},

123

},

124

"negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.

125

"query": "A String", # Required. The phrase to be matched.

126

},

127

],

128

"type": "A String", # Required. The type of this phrase match rule group.

129

},

130

],

131

"revisionCreateTime": "A String", # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.

132

"revisionId": "A String", # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567

133

"roleMatch": "A String", # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.

134

"type": "A String", # Required. The type of this phrase matcher.

135

"versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.

136

}

137

138

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

145

146

{ # The phrase matcher resource.

147

"activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated.

148

"active": True or False, # Applies the phrase matcher only when it is active.

149

"displayName": "A String", # The human-readable name of the phrase matcher.

150

"name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

151

"phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher.

152

{ # A message representing a rule in the phrase matcher.

153

"phraseMatchRules": [ # A list of phase match rules that are included in this group.

154

{ # The data for a phrase match rule.

155

"config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.

156

"exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule.

157

"caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match.

158

},

159

},

160

"negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.

161

"query": "A String", # Required. The phrase to be matched.

162

},

163

],

164

"type": "A String", # Required. The type of this phrase match rule group.

165

},

166

],

167

"revisionCreateTime": "A String", # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.

168

"revisionId": "A String", # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567

169

"roleMatch": "A String", # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.

170

"type": "A String", # Required. The type of this phrase matcher.

171

"versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

177

<pre>Deletes a phrase matcher.

178

179

Args:

180

name: string, Required. The name of the phrase matcher to delete. (required)

181

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

188

189

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

195

<pre>Gets a phrase matcher.

196

197

Args:

198

name: string, Required. The name of the phrase matcher to get. (required)

199

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

206

207

{ # The phrase matcher resource.

208

"activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated.

209

"active": True or False, # Applies the phrase matcher only when it is active.

210

"displayName": "A String", # The human-readable name of the phrase matcher.

211

"name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

212

"phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher.

213

{ # A message representing a rule in the phrase matcher.

214

"phraseMatchRules": [ # A list of phase match rules that are included in this group.

215

{ # The data for a phrase match rule.

216

"config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.

217

"exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule.

218

"caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match.

219

},

220

},

221

"negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.

222

"query": "A String", # Required. The phrase to be matched.

223

},

224

],

225

"type": "A String", # Required. The type of this phrase match rule group.

226

},

227

],

228

"revisionCreateTime": "A String", # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.

229

"revisionId": "A String", # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567

230

"roleMatch": "A String", # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.

231

"type": "A String", # Required. The type of this phrase matcher.

232

"versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.

}</pre>

</div>

<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

238

<pre>Lists phrase matchers.

239

240

Args:

241

parent: string, Required. The parent resource of the phrase matcher. (required)

242

filter: string, A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties.

243

pageSize: integer, The maximum number of phrase matchers to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.

244

pageToken: string, The value returned by the last `ListPhraseMatchersResponse`. This value indicates that this is a continuation of a prior `ListPhraseMatchers` call and that the system should return the next page of data.

245

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

252

253

{ # The response of listing phrase matchers.

254

"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

255

"phraseMatchers": [ # The phrase matchers that match the request.

256

{ # The phrase matcher resource.

257

"activationUpdateTime": "A String", # Output only. The most recent time at which the activation status was updated.

258

"active": True or False, # Applies the phrase matcher only when it is active.

259

"displayName": "A String", # The human-readable name of the phrase matcher.

260

"name": "A String", # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

261

"phraseMatchRuleGroups": [ # A list of phase match rule groups that are included in this matcher.

262

{ # A message representing a rule in the phrase matcher.

263

"phraseMatchRules": [ # A list of phase match rules that are included in this group.

264

{ # The data for a phrase match rule.

265

"config": { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.

266

"exactMatchConfig": { # Exact match configuration. # The configuration for the exact match rule.

267

"caseSensitive": True or False, # Whether to consider case sensitivity when performing an exact match.

268

},

269

},

270

"negated": True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.

271

"query": "A String", # Required. The phrase to be matched.

272

},

273

],

274

"type": "A String", # Required. The type of this phrase match rule group.

275

},

276

],

277

"revisionCreateTime": "A String", # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.

278

"revisionId": "A String", # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567

279

"roleMatch": "A String", # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.

280

"type": "A String", # Required. The type of this phrase matcher.

281

"versionTag": "A String", # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.

},

],

}</pre>

</div>