ListTestExecutionResultItemsCommand

Suggest an Edit

Gets a list of test execution result items.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LexModelsV2Client, ListTestExecutionResultItemsCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import
// const { LexModelsV2Client, ListTestExecutionResultItemsCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import
const client = new LexModelsV2Client(config);
const input = { // ListTestExecutionResultItemsRequest
  testExecutionId: "STRING_VALUE", // required
  resultFilterBy: { // TestExecutionResultFilterBy
    resultTypeFilter: "OverallTestResults" || "ConversationLevelTestResults" || "IntentClassificationTestResults" || "SlotResolutionTestResults" || "UtteranceLevelResults", // required
    conversationLevelTestResultsFilterBy: { // ConversationLevelTestResultsFilterBy
      endToEndResult: "Matched" || "Mismatched" || "ExecutionError",
    },
  },
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListTestExecutionResultItemsCommand(input);
const response = await client.send(command);
// { // ListTestExecutionResultItemsResponse
//   testExecutionResults: { // TestExecutionResultItems
//     overallTestResults: { // OverallTestResults
//       items: [ // OverallTestResultItemList // required
//         { // OverallTestResultItem
//           multiTurnConversation: true || false, // required
//           totalResultCount: Number("int"), // required
//           speechTranscriptionResultCounts: { // TestResultMatchStatusCountMap
//             "<keys>": Number("int"),
//           },
//           endToEndResultCounts: { // required
//             "<keys>": Number("int"),
//           },
//         },
//       ],
//     },
//     conversationLevelTestResults: { // ConversationLevelTestResults
//       items: [ // ConversationLevelTestResultItemList // required
//         { // ConversationLevelTestResultItem
//           conversationId: "STRING_VALUE", // required
//           endToEndResult: "Matched" || "Mismatched" || "ExecutionError", // required
//           speechTranscriptionResult: "Matched" || "Mismatched" || "ExecutionError",
//           intentClassificationResults: [ // ConversationLevelIntentClassificationResults // required
//             { // ConversationLevelIntentClassificationResultItem
//               intentName: "STRING_VALUE", // required
//               matchResult: "Matched" || "Mismatched" || "ExecutionError", // required
//             },
//           ],
//           slotResolutionResults: [ // ConversationLevelSlotResolutionResults // required
//             { // ConversationLevelSlotResolutionResultItem
//               intentName: "STRING_VALUE", // required
//               slotName: "STRING_VALUE", // required
//               matchResult: "Matched" || "Mismatched" || "ExecutionError", // required
//             },
//           ],
//         },
//       ],
//     },
//     intentClassificationTestResults: { // IntentClassificationTestResults
//       items: [ // IntentClassificationTestResultItemList // required
//         { // IntentClassificationTestResultItem
//           intentName: "STRING_VALUE", // required
//           multiTurnConversation: true || false, // required
//           resultCounts: { // IntentClassificationTestResultItemCounts
//             totalResultCount: Number("int"), // required
//             speechTranscriptionResultCounts: {
//               "<keys>": Number("int"),
//             },
//             intentMatchResultCounts: { // required
//               "<keys>": Number("int"),
//             },
//           },
//         },
//       ],
//     },
//     intentLevelSlotResolutionTestResults: { // IntentLevelSlotResolutionTestResults
//       items: [ // IntentLevelSlotResolutionTestResultItemList // required
//         { // IntentLevelSlotResolutionTestResultItem
//           intentName: "STRING_VALUE", // required
//           multiTurnConversation: true || false, // required
//           slotResolutionResults: [ // SlotResolutionTestResultItems // required
//             { // SlotResolutionTestResultItem
//               slotName: "STRING_VALUE", // required
//               resultCounts: { // SlotResolutionTestResultItemCounts
//                 totalResultCount: Number("int"), // required
//                 speechTranscriptionResultCounts: "<TestResultMatchStatusCountMap>",
//                 slotMatchResultCounts: "<TestResultMatchStatusCountMap>", // required
//               },
//             },
//           ],
//         },
//       ],
//     },
//     utteranceLevelTestResults: { // UtteranceLevelTestResults
//       items: [ // UtteranceLevelTestResultItemList // required
//         { // UtteranceLevelTestResultItem
//           recordNumber: Number("long"), // required
//           conversationId: "STRING_VALUE",
//           turnResult: { // TestSetTurnResult
//             agent: { // AgentTurnResult
//               expectedAgentPrompt: "STRING_VALUE", // required
//               actualAgentPrompt: "STRING_VALUE",
//               errorDetails: { // ExecutionErrorDetails
//                 errorCode: "STRING_VALUE", // required
//                 errorMessage: "STRING_VALUE", // required
//               },
//               actualElicitedSlot: "STRING_VALUE",
//               actualIntent: "STRING_VALUE",
//             },
//             user: { // UserTurnResult
//               input: { // UserTurnInputSpecification
//                 utteranceInput: { // UtteranceInputSpecification
//                   textInput: "STRING_VALUE",
//                   audioInput: { // UtteranceAudioInputSpecification
//                     audioFileS3Location: "STRING_VALUE", // required
//                   },
//                 },
//                 requestAttributes: { // StringMap
//                   "<keys>": "STRING_VALUE",
//                 },
//                 sessionState: { // InputSessionStateSpecification
//                   sessionAttributes: {
//                     "<keys>": "STRING_VALUE",
//                   },
//                   activeContexts: [ // ActiveContextList
//                     { // ActiveContext
//                       name: "STRING_VALUE", // required
//                     },
//                   ],
//                   runtimeHints: { // RuntimeHints
//                     slotHints: { // SlotHintsIntentMap
//                       "<keys>": { // SlotHintsSlotMap
//                         "<keys>": { // RuntimeHintDetails
//                           runtimeHintValues: [ // RuntimeHintValuesList
//                             { // RuntimeHintValue
//                               phrase: "STRING_VALUE", // required
//                             },
//                           ],
//                           subSlotHints: {
//                             "<keys>": {
//                               runtimeHintValues: [
//                                 {
//                                   phrase: "STRING_VALUE", // required
//                                 },
//                               ],
//                               subSlotHints: "<SlotHintsSlotMap>",
//                             },
//                           },
//                         },
//                       },
//                     },
//                   },
//                 },
//               },
//               expectedOutput: { // UserTurnOutputSpecification
//                 intent: { // UserTurnIntentOutput
//                   name: "STRING_VALUE", // required
//                   slots: { // UserTurnSlotOutputMap
//                     "<keys>": { // UserTurnSlotOutput
//                       value: "STRING_VALUE",
//                       values: [ // UserTurnSlotOutputList
//                         {
//                           value: "STRING_VALUE",
//                           values: [
//                             "<UserTurnSlotOutput>",
//                           ],
//                           subSlots: {
//                             "<keys>": "<UserTurnSlotOutput>",
//                           },
//                         },
//                       ],
//                       subSlots: "<UserTurnSlotOutputMap>",
//                     },
//                   },
//                 },
//                 activeContexts: [
//                   {
//                     name: "STRING_VALUE", // required
//                   },
//                 ],
//                 transcript: "STRING_VALUE",
//               },
//               actualOutput: {
//                 intent: {
//                   name: "STRING_VALUE", // required
//                   slots: "<UserTurnSlotOutputMap>",
//                 },
//                 activeContexts: [
//                   {
//                     name: "STRING_VALUE", // required
//                   },
//                 ],
//                 transcript: "STRING_VALUE",
//               },
//               errorDetails: {
//                 errorCode: "STRING_VALUE", // required
//                 errorMessage: "STRING_VALUE", // required
//               },
//               endToEndResult: "Matched" || "Mismatched" || "ExecutionError",
//               intentMatchResult: "Matched" || "Mismatched" || "ExecutionError",
//               slotMatchResult: "Matched" || "Mismatched" || "ExecutionError",
//               speechTranscriptionResult: "Matched" || "Mismatched" || "ExecutionError",
//               conversationLevelResult: { // ConversationLevelResultDetail
//                 endToEndResult: "Matched" || "Mismatched" || "ExecutionError", // required
//                 speechTranscriptionResult: "Matched" || "Mismatched" || "ExecutionError",
//               },
//             },
//           },
//         },
//       ],
//     },
//   },
//   nextToken: "STRING_VALUE",
// };

ListTestExecutionResultItemsCommand Input

See ListTestExecutionResultItemsCommandInput for more details

Parameter
Type
Description
resultFilterBy
Required
TestExecutionResultFilterBy | undefined

The filter for the list of results from the test set execution.

testExecutionId
Required
string | undefined

The unique identifier of the test execution to list the result items.

maxResults
number | undefined

The maximum number of test execution result items to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.

nextToken
string | undefined

If the response from the ListTestExecutionResultItems operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

ListTestExecutionResultItemsCommand Output

See ListTestExecutionResultItemsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
nextToken
string | undefined

A token that indicates whether there are more results to return in a response to the ListTestExecutionResultItems operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestExecutionResultItems operation request to get the next page of results.

testExecutionResults
TestExecutionResultItems | undefined

The list of results from the test execution.

Throws

Name
Fault
Details
InternalServerException
server

The service encountered an unexpected condition. Try your request again.

ResourceNotFoundException
client

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

ServiceQuotaExceededException
client

You have reached a quota for your bot.

ThrottlingException
client

Your request rate is too high. Reduce the frequency of requests.

ValidationException
client

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

LexModelsV2ServiceException
Base exception class for all service exceptions from LexModelsV2 service.