Google Cloud Dialogflow Cx V3 Client - Class TestCase (0.1.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class TestCase.

Represents a test case.

Generated from protobuf message google.cloud.dialogflow.cx.v3.TestCase

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ 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 array

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.

↳ display_name 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.

↳ test_config Google\Cloud\Dialogflow\Cx\V3\TestConfig

Config for the test case.

↳ test_case_conversation_turns array<Google\Cloud\Dialogflow\Cx\V3\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.

↳ creation_time Google\Protobuf\Timestamp

Output only. When the test was created.

↳ last_test_result Google\Cloud\Dialogflow\Cx\V3\TestCaseResult

The latest test result.

getName

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>.

Returns
TypeDescription
string

setName

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>.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTags

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTags

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.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getDisplayName

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

Returns
TypeDescription
string

setDisplayName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNotes

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

Returns
TypeDescription
string

setNotes

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTestConfig

Config for the test case.

Returns
TypeDescription
Google\Cloud\Dialogflow\Cx\V3\TestConfig|null

hasTestConfig

clearTestConfig

setTestConfig

Config for the test case.

Parameter
NameDescription
var Google\Cloud\Dialogflow\Cx\V3\TestConfig
Returns
TypeDescription
$this

getTestCaseConversationTurns

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTestCaseConversationTurns

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.

Parameter
NameDescription
var array<Google\Cloud\Dialogflow\Cx\V3\ConversationTurn>
Returns
TypeDescription
$this

getCreationTime

Output only. When the test was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreationTime

clearCreationTime

setCreationTime

Output only. When the test was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLastTestResult

The latest test result.

Returns
TypeDescription
Google\Cloud\Dialogflow\Cx\V3\TestCaseResult|null

hasLastTestResult

clearLastTestResult

setLastTestResult

The latest test result.

Parameter
NameDescription
var Google\Cloud\Dialogflow\Cx\V3\TestCaseResult
Returns
TypeDescription
$this