Documentation
¶
Index ¶
- Constants
- Variables
- func AskDir(ctx context.Context, c Client, path string, query string, ...) (*dstypes.RetrievalResponse, error)
- func HashPath(path string) string
- type Client
- type FileMetadata
- type IngestPathsOpts
- type IngestWorkspaceOpts
- type Metadata
- type SharedIngestionOpts
- type StandaloneClient
- func (c *StandaloneClient) AskDirectory(ctx context.Context, path string, query string, opts *IngestPathsOpts, ...) (*dstypes.RetrievalResponse, error)
- func (c *StandaloneClient) Close() error
- func (c *StandaloneClient) CreateDataset(ctx context.Context, datasetID string, opts *types2.DatasetCreateOpts) (*types2.Dataset, error)
- func (c *StandaloneClient) DeleteDataset(ctx context.Context, datasetID string) error
- func (c *StandaloneClient) DeleteDocuments(ctx context.Context, datasetID string, documentIDs ...string) error
- func (c *StandaloneClient) DeleteFile(ctx context.Context, datasetID, fileID string) error
- func (c *StandaloneClient) ExportDatasets(ctx context.Context, path string, datasets ...string) error
- func (c *StandaloneClient) FindFile(ctx context.Context, searchFile types2.File) (*types2.File, error)
- func (c *StandaloneClient) GetDataset(ctx context.Context, datasetID string, opts *types2.DatasetGetOpts) (*types2.Dataset, error)
- func (c *StandaloneClient) ImportDatasets(ctx context.Context, path string, datasets ...string) error
- func (c *StandaloneClient) Ingest(ctx context.Context, datasetID string, name string, data []byte, ...) ([]string, error)
- func (c *StandaloneClient) IngestFromWorkspace(ctx context.Context, datasetID string, opts *IngestWorkspaceOpts, file string) error
- func (c *StandaloneClient) IngestPaths(ctx context.Context, datasetID string, opts *IngestPathsOpts, paths ...string) (int, int, error)
- func (c *StandaloneClient) ListDatasets(ctx context.Context) ([]types2.Dataset, error)
- func (c *StandaloneClient) PrunePath(ctx context.Context, datasetID string, path string, keep []string) ([]types2.File, error)
- func (c *StandaloneClient) Retrieve(ctx context.Context, datasetIDs []string, query string, ...) (*dstypes.RetrievalResponse, error)
- func (c *StandaloneClient) UpdateDataset(ctx context.Context, dataset types2.Dataset, opts *datastore.UpdateDatasetOpts) (*types2.Dataset, error)
Constants ¶
View Source
const DefaultIgnoreFile = ".knowignore"
View Source
const MetadataFilename = ".knowledge.json"
Variables ¶
View Source
var DefaultIgnorePatterns = []gitignore.Pattern{ gitignore.ParsePattern(DefaultIgnoreFile, nil), gitignore.ParsePattern(MetadataFilename, nil), gitignore.ParsePattern("~$*", nil), gitignore.ParsePattern("$*", nil), }
Functions ¶
func AskDir ¶
func AskDir(ctx context.Context, c Client, path string, query string, opts *IngestPathsOpts, ropts *datastore.RetrieveOpts) (*dstypes.RetrievalResponse, error)
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 IngestPathsOpts ¶
type IngestWorkspaceOpts ¶
type IngestWorkspaceOpts struct {
}
type Metadata ¶
type Metadata struct {
MetadataFileAbsPath string
Metadata map[string]FileMetadata `json:"metadata"` // Map of file paths to metadata
}
type SharedIngestionOpts ¶
type SharedIngestionOpts struct {
}
type StandaloneClient ¶
func NewStandaloneClient ¶
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 (*StandaloneClient) DeleteFile ¶
func (c *StandaloneClient) DeleteFile(ctx context.Context, datasetID, fileID string) error
func (*StandaloneClient) ExportDatasets ¶
func (*StandaloneClient) GetDataset ¶
func (c *StandaloneClient) GetDataset(ctx context.Context, datasetID string, opts *types2.DatasetGetOpts) (*types2.Dataset, error)
func (*StandaloneClient) ImportDatasets ¶
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 (*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)
Click to show internal directories.
Click to hide internal directories.