tools

type ActivityUpdate struct {
	Activity *observation.ActivityPresentation
	Metadata map[string]any
}

type ArtifactRef struct {
	ID        string `json:"id,omitempty"`
	SafeLabel string `json:"safe_label,omitempty"`
	Kind      string `json:"kind,omitempty"`
	MIME      string `json:"mime,omitempty"`
	SizeBytes int64  `json:"size_bytes,omitempty"`
	SHA256    string `json:"sha256,omitempty"`
}

type Definition struct {
	Name         string
	Title        string
	Description  string
	InputSchema  map[string]any
	OutputSchema map[string]any
	Activity     func(Invocation[any]) (*observation.ActivityPresentation, error)

	Effects     []Effect
	ReadOnly    bool
	Destructive bool
	OpenWorld   bool

	Permission    PermissionSpec
	PermissionFor PermissionResolver
	OutputPolicy  OutputPolicy
	Annotations   map[string]any
}

type DispatchOptions struct {
	RunID         string
	ThreadID      string
	TurnID        string
	PromptScopeID string
	Step          int
	BatchIndex    int
	BatchSize     int
	Labels        map[string]string
	HostContext   map[string]string

	DispatchStarted      func(DispatchStart)
	ActivityUpdated      func(ToolActivityUpdate)
	EffectBatchPreflight EffectBatchPreflight
	EffectDispatcher     EffectDispatcher
}

type DispatchStart struct {
	CallID        string
	Name          string
	RawArgs       string
	RunID         string
	ThreadID      string
	TurnID        string
	PromptScopeID string
	Step          int
	Labels        map[string]string
	HostContext   map[string]string
}

type Effect string

type EffectBatchPreflight func(context.Context, []EffectDispatchRequest) error

type EffectDispatchRequest struct {
	CallID        string
	Name          string
	RawArgs       string
	RunID         string
	ThreadID      string
	TurnID        string
	PromptScopeID string
	Step          int
	BatchIndex    int
	BatchSize     int
	Labels        map[string]string
	HostContext   map[string]string
	Resources     []ResourceRef
	Effects       []Effect
	Permission    PermissionSpec
	ReadOnly      bool
	Destructive   bool
	OpenWorld     bool
}

type EffectDispatcher func(context.Context, EffectDispatchRequest, func(context.Context) Result) Result

type FullOutputPlan struct {
	Text string
	Kind string
	MIME string
}

type Invocation[T any] struct {
	CallID          string
	Name            string
	RawArgs         string
	Args            T
	RunID           string
	ThreadID        string
	TurnID          string
	PromptScopeID   string
	Step            int
	Labels          map[string]string
	HostContext     map[string]string
	ActivityUpdater func(ActivityUpdate)
}

type OutputPolicy struct {
	VisibleMaxBytes int
	VisibleMaxLines int
	Strategy        OutputStrategy
	PreserveFull    bool
	PreserveFullSet bool
	ArtifactKind    string
	ArtifactMIME    string
}

type OutputProjection struct {
	VisibleText    string
	Truncated      bool
	OriginalBytes  int
	VisibleBytes   int
	OriginalLines  int
	VisibleLines   int
	Strategy       OutputStrategy
	ContentSHA256  string
	FullOutput     *ArtifactRef
	FullOutputPlan *FullOutputPlan
}

type OutputStrategy string

type PendingToolResult struct {
	// Handle is the provider-visible continuation token. Hosts should put the
	// exact token here that the model should reuse for later tool calls.
	Handle string
	State  PendingToolResultState
	// Summary and Instruction are provider-visible text.
	Summary     string
	Instruction string
	// Metadata is observation-only pending state. It is not rendered into the
	// provider-visible pending result text.
	Metadata map[string]string
}

type PendingToolResultState string

type PermissionMode string

type PermissionRequest struct {
	CallID        string
	Name          string
	RawArgs       string
	Args          any
	RunID         string
	ThreadID      string
	TurnID        string
	PromptScopeID string
	Step          int
	Labels        map[string]string
	HostContext   map[string]string
}

type PermissionResolver func(PermissionRequest) (PermissionSpec, error)

type PermissionSpec struct {
	Mode          PermissionMode
	ResourceKinds []string
}

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

type ResourceRef struct {
	Kind  string
	Value string
}

type Result struct {
	CallID       string
	Name         string
	Title        string
	Text         string
	Structured   map[string]any
	Metadata     map[string]any
	Activity     *observation.ActivityPresentation
	Artifacts    []ArtifactRef
	OutputPolicy *OutputPolicy
	Pending      *PendingToolResult
	IsError      bool
	DispatchErr  error
	// contains filtered or unexported fields
}

type Tool struct {
	Definition Definition
	// contains filtered or unexported fields
}

type ToolActivityUpdate struct {
	CallID        string
	Name          string
	RawArgs       string
	RunID         string
	ThreadID      string
	TurnID        string
	PromptScopeID string
	Step          int
	Labels        map[string]string
	HostContext   map[string]string
	Activity      *observation.ActivityPresentation
	Metadata      map[string]any
}

type ToolCall struct {
	ID        string
	Name      string
	Args      string
	Reasoning string
}

type ToolDefinition struct {
	Name         string
	Title        string
	Description  string
	InputSchema  map[string]any
	OutputSchema map[string]any
	Strict       bool
	Annotations  map[string]any
}