Documentation
¶
Index ¶
- func New() *cobra.Command
- type Client
- type ClientAskDir
- type ClientCreateDataset
- type ClientDeleteDataset
- type ClientEditDataset
- type ClientExportDatasets
- type ClientFlowsConfig
- type ClientGetDataset
- type ClientImportDatasets
- type ClientIngest
- type ClientIngestOpts
- type ClientListDatasets
- type ClientResetDatastore
- type ClientRetrieve
- type ClientRetrieveOpts
- type Knowledge
- type Server
- type Version
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
Server string `usage:"URL of the Knowledge API Server" default:"" env:"KNOW_SERVER_URL"`
EmbeddingModelProvider string `` /* 134-byte string literal not displayed */
ConfigFile string `usage:"Path to the configuration file" env:"KNOW_CONFIG_FILE" default:"" short:"c"`
config.DatabaseConfig
config.VectorDBConfig
// contains filtered or unexported fields
}
type ClientAskDir ¶ added in v0.1.3
type ClientAskDir struct {
Client
Path string `usage:"Path to the directory to query" short:"p" default:"."`
NoPrune bool `usage:"Do not prune deleted files" env:"KNOW_ASKDIR_NO_PRUNE"`
ClientIngestOpts
ClientRetrieveOpts
ClientFlowsConfig
}
func (*ClientAskDir) Customize ¶ added in v0.1.3
func (s *ClientAskDir) Customize(cmd *cobra.Command)
type ClientCreateDataset ¶
type ClientCreateDataset struct {
Client
}
func (*ClientCreateDataset) Customize ¶
func (s *ClientCreateDataset) Customize(cmd *cobra.Command)
type ClientDeleteDataset ¶
type ClientDeleteDataset struct {
Client
}
func (*ClientDeleteDataset) Customize ¶
func (s *ClientDeleteDataset) Customize(cmd *cobra.Command)
type ClientEditDataset ¶ added in v0.1.8
type ClientEditDataset struct {
Client
ResetMetadata bool `usage:"reset metadata to default (empty)"`
UpdateMetadata map[string]string `usage:"update metadata key-value pairs (existing metadata will be updated/preserved)"`
ReplaceMetadata map[string]string `usage:"replace metadata with key-value pairs (existing metadata will be removed)"`
}
func (*ClientEditDataset) Customize ¶ added in v0.1.8
func (s *ClientEditDataset) Customize(cmd *cobra.Command)
type ClientExportDatasets ¶ added in v0.1.7
type ClientExportDatasets struct {
Client
Output string `usage:"Output path" default:"."`
All bool `usage:"Export all datasets" short:"a"`
}
func (*ClientExportDatasets) Customize ¶ added in v0.1.7
func (s *ClientExportDatasets) Customize(cmd *cobra.Command)
type ClientFlowsConfig ¶ added in v0.1.6
type ClientGetDataset ¶
type ClientGetDataset struct {
Client
Archive string `usage:"Path to the archive file"`
NoDocs bool `usage:"Do not include documents in output (way less verbose)"`
}
func (*ClientGetDataset) Customize ¶
func (s *ClientGetDataset) Customize(cmd *cobra.Command)
type ClientImportDatasets ¶ added in v0.1.7
type ClientImportDatasets struct {
Client
}
func (*ClientImportDatasets) Customize ¶ added in v0.1.7
func (s *ClientImportDatasets) Customize(cmd *cobra.Command)
type ClientIngest ¶
type ClientIngest struct {
Client
Dataset string `usage:"Target Dataset ID" short:"d" default:"default" env:"KNOW_TARGET_DATASET"`
Prune bool `usage:"Prune deleted files" env:"KNOW_INGEST_PRUNE"`
ClientIngestOpts
textsplitter.TextSplitterOpts
ClientFlowsConfig
}
func (*ClientIngest) Customize ¶
func (s *ClientIngest) Customize(cmd *cobra.Command)
type ClientIngestOpts ¶ added in v0.1.3
type ClientIngestOpts struct {
IgnoreExtensions string `usage:"Comma-separated list of file extensions to ignore" env:"KNOW_INGEST_IGNORE_EXTENSIONS"`
IgnoreFile string `usage:"Path to a .gitignore style file" env:"KNOW_INGEST_IGNORE_FILE"`
IncludeHidden bool `usage:"Include hidden files and directories" default:"false" env:"KNOW_INGEST_INCLUDE_HIDDEN"`
Concurrency int `usage:"Number of concurrent ingestion processes" default:"10" env:"KNOW_INGEST_CONCURRENCY"`
NoRecursive bool `usage:"Don't recursively ingest directories" default:"false" env:"KNOW_NO_INGEST_RECURSIVE"`
NoCreateDataset bool `usage:"Do NOT create the dataset if it doesn't exist" default:"true" env:"KNOW_INGEST_NO_CREATE_DATASET"`
DeduplicationFuncName string `usage:"Name of the deduplication function to use" name:"dedupe-func" env:"KNOW_INGEST_DEDUPE_FUNC"`
}
type ClientListDatasets ¶
func (*ClientListDatasets) Customize ¶
func (s *ClientListDatasets) Customize(cmd *cobra.Command)
type ClientResetDatastore ¶
type ClientResetDatastore struct {
Client
}
func (*ClientResetDatastore) Customize ¶
func (s *ClientResetDatastore) Customize(cmd *cobra.Command)
type ClientRetrieve ¶
type ClientRetrieve struct {
Client
Datasets []string `usage:"Target Dataset IDs" short:"d" default:"default" env:"KNOW_TARGET_DATASETS" name:"dataset"`
Archive string `usage:"Path to the archive file"`
ClientRetrieveOpts
ClientFlowsConfig
}
func (*ClientRetrieve) Customize ¶
func (s *ClientRetrieve) Customize(cmd *cobra.Command)
type ClientRetrieveOpts ¶ added in v0.1.3
type Server ¶
type Server struct {
ServerURL string `usage:"Server URL" default:"http://localhost" env:"KNOW_SERVER_URL"`
ServerPort string `usage:"Server port" default:"8000" env:"KNOW_SERVER_PORT"`
ServerAPIBase string `usage:"Server API base" default:"/v1" env:"KNOW_SERVER_API_BASE"`
EmbeddingModelProvider string `` /* 134-byte string literal not displayed */
ConfigFile string `usage:"Path to the configuration file" env:"KNOW_CONFIG_FILE" default:"" short:"c"`
config.DatabaseConfig
config.VectorDBConfig
}
Server is the Server CLI command
Click to show internal directories.
Click to hide internal directories.