mintlify

package
v0.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 9, 2025 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AutocompleteRequest

type AutocompleteRequest struct {
	Query          string `json:"query"`
	PageSize       int    `json:"page_size"`
	SearchType     string `json:"search_type"`
	ExtendResults  bool   `json:"extend_results"`
	ScoreThreshold int    `json:"score_treshold"`
}

type AutocompleteResponse

type AutocompleteResponse struct {
	ScoreChunks     []ScoreChunk `json:"score_chunks"`
	CorrectedQuery  *string      `json:"corrected_query"`
	TotalChunkPages int          `json:"total_chunk_pages"`
}

type ChunkMetadata

type ChunkMetadata struct {
	ID         string      `json:"id"`
	Link       string      `json:"link"`
	CreatedAt  string      `json:"created_at"`
	UpdatedAt  string      `json:"updated_at"`
	ChunkHTML  string      `json:"chunk_html"`
	Metadata   DocMetadata `json:"metadata"`
	TrackingID *string     `json:"tracking_id"`
	TimeStamp  *string     `json:"time_stamp"`
	DatasetID  string      `json:"dataset_id"`
	Weight     float64     `json:"weight"`
	Location   *string     `json:"location"`
	ImageURLs  *string     `json:"image_urls"`
	TagSet     string      `json:"tag_set"`
	NumValue   *string     `json:"num_value"`
}

type ConfigResponse

type ConfigResponse struct {
	Name            string   `json:"name"`
	TrieveDatasetID string   `json:"trieveDatasetId"`
	TrieveAPIKey    string   `json:"trieveApiKey"`
	Tools           []Tools  `json:"tools"`
	OpenAPIUrls     []string `json:"openApiUrls"`
}

func GetMcpConfig

func GetMcpConfig(ctx context.Context) (*ConfigResponse, error)

type DocMetadata

type DocMetadata struct {
	Breadcrumbs []string `json:"breadcrumbs"`
	Title       string   `json:"title"`
}

type Mintlify

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

func New

func New(ctx context.Context) (*Mintlify, error)

func (*Mintlify) Autocomplete

func (m *Mintlify) Autocomplete(
	ctx context.Context,
	body AutocompleteRequest,
) (*AutocompleteResponse, error)

type ScoreChunk

type ScoreChunk struct {
	Metadata   []ChunkMetadata `json:"metadata"`
	Highlights *string         `json:"highlights"`
	Score      float64         `json:"score"`
}

type Tool

type Tool struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

type Tools

type Tools struct {
	Tool Tool `json:"tool"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL