mirror of
https://github.com/qdrant/landing_page.git
synced 2026-10-05 10:58:32 +02:00
Anush
9968ce4842
* docs: Clean up integration docs Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: More cleanup Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: Deleted image artifacts Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: Updated redirects Signed-off-by: Anush008 <anushshetty90@gmail.com> --------- Signed-off-by: Anush008 <anushshetty90@gmail.com>
100 lines
2.8 KiB
Markdown
100 lines
2.8 KiB
Markdown
---
|
|
title: Firebase Genkit
|
|
---
|
|
|
|
# Firebase Genkit
|
|
|
|
[Genkit](https://firebase.google.com/products/genkit) is a framework to build, deploy, and monitor production-ready AI-powered apps.
|
|
|
|
You can build apps that generate custom content, use semantic search, handle unstructured inputs, answer questions with your business data, autonomously make decisions, orchestrate tool calls, and more.
|
|
|
|
You can use Qdrant for indexing/semantic retrieval of data in your Genkit applications via the [Qdrant-Genkit plugin](https://github.com/qdrant/qdrant-genkit).
|
|
|
|
Genkit currently supports server-side development in JavaScript/TypeScript (Node.js) with Go support in active development.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm i genkitx-qdrant
|
|
```
|
|
|
|
## Configuration
|
|
|
|
To use this plugin, specify it when you call `configureGenkit()`:
|
|
|
|
```js
|
|
import { qdrant } from 'genkitx-qdrant';
|
|
|
|
const ai = genkit({
|
|
plugins: [
|
|
qdrant([
|
|
{
|
|
embedder: googleAI.embedder('text-embedding-004'),
|
|
collectionName: 'collectionName',
|
|
clientParams: {
|
|
url: 'http://localhost:6333',
|
|
}
|
|
}
|
|
]),
|
|
],
|
|
});
|
|
```
|
|
|
|
You'll need to specify a collection name, the embedding model you want to use and the Qdrant client parameters. In
|
|
addition, there are a few optional parameters:
|
|
|
|
- `embedderOptions`: Additional options to pass options to the embedder:
|
|
|
|
```js
|
|
embedderOptions: { taskType: 'RETRIEVAL_DOCUMENT' },
|
|
```
|
|
|
|
- `contentPayloadKey`: Name of the payload filed with the document content. Defaults to "content".
|
|
|
|
```js
|
|
contentPayloadKey: 'content';
|
|
```
|
|
|
|
- `metadataPayloadKey`: Name of the payload filed with the document metadata. Defaults to "metadata".
|
|
|
|
```js
|
|
metadataPayloadKey: 'metadata';
|
|
```
|
|
|
|
- `dataTypePayloadKey`: Name of the payload filed with the document datatype. Defaults to "_content_type".
|
|
|
|
```js
|
|
dataTypePayloadKey: '_datatype';
|
|
```
|
|
|
|
- `collectionCreateOptions`: [Additional options](<(https://qdrant.tech/documentation/concepts/collections/#create-a-collection)>) when creating the Qdrant collection.
|
|
|
|
## Usage
|
|
|
|
Import retriever and indexer references like so:
|
|
|
|
```js
|
|
import { qdrantIndexerRef, qdrantRetrieverRef } from 'genkitx-qdrant';
|
|
```
|
|
|
|
Then, pass their references to `retrieve()` and `index()`:
|
|
|
|
```js
|
|
// To export an indexer reference:
|
|
export const qdrantIndexer = qdrantIndexerRef('collectionName', 'displayName');
|
|
```
|
|
|
|
```js
|
|
// To export a retriever reference:
|
|
export const qdrantRetriever = qdrantRetrieverRef('collectionName', 'displayName');
|
|
```
|
|
|
|
You can refer to [Retrieval-augmented generation](https://genkit.dev/docs/rag/) for a general
|
|
discussion on indexers and retrievers.
|
|
|
|
## Further Reading
|
|
|
|
- [Introduction to Genkit](https://genkit.dev/)
|
|
- [Genkit Documentation](https://genkit.dev/docs/get-started/)
|
|
- [Source Code](https://github.com/qdrant/qdrant-genkit)
|