instrukt.indexes.schema.Index

class instrukt.indexes.schema.Index(*, name: str, path: str, description: str, embedding: str = 'default', loader_type: str | None = None, metadata: dict[Any, Any] | None = None, glob: str | None = None)

Bases: BaseModel

Base Instrukt Index class.

Indexes are the the document storing and retrieval backend for agents.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param description: str [Required]

param embedding: str = 'default'

param glob: str | None = None

custom glob for matching files

param loader_type: str | None = None

param metadata: dict[Any, Any] | None [Optional]

param name: str [Required]

param path: str [Required]

validator validate_description  »  description

validator validate_embedding  »  embedding

Ensure embedding is valid

validator validate_loader_type  »  loader_type

Ensure loader type is valid

validator validate_non_empty  »  name

Ensure name is not empty

validator validate_path  »  path

Ensure path is absolute

property embedding_fn: Embeddings

Get the embedding function