Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Agent ¶
type Agent struct {
Validate []Validation `yaml:"validate" json:"validate"`
}
type AgentTest ¶ added in v1.19.0
type AgentTest struct {
Goal string `yaml:"goal" json:"goal"`
Persona string `yaml:"persona" json:"persona"`
MaxSteps int `yaml:"maxSteps" json:"maxSteps"`
UserInformation []UserInfo `yaml:"userInformation,omitempty" json:"userInformation,omitempty"`
OpenAIConfig *OpenAIConfig `yaml:"openAIConfig,omitempty" json:"openAIConfig,omitempty"`
VoiceflowAgentTesterConfig *VoiceflowAgentTesterConfig `yaml:"voiceflowAgentTesterConfig,omitempty" json:"voiceflowAgentTesterConfig,omitempty"`
}
AgentTest defines an agent-to-agent test configuration
type Button ¶ added in v1.27.0
type Button struct {
Name string `json:"name"`
Request ButtonRequest `json:"request"`
}
Button represents a button from a choice trace, matching the interact response type
type ButtonRequest ¶ added in v1.27.0
type ButtonRequest struct {
Type string `json:"type"`
Payload map[string]interface{} `json:"payload"`
}
ButtonRequest represents the request object attached to a button
type IntentEntity ¶ added in v1.27.0
type IntentRequest ¶ added in v1.27.0
type IntentRequest struct {
Name string `yaml:"name" json:"name"`
Entities []IntentEntity `yaml:"entities,omitempty" json:"entities,omitempty"`
}
type Interaction ¶
type OpenAIConfig ¶ added in v1.19.0
type OpenAIConfig struct {
Model string `yaml:"model,omitempty" json:"model,omitempty"`
Temperature *float64 `yaml:"temperature,omitempty" json:"temperature,omitempty"`
}
OpenAIConfig defines OpenAI configuration for agent-to-agent tests
type SimilarityConfig ¶ added in v1.12.0
type SimilarityConfig struct {
Provider string `yaml:"provider" json:"provider"`
Model string `yaml:"model" json:"model"`
Temperature float64 `yaml:"temperature" json:"temperature"`
SimilarityThreshold float64 `yaml:"similarityThreshold" json:"similarityThreshold"`
TopK int `yaml:"top_k" json:"top_k"`
TopP float64 `yaml:"top_p" json:"top_p"`
}
type Suite ¶
type Suite struct {
Name string `yaml:"name" json:"name"`
Description string `yaml:"description" json:"description"`
EnvironmentName string `yaml:"environmentName" json:"environmentName"`
NewSessionPerTest bool `yaml:"newSessionPerTest,omitempty" json:"newSessionPerTest,omitempty"`
Tests []TestFile `yaml:"tests" json:"tests"`
OpenAIConfig *OpenAIConfig `yaml:"openAIConfig,omitempty" json:"openAIConfig,omitempty"`
}
type Test ¶
type Test struct {
Name string `yaml:"name" json:"name"`
Description string `yaml:"description" json:"description"`
Interactions []Interaction `yaml:"interactions,omitempty" json:"interactions,omitempty"`
Agent *AgentTest `yaml:"agent,omitempty" json:"agent,omitempty"`
}
type User ¶
type User struct {
Type string `yaml:"type" json:"type"`
Text string `yaml:"text,omitempty" json:"text,omitempty"`
Value string `yaml:"value,omitempty" json:"value,omitempty"` // Used for button label
Event string `yaml:"event,omitempty" json:"event,omitempty"`
Intent *IntentRequest `yaml:"intent,omitempty" json:"intent,omitempty"`
}
type UserInfo ¶ added in v1.19.0
type UserInfo struct {
Name string `yaml:"name" json:"name"`
Value string `yaml:"value" json:"value"`
}
UserInfo represents information that the agent can use when requested
type Validation ¶
type Validation struct {
ID string `yaml:"id" json:"id,omitempty"`
Type string `yaml:"type" json:"type"`
Value string `yaml:"value,omitempty" json:"value,omitempty"`
Values []string `yaml:"values,omitempty" json:"values,omitempty"`
SimilarityConfig *SimilarityConfig `yaml:"similarityConfig,omitempty" json:"similarityConfig,omitempty"`
VariableConfig *VariableConfig `yaml:"variableConfig,omitempty" json:"variableConfig,omitempty"`
}
type VariableConfig ¶ added in v1.13.0
type VoiceflowAgentTesterConfig ¶ added in v1.19.0
type VoiceflowAgentTesterConfig struct {
EnvironmentName string `yaml:"environmentName" json:"environmentName"`
APIKey string `yaml:"apiKey" json:"apiKey"`
}
VoiceflowAgentTesterConfig defines configuration for using a Voiceflow agent as the tester
Click to show internal directories.
Click to hide internal directories.