https://github.com/xavidop/genkitx-voiceflow
Community Plugin for Genkit to use Voiceflow
https://github.com/xavidop/genkitx-voiceflow
firebase firebase-genkit gen-ai generative-ai genkit-plugin genkit-retriever genkitx plugin
Last synced: about 2 months ago
JSON representation
Community Plugin for Genkit to use Voiceflow
- Host: GitHub
- URL: https://github.com/xavidop/genkitx-voiceflow
- Owner: xavidop
- License: apache-2.0
- Created: 2025-03-21T19:07:12.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-21T19:20:29.000Z (about 2 months ago)
- Last Synced: 2025-03-21T19:21:25.476Z (about 2 months ago)
- Topics: firebase, firebase-genkit, gen-ai, generative-ai, genkit-plugin, genkit-retriever, genkitx, plugin
- Language: TypeScript
- Homepage: https://xavidop.github.io/genkitx-voiceflow/
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-genkit - `genkitx-voiceflow` - Plugin for Voiceflow KB. (Plugins / JavaScript - Community)
README
Firebase Genkit <> Voiceflow Plugin
Voiceflow Community Plugin for Google Firebase Genkit
**`genkitx-voiceflow`** is a community plugin for using Voiceflow Knowledge base in
[Firebase Genkit](https://github.com/firebase/genkit). Built by [**Xavier Portilla Edo**](https://github.com/xavidop).
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Indexer](#indexer)
- [Basic examples](#basic-examples)
- [Within a flow](#within-a-flow)
- [Retriever](#retriever)
- [Basic examples](#basic-examples-1)
- [Within a flow](#within-a-flow-1)
- [Examples](#examples)
- [Feature supported from Voiceflow Knowledge Base](#feature-supported-from-voiceflow-knowledge-base)
- [API Reference](#api-reference)
- [Contributing](#contributing)
- [Need support?](#need-support)
- [Credits](#credits)
- [License](#license)
## Installation
Install the plugin in your project with your favorite package manager:
- `npm install genkitx-voiceflow`
- `pnpm add genkitx-voiceflow`
## Configuration
To use the plugin, you need to configure it with your Voiceflow API key. You can do this by calling the `genkit` function:
```typescript
import { genkit, z } from 'genkit';
import {github, openAIGpt4o} from "genkitx-voiceflow";
const ai = genkit({
plugins: [
openAI({ apiKey: process.env.OPENAI_API_KEY }),
voiceflow([
{
name: 'kb',
clientParams: {
apiKey: process.env.VOICEFLOW_API_KEY!,
}
},
])
],
});
```
## Usage
The plugin provides two main functionalities: `index` and `retrieve`. You can use them directly or within a Genkit flow.
### Indexer
Indexer is used to index documents in the Voiceflow Knowledge Base. Voiceflow Knowledge Base only works with documents that contain a `media` field with a `url` property. The URL could be a link to a website or to a local file with `file://`.
#### Basic examples
The simplest way to call the indexer is by using the helper function `index`:
```typescript
const voiceflowIndexer = voiceflowIndexerRef({
name: 'kb'
});
const documents = [{ content: [{ media: { url: 'https://www.voiceflow.com' } }] }];
await ai.index({ indexer: voiceflowIndexer, documents });
```
#### Within a flow
```typescript
// ...configure Genkit (as shown above)...
export const indexerFlow = ai.defineFlow(
{
name: 'indexerFlow',
inputSchema: z.string(),
outputSchema: z.string(),
},
async () => {
const voiceflowIndexer = voiceflowIndexerRef({
name: 'kb'
});
const documents = [{ content: [{ media: { url: 'https://www.voiceflow.com' } }] }];
await ai.index({ indexer: voiceflowIndexer, documents });
return 'done';
}
);
```
### Retriever
A retriever is used to retrieve documents from the Voiceflow Knowledge Base. You can pass a query and options to the retriever. The options object can contain the following properties:
1. `querySettings`: An object with the following properties:
- `model`: The model to use for the query. The default is `gpt-4o`.
- `temperature`: The temperature to use for the query. The default is `0.7`.
- `system`: The system prompt to use for the query. The default is `''`.
2. `k`: The number of documents to retrieve. The default is `5`.
3. `filters`: filters to apply to the query. The default is `[]`.
#### Basic examples
The simplest way to call the retriever is by using the helper function `retrieve`:
```typescript
const voiceflowRetriever = voiceflowRetrieverRef({
name: 'retriever'
});
const docs = await ai.retrieve({ retriever: voiceflowRetriever, query: subject,
options:{
querySettings: { model: 'gpt-4o', temperature: 0.7 },
k: 5
}});
```
#### Within a flow
```typescript
// ...configure Genkit (as shown above)...
export const retrieverFlow = ai.defineFlow(
{
name: 'retrieverFlow',
inputSchema: z.string(),
outputSchema: z.string(),
},
async (subject) => {
const voiceflowRetriever = voiceflowRetrieverRef({
name: 'retriever'
});
const docs = await ai.retrieve({ retriever: voiceflowRetriever, query: subject,
options:{
querySettings: { model: 'gpt-4o', temperature: 0.7 },
k: 5
}});
const llmResponse = await ai.generate({
prompt: `What is Voiceflow?`,
docs: docs,
});
return llmResponse.text;
}
);
```
For more detailed examples and the explanation of other functionalities, refer to the [official Genkit documentation](https://firebase.google.com/docs/genkit/get-started).
## Examples
You can find more examples in the [examples](https://github.com/xavidop/genkitx-voiceflow/blob/main/examples/) folder.
## Feature supported from Voiceflow Knowledge Base
This plugins supports all the features supported by the Vocieflow Knowledge Base API. You can find the full list of features in the [Voiceflow Knowledge Base API Reference](https://docs.voiceflow.com/reference/post_knowledge-base-query-1).
## API Reference
You can find the full API reference in the [API Reference Documentation](https://xavidop.github.io/genkitx-voiceflow/)
## Contributing
Want to contribute to the project? That's awesome! Head over to our [Contribution Guidelines](https://github.com/xavidop/genkitx-voiceflow/blob/main/CONTRIBUTING.md).
## Need support?
> [!NOTE]
> This repository depends on Google's Firebase Genkit. For issues and questions related to Genkit, please refer to instructions available in [Genkit's repository](https://github.com/firebase/genkit).
Reach out by opening a discussion on [GitHub Discussions](https://github.com/xavidop/genkitx-voiceflow/discussions).
## Credits
This plugin is proudly maintained by Xavier Portilla Edo [**Xavier Portilla Edo**](https://github.com/xavidop).
## License
This project is licensed under the [Apache 2.0 License](https://github.com/xavidop/genkitx-voiceflow/blob/main/LICENSE).
[](https://github.com/xavidop/genkitx-voiceflow/blob/main/LICENSE)