Skip to main content

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
veryfront/embedding

Embedding — RAG primitives for chunking, embedding, and similarity search. Provides a facade over the framework’s current embedding runtime and LangChain text splitting behind veryfront’s own API.

​
Import

import {
  chunk,
  clearEmbeddingProviders,
  createUploadHandler,
  embedding,
  loadUpload,
  ragStore,
} from "veryfront/embedding";

​
Examples

import { ragStore, createUploadHandler } from "veryfront/embedding";

const store = ragStore({});
export const { POST, GET, DELETE } = createUploadHandler(store);

​
Exports

​
Functions

NameDescriptionSource
chunkSplits text into overlapping chunks for embedding.source
clearEmbeddingProvidersClear all registered embedding providers (for testing).source
createUploadHandlerCreates HTTP route handlers for upload, listing, and deletion.source
embeddingCreates an embedding facade.source
loadUploadExtracts plain text from various upload formats.source
ragStoreCreates a persistent RAG store with lazy embedding and similarity search.source
registerEmbeddingProviderRegister an embedding provider factory.source
resolveEmbeddingModelResolve a “provider/model” string to an embedding runtime instance.source
similarityCompute cosine similarity between two numeric vectors.source
useUploadsuseUploads hook for managing RAG upload lifecycle.source
vectorStoreCreates an in-memory vector store with integrated embedding and similarity search.source

​
Types

NameDescriptionSource
ChunkOptionsOptions accepted by chunk.source
EmbeddingPublic API contract for embedding.source
EmbeddingConfigConfiguration used by embedding.source
RagChunkPublic API contract for rag chunk.source
RagDocumentMetaPublic API contract for rag document meta.source
RagSearchOptionsOptions accepted by rag search.source
RagSearchResultResult returned from rag search.source
RagStorePublic API contract for rag store.source
RagStoreBackendPublic API contract for rag store backend.source
RagStoreConfigConfiguration used by rag store.source
RagStoreDataPublic API contract for rag store data.source
SearchOptionsOptions accepted by search.source
SearchResultResult returned from search.source
UseUploadsOptionsOptions accepted by use uploads.source
UseUploadsResultResult returned from use uploads.source
VectorStorePublic API contract for vector store.source
VectorStoreConfigConfiguration used by vector store.source
Architecture: