types

Documentation

Index

• type Dataset
• type Ingest
• type IngestResponse
• type Query

Types

type Dataset

type Dataset struct {
	// Dataset ID - must be a valid RFC 1123 hostname
	ID string `json:"id" format:"hostname_rfc1123" binding:"required" example:"asst-12345"`
}

Dataset represents a new knowledge vector space

type Ingest

type Ingest struct {
	Filename         *string                        `json:"filename" `
	Content          string                         `json:"content" binding:"required,base64"`
	FileMetadata     *index.FileMetadata            `json:"metadata"`
	TextSplitterOpts *textsplitter.TextSplitterOpts `json:"text_splitter_opts"`
}

Ingest represents incoming content that should be ingested

type IngestResponse

type IngestResponse struct {
	Documents []string `json:"documents"`
}

type Query

type Query struct {
	Prompt string `json:"prompt" binding:"required"`
	TopK   *int   `json:"topk" example:"5" swaggertype:"integer"`
}

Query represents an incoming user query