knowledge

type Artifacts struct {
	Pages  string `json:"pages"`
	Chunks string `json:"chunks"`
	Index  string `json:"index"`
}

type Chunk struct {
	ID          string   `json:"id"`
	PageID      string   `json:"pageId"`
	ResourceURI string   `json:"resourceUri"`
	Language    string   `json:"language"`
	Version     string   `json:"version"`
	Route       string   `json:"route"`
	URL         string   `json:"url"`
	Source      string   `json:"source"`
	PageTitle   string   `json:"pageTitle"`
	Title       string   `json:"title"`
	HeadingID   string   `json:"headingId,omitempty"`
	HeadingPath []string `json:"headingPath,omitempty"`
	Tags        []string `json:"tags,omitempty"`
	Part        int      `json:"part,omitempty"`
	Text        string   `json:"text"`
}

type EvaluationCase struct {
	ID             string   `json:"id"`
	Query          string   `json:"query"`
	Language       string   `json:"language,omitempty"`
	Version        string   `json:"version,omitempty"`
	Tags           []string `json:"tags,omitempty"`
	ExpectedRoutes []string `json:"expectedRoutes"`
}

type EvaluationReport struct {
	Suite        string             `json:"suite"`
	Cases        int                `json:"cases"`
	Passed       int                `json:"passed"`
	RecallAt1    float64            `json:"recallAt1"`
	RecallAt3    float64            `json:"recallAt3"`
	RecallAt5    float64            `json:"recallAt5"`
	MRR          float64            `json:"mrr"`
	CitationRate float64            `json:"citationRate"`
	Results      []EvaluationResult `json:"results"`
}

type EvaluationResult struct {
	ID             string   `json:"id"`
	Query          string   `json:"query"`
	Passed         bool     `json:"passed"`
	Rank           int      `json:"rank,omitempty"`
	ExpectedRoutes []string `json:"expectedRoutes"`
	TopURLs        []string `json:"topUrls,omitempty"`
}

type EvaluationSuite struct {
	Name  string           `json:"name"`
	Cases []EvaluationCase `json:"cases"`
}

type GetPageInput struct {
	ID  string `json:"id,omitempty" jsonschema:"Page ID returned by search or resources/list."`
	URL string `json:"url,omitempty" jsonschema:"Canonical URL or route of the page."`
}

type GetPageOutput struct {
	ID          string   `json:"id"`
	ResourceURI string   `json:"resourceUri"`
	Title       string   `json:"title"`
	Description string   `json:"description,omitempty"`
	URL         string   `json:"url"`
	Language    string   `json:"language"`
	Version     string   `json:"version"`
	Tags        []string `json:"tags,omitempty"`
	Text        string   `json:"text"`
}

type Index struct {
	Schema int         `json:"schema"`
	Terms  []IndexTerm `json:"terms"`
}

type IndexTerm struct {
	Term     string    `json:"term"`
	Postings []Posting `json:"postings"`
}

type Manifest struct {
	Schema          int           `json:"schema"`
	Title           string        `json:"title"`
	Description     string        `json:"description,omitempty"`
	BaseURL         string        `json:"baseUrl,omitempty"`
	DefaultLanguage string        `json:"defaultLanguage"`
	Languages       []string      `json:"languages"`
	CurrentVersion  string        `json:"currentVersion"`
	Digest          string        `json:"digest"`
	Pages           []PageSummary `json:"pages"`
	Artifacts       Artifacts     `json:"artifacts"`
}

type Page struct {
	PageSummary
	Text string `json:"text"`
}

type PageSummary struct {
	ID          string   `json:"id"`
	ResourceURI string   `json:"resourceUri"`
	Language    string   `json:"language"`
	Version     string   `json:"version"`
	Route       string   `json:"route"`
	URL         string   `json:"url"`
	Source      string   `json:"source"`
	Title       string   `json:"title"`
	Description string   `json:"description,omitempty"`
	Tags        []string `json:"tags,omitempty"`
	ChunkCount  int      `json:"chunkCount"`
}

type Posting struct {
	ChunkID string `json:"chunkId"`
	Text    int    `json:"text,omitempty"`
	Page    int    `json:"page,omitempty"`
	Title   int    `json:"title,omitempty"`
	Route   int    `json:"route,omitempty"`
	Tags    int    `json:"tags,omitempty"`
}

type SearchInput struct {
	Query    string   `json:"query" jsonschema:"Words or exact phrase to find in the knowledge base."`
	Language string   `json:"language,omitempty" jsonschema:"Optional language code such as en or fr."`
	Version  string   `json:"version,omitempty" jsonschema:"Optional documentation version. Defaults to the current version."`
	Tags     []string `json:"tags,omitempty" jsonschema:"Optional tags that every result must contain."`
	Limit    int      `json:"limit,omitempty" jsonschema:"Maximum results from 1 to 50. Defaults to 8."`
}

type SearchOptions struct {
	Query    string   `json:"query"`
	Language string   `json:"language,omitempty"`
	Version  string   `json:"version,omitempty"`
	Tags     []string `json:"tags,omitempty"`
	Limit    int      `json:"limit,omitempty"`
}

type SearchOutput struct {
	Query   string         `json:"query"`
	Results []SearchResult `json:"results"`
}

type SearchResult struct {
	ChunkID      string   `json:"chunkId"`
	PageID       string   `json:"pageId"`
	ResourceURI  string   `json:"resourceUri"`
	PageResource string   `json:"pageResource"`
	Title        string   `json:"title"`
	PageTitle    string   `json:"pageTitle"`
	URL          string   `json:"url"`
	Language     string   `json:"language"`
	Version      string   `json:"version"`
	HeadingPath  []string `json:"headingPath,omitempty"`
	Snippet      string   `json:"snippet"`
	Score        int      `json:"score"`
}

type SiteInfo struct {
	Title           string   `json:"title"`
	Description     string   `json:"description,omitempty"`
	BaseURL         string   `json:"baseUrl,omitempty"`
	DefaultLanguage string   `json:"defaultLanguage"`
	Languages       []string `json:"languages"`
	CurrentVersion  string   `json:"currentVersion"`
	Pages           int      `json:"pages"`
	Sections        int      `json:"sections"`
	Digest          string   `json:"digest"`
}

type Store struct {
	Manifest Manifest
	Pages    []Page
	Chunks   []Chunk
	// contains filtered or unexported fields
}