|
30 | 30 | {"shape":"InternalServiceException"}, |
31 | 31 | {"shape":"ThrottlingException"} |
32 | 32 | ], |
33 | | - "documentation":"<p>Provides a list of analysis segments for a real-time analysis session.</p>" |
| 33 | + "documentation":"<p>Provides a list of analysis segments for a real-time analysis session for voice.</p> <note> <p>Voice data is retained for 24 hours. You must invoke this API during that time.</p> </note>" |
34 | 34 | } |
35 | 35 | }, |
36 | 36 | "shapes":{ |
|
107 | 107 | "min":1, |
108 | 108 | "pattern":".*\\S.*" |
109 | 109 | }, |
| 110 | + "ExtractedInformation":{ |
| 111 | + "type":"structure", |
| 112 | + "required":[ |
| 113 | + "ExtractionDefinitionId", |
| 114 | + "ExtractionDefinitionName" |
| 115 | + ], |
| 116 | + "members":{ |
| 117 | + "ExtractionDefinitionId":{ |
| 118 | + "shape":"ExtractionDefinitionId", |
| 119 | + "documentation":"<p>The identifier of the extraction definition that produced this result.</p>" |
| 120 | + }, |
| 121 | + "ExtractionDefinitionName":{ |
| 122 | + "shape":"ExtractionDefinitionName", |
| 123 | + "documentation":"<p>The name of the extraction definition that produced this result.</p>" |
| 124 | + }, |
| 125 | + "ExtractionDefinitionDisplayLabel":{ |
| 126 | + "shape":"ExtractionDefinitionDisplayLabel", |
| 127 | + "documentation":"<p>The display label of the extraction definition that produced this result.</p>" |
| 128 | + }, |
| 129 | + "ExtractedValues":{ |
| 130 | + "shape":"ExtractedInformationValues", |
| 131 | + "documentation":"<p>The list of values extracted from the conversation for this extraction definition. This field is empty when a <code>FailureCode</code> is present.</p>" |
| 132 | + }, |
| 133 | + "FailureCode":{ |
| 134 | + "shape":"ExtractedInformationFailureCode", |
| 135 | + "documentation":"<p>If the information failed to be extracted, one of the following failure codes occurs:</p> <ul> <li> <p> <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached your service quota.</p> </li> <li> <p> <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: Information extraction requires a conversation with at least one turn from each participant.</p> </li> <li> <p> <code>FAILED_SAFETY_GUIDELINES</code>: The extracted information cannot be provided because it failed to meet system safety guidelines.</p> </li> <li> <p> <code>INTERNAL_ERROR</code>: Internal system error.</p> </li> <li> <p> <code>MAX_PACKAGE_FEATURE_ONLY</code>: Information extraction is only available in Amazon Connect Customer instances.</p> </li> </ul>" |
| 136 | + } |
| 137 | + }, |
| 138 | + "documentation":"<p>Segment containing information extracted from the conversation. Each segment represents the results for a single extraction definition.</p>" |
| 139 | + }, |
| 140 | + "ExtractedInformationContent":{ |
| 141 | + "type":"string", |
| 142 | + "max":1024, |
| 143 | + "min":1 |
| 144 | + }, |
| 145 | + "ExtractedInformationFailureCode":{ |
| 146 | + "type":"string", |
| 147 | + "enum":[ |
| 148 | + "QUOTA_EXCEEDED", |
| 149 | + "INSUFFICIENT_CONVERSATION_CONTENT", |
| 150 | + "FAILED_SAFETY_GUIDELINES", |
| 151 | + "INTERNAL_ERROR", |
| 152 | + "MAX_PACKAGE_FEATURE_ONLY" |
| 153 | + ] |
| 154 | + }, |
| 155 | + "ExtractedInformationValue":{ |
| 156 | + "type":"structure", |
| 157 | + "required":[ |
| 158 | + "Content", |
| 159 | + "PointsOfInterest" |
| 160 | + ], |
| 161 | + "members":{ |
| 162 | + "Content":{ |
| 163 | + "shape":"ExtractedInformationContent", |
| 164 | + "documentation":"<p>The text content of the extracted value.</p>" |
| 165 | + }, |
| 166 | + "PointsOfInterest":{ |
| 167 | + "shape":"PointsOfInterest", |
| 168 | + "documentation":"<p>The sections in the conversation that indicate where the extracted value was found.</p>" |
| 169 | + } |
| 170 | + }, |
| 171 | + "documentation":"<p>An individual value extracted from the conversation, including its content and the locations where it was found.</p>" |
| 172 | + }, |
| 173 | + "ExtractedInformationValues":{ |
| 174 | + "type":"list", |
| 175 | + "member":{"shape":"ExtractedInformationValue"} |
| 176 | + }, |
| 177 | + "ExtractionDefinitionDisplayLabel":{ |
| 178 | + "type":"string", |
| 179 | + "max":25, |
| 180 | + "min":0 |
| 181 | + }, |
| 182 | + "ExtractionDefinitionId":{ |
| 183 | + "type":"string", |
| 184 | + "max":256, |
| 185 | + "min":1, |
| 186 | + "pattern":".*\\S.*" |
| 187 | + }, |
| 188 | + "ExtractionDefinitionName":{ |
| 189 | + "type":"string", |
| 190 | + "max":200, |
| 191 | + "min":1, |
| 192 | + "pattern":".*\\S.*" |
| 193 | + }, |
110 | 194 | "InstanceId":{ |
111 | 195 | "type":"string", |
112 | 196 | "max":256, |
|
238 | 322 | "members":{ |
239 | 323 | "BeginOffsetMillis":{ |
240 | 324 | "shape":"OffsetMillis", |
241 | | - "documentation":"<p>The beginning offset in milliseconds where the category rule was detected.</p>" |
| 325 | + "documentation":"<p>The beginning offset (in milliseconds) where the match was detected.</p>" |
242 | 326 | }, |
243 | 327 | "EndOffsetMillis":{ |
244 | 328 | "shape":"OffsetMillis", |
245 | | - "documentation":"<p>The ending offset in milliseconds where the category rule was detected.</p>" |
| 329 | + "documentation":"<p>The ending offset (in milliseconds) where the match was detected.</p>" |
246 | 330 | } |
247 | 331 | }, |
248 | | - "documentation":"<p>The section of the contact audio where that category rule was detected.</p>" |
| 332 | + "documentation":"<p>The section of the contact audio where a match was detected.</p>" |
249 | 333 | }, |
250 | 334 | "PointsOfInterest":{ |
251 | 335 | "type":"list", |
|
308 | 392 | "PostContactSummary":{ |
309 | 393 | "shape":"PostContactSummary", |
310 | 394 | "documentation":"<p>Information about the post-contact summary.</p>" |
| 395 | + }, |
| 396 | + "ExtractedInformation":{ |
| 397 | + "shape":"ExtractedInformation", |
| 398 | + "documentation":"<p>The extracted information from the conversation.</p>" |
311 | 399 | } |
312 | 400 | }, |
313 | 401 | "documentation":"<p>An analyzed segment for a real-time analysis session.</p>" |
|
0 commit comments