openresponses

type AuthExpectation string

type Capture struct {
	// contains filtered or unexported fields
}

type Clock interface {
	Now() time.Time
}

type CompactRequest struct {
	Model          string
	Input          *InputValue
	Instructions   *string
	Reasoning      json.RawMessage
	PromptCacheKey string
	Extensions     map[string]json.RawMessage
}

type CompactResource struct {
	ID         string
	Object     string
	CreatedAt  int64
	Status     string
	Model      string
	Output     []Item
	Usage      Usage
	Extensions map[string]json.RawMessage
}

type ContentPart struct {
	Type        string
	Text        string
	Refusal     string
	Summary     string
	Filename    string
	ImageURL    json.RawMessage
	FileURL     json.RawMessage
	FileData    json.RawMessage
	VideoURL    json.RawMessage
	Annotations json.RawMessage
	Logprobs    json.RawMessage
	Opaque      json.RawMessage
}

type CreateRequest struct {
	Model                string
	Input                *InputValue
	Instructions         *string
	Tools                []Tool
	ToolChoice           json.RawMessage
	ParallelToolCalls    *bool
	Temperature          *float64
	TopP                 *float64
	MaxOutputTokens      *int
	MaxToolCalls         *int
	Truncation           string
	Text                 json.RawMessage
	Reasoning            json.RawMessage
	Store                *bool
	Background           *bool
	PreviousResponseID   *string
	Metadata             json.RawMessage
	ServiceTier          string
	SafetyIdentifier     string
	PromptCacheKey       string
	PromptCacheRetention string
	Stream               bool
	Extensions           map[string]json.RawMessage
}

type DelayPlan struct {
	BeforeFirst   time.Duration // sleep before the first event/response
	BetweenEvents time.Duration // sleep between streamed events
	SlowWrite     time.Duration // additional per-event write sleep (slow-write mode)
}

type ErrorObject struct {
	Type    string
	Code    string
	Message string
	Param   string
}

type ErrorStep struct {
	Status     int    // HTTP status; 0 defaults to 400
	Type       string // e.g. invalid_request, requests, server_error
	Code       string // stable code, e.g. model_not_found, rate_limit_exceeded
	Message    string
	Param      string
	RetryAfter string // sent as Retry-After when Status is 429
}

type ExpectedRequest struct {
	Method                string          // exact method, e.g. POST
	PathSuffix            string          // URL path suffix, e.g. /responses/compact
	ContentType           string          // request Content-Type, e.g. application/json
	Auth                  AuthExpectation // credential posture assertion
	Model                 string          // exact model when non-empty
	Stream                *bool           // exact stream flag when non-nil
	MinInputItems         int             // minimum input item count (0 = unconstrained)
	MaxInputItems         int             // maximum input item count (0 = unconstrained)
	RequireTools          int             // minimum declared tool count
	RequireExtensionItems []string        // input item types that must be present
	Contains              []string        // raw body substrings that must be present
	MustOmit              []string        // raw body substrings that must be absent
}

type InputValue struct {
	Text    string
	TextSet bool
	Items   []Item
}

type Item struct {
	Type             string
	ID               string
	Status           string
	Role             string
	Phase            string
	Content          []ContentPart
	CallID           string
	Name             string
	Arguments        string
	Output           json.RawMessage
	Reasoning        *ReasoningItem
	EncapsulatedID   string
	EncryptedContent string
	Opaque           json.RawMessage
}

type MalformedMode string

type Mode string

type Observation struct {
	Path      string
	Method    string
	Headers   http.Header
	Body      []byte
	Timestamp time.Time
	Redacted  bool
}

type Options struct {
	// AllowMissingBearer, when true, skips the bearer requirement. When false,
	// requests without an Authorization: Bearer header are rejected with 401.
	AllowMissingBearer bool
	// RequiredBearer, when non-empty, requires the exact bearer secret.
	RequiredBearer string
	// MaxBodyBytes bounds request body reads; zero uses DefaultMaxBodyBytes.
	MaxBodyBytes int64
	// RedactBodies replaces captured request bodies with a redaction marker.
	RedactBodies bool
	// Clock supplies deterministic timestamps for observations.
	Clock Clock
	// CaptureMax bounds the stored observation list.
	CaptureMax int
	// Logger, when set, receives emulator warnings.
	Logger *slog.Logger
}

type ReasoningItem struct {
	Content             []ContentPart
	EncryptedContent    string
	EncryptedContentSet bool
	Summary             []ContentPart
}

type Resource struct {
	ID                   string
	Object               string
	CreatedAt            int64
	Status               string
	CompletedAt          *int64
	Model                string
	Output               []Item
	ParallelToolCalls    bool
	Reasoning            json.RawMessage
	Store                bool
	Background           bool
	Temperature          *float64
	Text                 json.RawMessage
	ToolChoice           json.RawMessage
	Tools                []Tool
	TopP                 *float64
	Truncation           string
	Usage                Usage
	Metadata             json.RawMessage
	ServiceTier          string
	MaxOutputTokens      *int
	MaxToolCalls         *int
	Instructions         *string
	PreviousResponseID   *string
	Error                *ErrorObject
	IncompleteDetails    json.RawMessage
	SafetyIdentifier     *string
	PromptCacheKey       *string
	PromptCacheRetention *string
	Extensions           map[string]json.RawMessage
}

type Script struct {
	ID              string
	Description     string
	Mode            Mode
	Expected        ExpectedRequest
	Resource        *Resource        // success body for JSON; stream source for SSE/WS
	CompactResource *CompactResource // success body for compact mode
	SSE             []WireStep       // optional explicit stream when Resource is nil
	RawBody         []byte           // optional verbatim body (e.g. pinned official fixture bytes)
	Error           *ErrorStep
	Delay           DelayPlan
	Malformed       MalformedMode
	DisconnectAfter int // close the connection after this many streamed events (0 = never)
	Status          int // success status override; 0 = 200
}

type Server struct {
	// contains filtered or unexported fields
}

type StreamEvent struct {
	Type   string
	Seq    int64
	Fields map[string]any
}

type Tool struct {
	Type        string
	Name        string
	Description string
	Parameters  json.RawMessage
	Strict      *bool
	Opaque      json.RawMessage
}

type Usage struct {
	InputTokens     int
	CachedTokens    int
	OutputTokens    int
	ReasoningTokens int
	TotalTokens     int
}

type VirtualClock struct {
	// contains filtered or unexported fields
}

type WireStep struct {
	Type     string
	Sequence int64
	Data     json.RawMessage
}