Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions docs/docs/static/conversationsuite.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,32 @@
"validate"
]
},
"AgentTest": {
"properties": {
"goal": {
"type": "string"
},
"persona": {
"type": "string"
},
"maxSteps": {
"type": "integer"
},
"userInformation": {
"items": {
"$ref": "#/$defs/UserInfo"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"goal",
"persona",
"maxSteps"
]
},
"Interaction": {
"properties": {
"id": {
Expand Down Expand Up @@ -129,14 +155,16 @@
"$ref": "#/$defs/Interaction"
},
"type": "array"
},
"agent": {
"$ref": "#/$defs/AgentTest"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"description",
"interactions"
"description"
]
},
"User": {
Expand All @@ -154,6 +182,22 @@
"type"
]
},
"UserInfo": {
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"value"
]
},
"Validation": {
"properties": {
"id": {
Expand Down
48 changes: 46 additions & 2 deletions docs/docs/static/conversationtest.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,32 @@
"validate"
]
},
"AgentTest": {
"properties": {
"goal": {
"type": "string"
},
"persona": {
"type": "string"
},
"maxSteps": {
"type": "integer"
},
"userInformation": {
"items": {
"$ref": "#/$defs/UserInfo"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"goal",
"persona",
"maxSteps"
]
},
"Interaction": {
"properties": {
"id": {
Expand Down Expand Up @@ -83,14 +109,16 @@
"$ref": "#/$defs/Interaction"
},
"type": "array"
},
"agent": {
"$ref": "#/$defs/AgentTest"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"description",
"interactions"
"description"
]
},
"User": {
Expand All @@ -108,6 +136,22 @@
"type"
]
},
"UserInfo": {
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"value"
]
},
"Validation": {
"properties": {
"id": {
Expand Down
34 changes: 34 additions & 0 deletions docs/docs/static/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,26 @@
}
}
},
"tests.AgentTest": {
"type": "object",
"properties": {
"goal": {
"type": "string"
},
"maxSteps": {
"type": "integer"
},
"persona": {
"type": "string"
},
"userInformation": {
"type": "array",
"items": {
"$ref": "#/definitions/tests.UserInfo"
}
}
}
},
"tests.Interaction": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -357,6 +377,9 @@
"tests.Test": {
"type": "object",
"properties": {
"agent": {
"$ref": "#/definitions/tests.AgentTest"
},
"description": {
"type": "string"
},
Expand All @@ -382,6 +405,17 @@
}
}
},
"tests.UserInfo": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"tests.Validation": {
"type": "object",
"properties": {
Expand Down
22 changes: 22 additions & 0 deletions docs/docs/static/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,19 @@ definitions:
$ref: '#/definitions/tests.Validation'
type: array
type: object
tests.AgentTest:
properties:
goal:
type: string
maxSteps:
type: integer
persona:
type: string
userInformation:
items:
$ref: '#/definitions/tests.UserInfo'
type: array
type: object
tests.Interaction:
properties:
agent:
Expand All @@ -140,6 +153,8 @@ definitions:
type: object
tests.Test:
properties:
agent:
$ref: '#/definitions/tests.AgentTest'
description:
type: string
interactions:
Expand All @@ -156,6 +171,13 @@ definitions:
type:
type: string
type: object
tests.UserInfo:
properties:
name:
type: string
value:
type: string
type: object
tests.Validation:
properties:
id:
Expand Down
26 changes: 23 additions & 3 deletions docs/docs/test-platform/test-execution.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,24 @@ You can run tests immediately in several ways:
- **Scheduled** 📅: Test is queued for future execution


## Test Types

The Voiceflow CLI supports two distinct types of tests:

### 1. Traditional Interaction-Based Tests

- **Purpose**: Test specific user inputs and validate exact agent responses
- **Structure**: Defined as a series of interactions with expected validations
- **Use Case**: Regression testing, validation of specific conversation flows
- **Execution**: Sequential interaction testing with predefined inputs

### 2. Agent-to-Agent Testing

- **Purpose**: Simulate realistic conversations using AI-powered agents
- **Structure**: Defined with goals, personas, and user information
- **Use Case**: End-to-end conversation testing, realistic user behavior simulation
- **Execution**: AI agent interacts naturally with your Voiceflow agent to achieve specific goals

## Test Execution History

### Viewing Executions
Expand All @@ -33,6 +51,7 @@ Navigate to **Test Executions** to see:
- **Complete History**: All your past test executions
- **Execution Details**: Date, time, duration, and status for each run
- **Suite Information**: Which test suite was executed
- **Test Type**: Whether it was an interaction-based or agent-to-agent test
- **Trigger Type**: Whether the test was run manually or scheduled

### Execution Details
Expand All @@ -41,18 +60,19 @@ Navigate to **Test Executions** to see:
<img alt="Test Execution Detail" src="/images/test-platform/test-execution-detail.png" />
</p>


Click on any execution to view:

- **Test Logs**: Detailed step-by-step execution logs
- **Results**: Pass/fail status for each test case
- **Timing Information**: How long each test case took
- **Error Details**: Specific failure reasons and debugging information
- **Agent Conversation History**: For agent-to-agent tests, view the full conversation flow

## Execution Types

- Manual Executions: Triggered by user action
- Scheduled Executions: Automated runs at specified times
- **Manual Executions**: Triggered by user action
- **Scheduled Executions**: Automated runs at specified times
- **Agent Test Executions**: AI-powered conversational tests that adapt to agent responses

## Understanding Test Results

Expand Down
68 changes: 4 additions & 64 deletions docs/docs/test-platform/test-suites.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,34 +50,12 @@ A Test Suite is a JSON-formatted definition that contains:
The YAML import feature expects the standard Voiceflow CLI file structure:

###### Suite File (suite.yaml or suite.yml)
The main suite configuration file containing:
```yaml
name: "Main Conversation Flow Tests"
description: "Comprehensive tests for primary user interactions"
environmentName: "production"
tests:
- id: "greeting_test"
file: "tests/greeting.yaml"
- id: "help_test"
file: "tests/help.yaml"
```

Individual test case files referenced in the suite. You can find more details on the [Suite Reference](/tests/introduction/) page.

###### Test Files (individual .yaml/.yml files)
Individual test case files referenced in the suite:
```yaml
name: "Greeting Test"
description: "Test the bot's greeting response"
interactions:
- id: "greeting_interaction"
user:
type: "text"
text: "Hello"
agent:
validate:
- id: "greeting_validation"
type: "exact_match"
value: "Hello! How can I help you today?"
```

Individual test case files referenced in the suite. You can find more details on the [Test Reference](/tests/introduction/) page.



Expand All @@ -95,44 +73,6 @@ interactions:
- **Delete**: Permanently remove a test suite (requires confirmation)

### Test Suite Structure
Your JSON definition should include:
```json
{
"api_key": "VF.xxxxx.xxxxx",
"suite": {
"name": "Main Conversation Flow Tests",
"description": "Tests for primary user interactions",
"environment_name": "production",
"tests": [
{
"id": "greeting_test",
"test": {
"name": "Greeting Test",
"description": "Test the bot's greeting response",
"interactions": [
{
"id": "greeting_interaction",
"user": {
"type": "text",
"text": "Hello"
},
"agent": {
"validate": [
{
"id": "greeting_validation",
"type": "exact_match",
"value": "Hello! How can I help you today?"
}
]
}
}
]
}
}
]
}
}
```

For more details on the JSON structure, refer to the [Test Suite JSON Schema](https://docs.voiceflow.com/reference/post_api-v1-tests-execute#/).

Expand Down
Loading
Loading