Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListTestSetRecords

The list of test set records.

Request Syntax


POST /testsets/testSetId/records HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

testSetId

The identifier of the test set to list its test set records.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

maxResults

The maximum number of test set records to return in each page. If there are fewer records than the max page size, only the actual number of records are returned.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

If the response from the ListTestSetRecords 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.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "testSetRecords": [ 
      { 
         "conversationId": "string",
         "recordNumber": number,
         "turnNumber": number,
         "turnSpecification": { 
            "agentTurn": { 
               "agentPrompt": "string"
            },
            "userTurn": { 
               "expected": { 
                  "activeContexts": [ 
                     { 
                        "name": "string"
                     }
                  ],
                  "intent": { 
                     "name": "string",
                     "slots": { 
                        "string" : { 
                           "subSlots": { 
                              "string" : "UserTurnSlotOutput"
                           },
                           "value": "string",
                           "values": [ 
                              "UserTurnSlotOutput"
                           ]
                        }
                     }
                  },
                  "transcript": "string"
               },
               "input": { 
                  "requestAttributes": { 
                     "string" : "string" 
                  },
                  "sessionState": { 
                     "activeContexts": [ 
                        { 
                           "name": "string"
                        }
                     ],
                     "runtimeHints": { 
                        "slotHints": { 
                           "string" : { 
                              "string" : { 
                                 "runtimeHintValues": [ 
                                    { 
                                       "phrase": "string"
                                    }
                                 ],
                                 "subSlotHints": { 
                                    "string" : "RuntimeHintDetails"
                                 }
                              }
                           }
                        }
                     },
                     "sessionAttributes": { 
                        "string" : "string" 
                     }
                  },
                  "utteranceInput": { 
                     "audioInput": { 
                        "audioFileS3Location": "string"
                     },
                     "textInput": "string"
                  }
               }
            }
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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

Type: String

testSetRecords

The list of records from the test set.

Type: Array of TestSetTurnRecord objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 404

ServiceQuotaExceededException

You have reached a quota for your bot.

HTTP Status Code: 402

ThrottlingException

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

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400