Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

scenario

package

Go to main page

Versions in this module

v0

v0.9.0

Sep 7, 2026

v0.8.0

Sep 7, 2026

v0.7.0

Sep 7, 2026

v0.6.1

Jul 27, 2026

v0.6.0

Jul 27, 2026

v0.5.1

Jul 26, 2026

v0.5.0

Jul 25, 2026

v0.4.0

Jul 25, 2026

Changes in this version

+ const CassetteModeRecord

+ const CassetteModeReplay

+ const CastTypeAIAgent

+ const CastTypeHuman

+ const DataSensitivityRealSubject

+ const DataSensitivitySynthetic

+ const DeliveryPolling

+ const DeliveryWebhook

+ const EndpointProfileHeadlessEngine

+ const EndpointProfilePlatformEmulated

+ const EnvironmentDev

+ const EnvironmentProduction

+ const EnvironmentTest

+ const EnvironmentUnknown

+ const FailurePolicyAbort

+ const FailurePolicyCoverageGap

+ const FieldDirection

+ const FieldEdited

+ const FieldKind

+ const FieldText

+ const FormatV1

+ const OpContains

+ const OpExact

+ const OpRegex

+ const PartKindAIGoal

+ const PartKindDeterministic

+ const ProviderKindCassette

+ const ProviderKindModel

+ const SchemaVersion1

+ const TransportHTTP

+ const TransportIframe

+ const UnmetPrefix

+ var DefaultSupportedExampleBots = map[string]bool

+ var ErrCredentialStoreUnavailable = fmt.Errorf("scenario: no credential store is configured in this runtime")

+ func Parse(data []byte) (*Document, Report, error)

+ type Bot struct

+ Delivery string

+ ExampleBot string

+ Headers map[string]SecretRef

+ ID string

+ Name string

+ Transport string

+ URL string

+ type Budgets struct

+ MaxCost *float64

+ MaxDurationSeconds int

+ MaxSteps int

+ type BuildOptions struct

+ BindAddr string

+ ExampleBots ExampleBotRegistry

+ HTTPClient *http.Client

+ Now func() time.Time

+ Secrets SecretResolver

+ type Built struct

+ Actors []sdk.Actor

+ ChatIDs map[string]int64

+ Close func()

+ Fidelity ResolvedFidelity

+ Run run.Run

+ VerifySpec *VerifySpec

+ func Build(_ context.Context, doc *Document, opts BuildOptions) (built *Built, err error)

+ type CaseDecl struct

+ Inputs map[string]json.RawMessage

+ Name string

+ type Cast struct

+ ID string

+ Name string

+ PlatformIdentity PlatformIdentity

+ Provider *Provider

+ Type string

+ type Ceiling struct

+ MaxCost *float64

+ MaxDurationSeconds int

+ MaxSteps int

+ type Chat struct

+ ID string

+ PlatformChatID int64

+ type Condition struct

+ Field string

+ Negate bool

+ Op string

+ Value json.RawMessage

+ type Document struct

+ BaseDir string

+ Bot Bot

+ Cases []CaseDecl

+ Cast []Cast

+ Ceiling *Ceiling

+ Chats []Chat

+ Description string

+ Fidelity Fidelity

+ Format string

+ ID string

+ Inputs []InputDecl

+ Parts []Part

+ Platform string

+ Requires []string

+ SchemaVersion int

+ Secrets []Secret

+ SourceURL string

+ Title string

+ Verifies []string

+ Verify *Verify

+ Version string

+ type EnvOnlyResolver struct

+ Lookup func(varName string) (string, bool)

+ func (EnvOnlyResolver) ResolveCredential(credentialName string) (string, error)

+ func (r EnvOnlyResolver) ResolveEnv(varName string) (string, error)

+ type ExampleBotFactory func() (*ExampleBotSession, error)

+ type ExampleBotRegistry map[string]ExampleBotFactory

+ func DefaultExampleBots() ExampleBotRegistry

+ func (r ExampleBotRegistry) Boot(id string) (*ExampleBotSession, error)

+ type ExampleBotSession struct

+ Close func()

+ Emulator *telegram.Emulator

+ type Fidelity struct

+ DataSensitivity string

+ EndpointProfile string

+ Environment string

+ RedactionPolicy string

+ type FileScenarioProvider struct

+ Root string

+ func (p FileScenarioProvider) Load(_ context.Context, ref string) (*Document, Report, error)

+ type Goal struct

+ Budgets Budgets

+ Constraints []string

+ Description string

+ ID string

+ Tasks []Task

+ Title string

+ type InputDecl struct

+ Default json.RawMessage

+ Description string

+ Name string

+ type Issue struct

+ Code string

+ Message string

+ Pointer string

+ Severity Severity

+ type JournalExpectation struct

+ All []Condition

+ ID string

+ UnmetDetail string

+ type LoopConfig struct

+ ActWaitTimeoutSeconds int

+ HistoryWindow int

+ NonProgressLimit int

+ OvershootProbe *bool

+ RetainObservations *bool

+ type Part struct

+ ActorID string

+ Chat string

+ FailurePolicy string

+ Goal *Goal

+ ID string

+ Kind string

+ Loop *LoopConfig

+ Steps json.RawMessage

+ Title string

+ type PlatformIdentity struct

+ FirstName string

+ UserID int64

+ type Provider struct

+ APIKey *SecretRef

+ BaseURL string

+ Cassette string

+ Kind string

+ Mode string

+ Model string

+ ProviderID string

+ Wraps *Provider

+ type RejectionError struct

+ Report Report

+ func (e *RejectionError) Error() string

+ type Report struct

+ Issues []Issue

+ func (r Report) Errors() []Issue

+ func (r Report) HasErrors() bool

+ func (r Report) Warnings() []Issue

+ type ResolvedFidelity struct

+ DataSensitivity string

+ EndpointProfile string

+ Environment string

+ func ResolveFidelity(doc *Document) ResolvedFidelity

+ type ScenarioProvider interface

+ Load func(ctx context.Context, ref string) (*Document, Report, error)

+ type Secret struct

+ From SecretSource

+ Name string

+ type SecretRef struct

+ Name string

+ type SecretResolver interface

+ ResolveCredential func(credentialName string) (string, error)

+ ResolveEnv func(varName string) (string, error)

+ type SecretSource struct

+ Credential string

+ Env string

+ type Severity string

+ const SeverityError

+ const SeverityWarning

+ type Task struct

+ DependsOn []string

+ ID string

+ Milestones []string

+ SuccessCriteria string

+ Title string

+ type Verify struct

+ Chat string

+ Journal []JournalExpectation

+ MetDetail string

+ type VerifyResult struct

+ Detail string

+ Verified bool

+ type VerifySpec struct

+ func CompileVerify(doc *Document) (*VerifySpec, error)

+ func (s *VerifySpec) ChatDocID() string

+ func (s *VerifySpec) Evaluate(entries []platform.JournalEntry) VerifyResult