client

package
v0.0.0-...-7f6fe28 Latest Latest
Warning

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

Go to latest
Published: Apr 22, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

View Source
const DefaultIgnoreFile = ".knowignore"
View Source
const MetadataFilename = ".knowledge.json"

Variables

Functions

func AskDir

func HashPath

func HashPath(path string) string

Types

type Client

type Client interface {
	CreateDataset(ctx context.Context, datasetID string, opts *types2.DatasetCreateOpts) (*types2.Dataset, error)
	DeleteDataset(ctx context.Context, datasetID string) error
	GetDataset(ctx context.Context, datasetID string, opts *types2.DatasetGetOpts) (*types2.Dataset, error)
	FindFile(ctx context.Context, searchFile types2.File) (*types2.File, error)
	DeleteFile(ctx context.Context, datasetID, fileID string) error
	ListDatasets(ctx context.Context) ([]types2.Dataset, error)
	Ingest(ctx context.Context, datasetID string, name string, data []byte, opts datastore.IngestOpts) ([]string, error)
	IngestPaths(ctx context.Context, datasetID string, opts *IngestPathsOpts, paths ...string) (int, int, error) // returns number of files ingested, number of files skipped and first encountered error
	AskDirectory(ctx context.Context, path string, query string, opts *IngestPathsOpts, ropts *datastore.RetrieveOpts) (*dstypes.RetrievalResponse, error)
	PrunePath(ctx context.Context, datasetID string, path string, keep []string) ([]types2.File, error)
	DeleteDocuments(ctx context.Context, datasetID string, documentIDs ...string) error
	Retrieve(ctx context.Context, datasetIDs []string, query string, opts datastore.RetrieveOpts) (*dstypes.RetrievalResponse, error)
	ExportDatasets(ctx context.Context, path string, datasets ...string) error
	ImportDatasets(ctx context.Context, path string, datasets ...string) error
	UpdateDataset(ctx context.Context, dataset types2.Dataset, opts *datastore.UpdateDatasetOpts) (*types2.Dataset, error)
	Close() error
}

type FileMetadata

type FileMetadata map[string]any

type IngestPathsOpts

type IngestPathsOpts struct {
	SharedIngestionOpts
	IgnoreExtensions     []string
	Concurrency          int
	Recursive            bool
	IgnoreFile           string
	IncludeHidden        bool
	NoCreateDataset      bool
	Prune                bool // Prune deleted files
	ErrOnUnsupportedFile bool
	ExitOnFailedFile     bool
}

type IngestWorkspaceOpts

type IngestWorkspaceOpts struct {
	SharedIngestionOpts
}

type Metadata

type Metadata struct {
	MetadataFileAbsPath string
	Metadata            map[string]FileMetadata `json:"metadata"` // Map of file paths to metadata

}

type SharedIngestionOpts

type SharedIngestionOpts struct {
	IngestionFlows      []flows.IngestionFlow
	IsDuplicateFuncName string
	Metadata            map[string]string
	ReuseEmbeddings     bool
	ReuseFiles          bool
}

type StandaloneClient

type StandaloneClient struct {
	*datastore.Datastore
	GPTScript *gptscript.GPTScript
}

func NewStandaloneClient

func NewStandaloneClient(ctx context.Context, ds *datastore.Datastore) (*StandaloneClient, error)

func (*StandaloneClient) AskDirectory

func (c *StandaloneClient) AskDirectory(ctx context.Context, path string, query string, opts *IngestPathsOpts, ropts *datastore.RetrieveOpts) (*dstypes.RetrievalResponse, error)

func (*StandaloneClient) Close

func (c *StandaloneClient) Close() error

func (*StandaloneClient) CreateDataset

func (c *StandaloneClient) CreateDataset(ctx context.Context, datasetID string, opts *types2.DatasetCreateOpts) (*types2.Dataset, error)

func (*StandaloneClient) DeleteDataset

func (c *StandaloneClient) DeleteDataset(ctx context.Context, datasetID string) error

func (*StandaloneClient) DeleteDocuments

func (c *StandaloneClient) DeleteDocuments(ctx context.Context, datasetID string, documentIDs ...string) error

func (*StandaloneClient) DeleteFile

func (c *StandaloneClient) DeleteFile(ctx context.Context, datasetID, fileID string) error

func (*StandaloneClient) ExportDatasets

func (c *StandaloneClient) ExportDatasets(ctx context.Context, path string, datasets ...string) error

func (*StandaloneClient) FindFile

func (c *StandaloneClient) FindFile(ctx context.Context, searchFile types2.File) (*types2.File, error)

func (*StandaloneClient) GetDataset

func (c *StandaloneClient) GetDataset(ctx context.Context, datasetID string, opts *types2.DatasetGetOpts) (*types2.Dataset, error)

func (*StandaloneClient) ImportDatasets

func (c *StandaloneClient) ImportDatasets(ctx context.Context, path string, datasets ...string) error

func (*StandaloneClient) Ingest

func (c *StandaloneClient) Ingest(ctx context.Context, datasetID string, name string, data []byte, opts datastore.IngestOpts) ([]string, error)

func (*StandaloneClient) IngestFromWorkspace

func (c *StandaloneClient) IngestFromWorkspace(ctx context.Context, datasetID string, opts *IngestWorkspaceOpts, file string) error

func (*StandaloneClient) IngestPaths

func (c *StandaloneClient) IngestPaths(ctx context.Context, datasetID string, opts *IngestPathsOpts, paths ...string) (int, int, error)

func (*StandaloneClient) ListDatasets

func (c *StandaloneClient) ListDatasets(ctx context.Context) ([]types2.Dataset, error)

func (*StandaloneClient) PrunePath

func (c *StandaloneClient) PrunePath(ctx context.Context, datasetID string, path string, keep []string) ([]types2.File, error)

func (*StandaloneClient) Retrieve

func (c *StandaloneClient) Retrieve(ctx context.Context, datasetIDs []string, query string, opts datastore.RetrieveOpts) (*dstypes.RetrievalResponse, error)

func (*StandaloneClient) UpdateDataset

func (c *StandaloneClient) UpdateDataset(ctx context.Context, dataset types2.Dataset, opts *datastore.UpdateDatasetOpts) (*types2.Dataset, error)

Jump to

Keyboard shortcuts

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