File: contactcenterinsights_v1.projects.locations.conversations.segments.html

package info (click to toggle)
python-googleapi 2.187.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 562,316 kB
  • sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (162 lines) | stat: -rw-r--r-- 8,339 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<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.conversations.html">conversations</a> . <a href="contactcenterinsights_v1.projects.locations.conversations.segments.html">segments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#bulkAnalyze">bulkAnalyze(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Analyzes multiple conversations in a single request.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="bulkAnalyze">bulkAnalyze(parent, body=None, x__xgafv=None)</code>
  <pre>Analyzes multiple conversations in a single request.

Args:
  parent: string, Required. The parent resource to create analyses in. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request to analyze conversations in bulk.
  &quot;analysisPercentage&quot;: 3.14, # Required. Percentage of selected conversation to analyze, between [0, 100].
  &quot;annotatorSelector&quot;: { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
    &quot;issueModels&quot;: [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
      &quot;A String&quot;,
    ],
    &quot;phraseMatchers&quot;: [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
      &quot;A String&quot;,
    ],
    &quot;qaConfig&quot;: { # Configuration for the QA feature. # Configuration for the QA annotator.
      &quot;scorecardList&quot;: { # Container for a list of scorecards. # A manual list of scorecards to score.
        &quot;qaScorecardRevisions&quot;: [ # List of QaScorecardRevisions.
          &quot;A String&quot;,
        ],
      },
    },
    &quot;runEntityAnnotator&quot;: True or False, # Whether to run the entity annotator.
    &quot;runIntentAnnotator&quot;: True or False, # Whether to run the intent annotator.
    &quot;runInterruptionAnnotator&quot;: True or False, # Whether to run the interruption annotator.
    &quot;runIssueModelAnnotator&quot;: True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
    &quot;runPhraseMatcherAnnotator&quot;: True or False, # Whether to run the active phrase matcher annotator(s).
    &quot;runQaAnnotator&quot;: True or False, # Whether to run the QA annotator.
    &quot;runSentimentAnnotator&quot;: True or False, # Whether to run the sentiment annotator.
    &quot;runSilenceAnnotator&quot;: True or False, # Whether to run the silence annotator.
    &quot;runSummarizationAnnotator&quot;: True or False, # Whether to run the summarization annotator.
    &quot;summarizationConfig&quot;: { # Configuration for summarization. # Configuration for the summarization annotator.
      &quot;conversationProfile&quot;: &quot;A String&quot;, # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
      &quot;generator&quot;: &quot;A String&quot;, # The resource name of the existing created generator. Format: projects//locations//generators/
      &quot;summarizationModel&quot;: &quot;A String&quot;, # Default summarization model to be used.
    },
  },
  &quot;filter&quot;: &quot;A String&quot;, # Required. Filter used to select the subset of conversations to analyze.
  &quot;parent&quot;: &quot;A String&quot;, # Required. The parent resource to create analyses in.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

</body></html>