@mixpeek/llamaindex
v1.0.0
Published
LlamaIndex integration for Mixpeek — reader, retriever, and tool spec for RAG applications
Readme
@mixpeek/llamaindex
LlamaIndex integration for Mixpeek — reader, retriever, and tool spec for RAG applications
Installation
npm install @mixpeek/llamaindex llamaindexQuick Start
import mixpeekReader from '@mixpeek/llamaindex';
const instance = mixpeekReader({
apiKey: process.env.MIXPEEK_API_KEY
});Modules
MixpeekReader
LlamaIndex BaseReader that reads documents from Mixpeek collections
import { createMixpeekReader } from '@mixpeek/llamaindex';
const mixpeekReader = createMixpeekReader({
apiKey: process.env.MIXPEEK_API_KEY
});MixpeekRetriever
LlamaIndex BaseRetriever backed by Mixpeek multimodal search
import { createMixpeekRetriever } from '@mixpeek/llamaindex';
const mixpeekRetriever = createMixpeekRetriever({
apiKey: process.env.MIXPEEK_API_KEY
});MixpeekToolSpec
LlamaIndex ToolSpec providing Mixpeek search and enrichment capabilities to agents
import { createMixpeekToolSpec } from '@mixpeek/llamaindex';
const mixpeekToolSpec = createMixpeekToolSpec({
apiKey: process.env.MIXPEEK_API_KEY
});Testing
npm test # Unit tests
npm run test:e2e # End-to-end tests
npm run test:live # Live API tests (requires MIXPEEK_API_KEY)
npm run test:coverage # Coverage reportLicense
MIT
