tools

type ArtifactLister interface {
	ListArtifacts(context.Context, string) ([]string, error)
}

type ArtifactListerFunc func(context.Context, string) ([]string, error)

type DocumentHost struct {
	Runtime       DocumentParser
	Paths         PathResolver
	Text          DocumentTextLoader
	Artifacts     ArtifactLister
	Errors        ErrorProjector
	LoadSpec      func(string) (*configs.DocSpec, error)
	RecommendSpec func(string, []*configs.DocSpec) []configs.SpecRecommendation
}

type DocumentParseToolOptions struct {
	Root                  string
	DefaultModel          string
	DefaultArtifactPolicy pipeline.ArtifactPolicy
	DefaultExtractionMode pipeline.DocumentExtractionMode
	DefaultTimeoutMs      int
	MaxResponseBytes      int
	Host                  DocumentHost
	// EnabledTools is intentionally required for registration. document_parse
	// is a specialist surface and must not become visible by helper defaults.
	EnabledTools []string
}

type DocumentParser interface {
	Run(context.Context, pipeline.ParseRequest) (*types.DocumentResult, error)
}

type DocumentParserFunc func(context.Context, pipeline.ParseRequest) (*types.DocumentResult, error)

type DocumentTextLoader interface {
	LoadDocumentText(context.Context, DocumentTextRequest) ([]string, error)
}

type DocumentTextLoaderFunc func(context.Context, DocumentTextRequest) ([]string, error)

type DocumentTextRequest struct {
	Path           string
	PageLimit      int
	PDFParseMode   pipeline.PDFParseMode
	ExtractionMode pipeline.DocumentExtractionMode
}

type ErrorProjector interface {
	Classify(error) string
	Display(error, string, string) string
}

type ErrorProjectorFuncs struct {
	ClassifyFunc func(error) string
	DisplayFunc  func(error, string, string) string
}

type PDFBackend interface {
	Name() string
	Availability(context.Context) PDFBackendAvailability
	ExtractAllText(context.Context, string) (PDFTextResult, error)
	ExtractPageText(context.Context, string, []int) (PDFTextResult, error)
	ReadMetadata(context.Context, string, bool) (PDFMetadataResult, error)
}

type PDFBackendAvailability struct {
	Name      string `json:"name"`
	Available bool   `json:"available"`
	Reason    string `json:"reason,omitempty"`
}

type PDFBackendAvailabilityDetails struct {
	Primary  PDFBackendAvailability `json:"primary"`
	Fallback PDFBackendAvailability `json:"fallback"`
}

type PDFFont struct {
	Name string  `json:"name"`
	Size float64 `json:"size"`
}

type PDFHost struct {
	Inputs          PDFInputResolver
	LayoutName      string
	Layout          func(context.Context, string, []int) (PDFTextResult, error)
	Chat            func(context.Context, llm.ChatInput) (*llm.ChatResponse, error)
	Vision          func(context.Context, llm.VisionInput) (*llm.VisualResponse, error)
	Native          func(context.Context, PDFNativeRequest) (string, error)
	OCR             func(context.Context, PDFOCRRequest) ([]PDFPageText, error)
	Render          func(context.Context, string, []int, int) ([]PDFRenderedPage, func() error, error)
	PublishRendered func(context.Context, string, string, []PDFRenderedPage) ([]mediaartifact.Descriptor, error)
}

type PDFInputRequest struct {
	Root       string
	Reference  string
	TimeoutMS  int
	MaxBytes   int
	Parameters map[string]any
}

type PDFInputResolver interface {
	ResolvePDFInput(context.Context, PDFInputRequest) (ResolvedPDFInput, error)
}

type PDFInputResolverFunc func(context.Context, PDFInputRequest) (ResolvedPDFInput, error)

type PDFLayoutBackend interface {
	ExtractLayoutText(context.Context, string, []int) (PDFTextResult, error)
}

type PDFMetadataResult struct {
	PageCount         int
	Outline           *PDFOutline
	Fonts             []PDFFont
	TotalRects        int
	PagesWithGraphics int
	MaxRectsPerPage   int
	GraphicPages      []int
	RectsByPage       map[int]int
}

type PDFModelCandidate struct {
	Name           string `json:"name"`
	Client         string `json:"client,omitempty"`
	Model          string `json:"model,omitempty"`
	NativePDF      bool   `json:"native_pdf,omitempty"`
	SupportsVision bool   `json:"-"`
	ConfigKey      string `json:"-"`
	Vendor         string `json:"-"`
}

type PDFNativeRequest struct {
	Candidate PDFModelCandidate
	Prompt    string
	Paths     []string
}

type PDFOCRRequest struct {
	Profile string
	Path    string
}

type PDFOutline struct {
	Title    string       `json:"title"`
	Children []PDFOutline `json:"children,omitempty"`
}

type PDFPageText struct {
	Page int    `json:"page"`
	Text string `json:"text"`
}

type PDFRenderedPage struct {
	Page     int
	Path     string
	Data     []byte
	MIMEType string
}

type PDFTextResult struct {
	Pages []PDFPageText `json:"pages"`
}

type PDFToolOptions struct {
	Root                      string
	EnabledTools              []string
	MaxExtractChars           int
	MaxPageChars              int
	MaxPages                  int
	TimeoutMs                 int
	MaxResponseBytes          int
	Backend                   PDFBackend
	FallbackBackend           PDFBackend
	OCRProfile                string
	PreferredModel            string
	FallbackModels            []string
	PreferNative              *bool
	NativePageSelectionPolicy string
	ArtifactCacheSize         int
	Models                    []PDFModelCandidate
	Host                      PDFHost
}

type PathRequest struct {
	Root      string
	Value     string
	Field     string
	MustExist bool
	FileOnly  bool
}

type PathResolver interface {
	ResolvePath(context.Context, PathRequest) (ResolvedPath, error)
}

type PathResolverFunc func(context.Context, PathRequest) (ResolvedPath, error)

type ResolvedPDFInput struct {
	Path          string
	Display       string
	CacheIdentity string
	Remote        bool
	Cleanup       func()
}

type ResolvedPath struct {
	Path    string
	Display string
}

type ToolMetadata = agentxtools.ToolMetadata