REST Resource: projects.locations.agents.testCases

Resource: TestCase

Represents a test case.

JSON representation 
{
  "name": string,
  "tags": [
    string
  ],
  "displayName": string,
  "notes": string,
  "testConfig": {
    object (TestConfig)
  },
  "testCaseConversationTurns": [
    {
      object (ConversationTurn)
    }
  ],
  "creationTime": string,
  "lastTestResult": {
    object (TestCaseResult)
  }
}
Fields
name

string

The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: projects/<Project ID>/locations/<LocationID>/agents/ <AgentID>/testCases/<TestCase ID>.
tags[]

string

Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters.
displayName

string

Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.
notes

string

Additional freeform notes about the test case. Limit of 400 characters.
testConfig

object (TestConfig)

Config for the test case.
testCaseConversationTurns[]

object (ConversationTurn)

The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.
creationTime

string (Timestamp format)

Output only. When the test was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastTestResult

object (TestCaseResult)

The latest test result.

TestConfig

Represents configurations for a test case.

JSON representation 
{
  "trackingParameters": [
    string
  ],
  "flow": string,
  "page": string
}
Fields
trackingParameters[]

string

Session parameters to be compared when calculating differences.
flow

string

Flow name to start the test case with. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow.
page

string

The page to start the test case with. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow.

Methods

batchDelete

 Batch deletes test cases.

batchRun

 Kicks off a batch run of test cases.

calculateCoverage

 Calculates the test coverage for an agent.

create

 Creates a test case for the given agent.

export

 Exports the test cases under the agent to a Cloud Storage bucket or a local file.

get

 Gets a test case.

import

 Imports the test cases from a Cloud Storage bucket or a local file.

list

 Fetches a list of test cases for a given agent.

patch

 Updates the specified test case.

run

 Kicks off a test case run.