Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion genkit-tools/telemetry-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

License: Apache 2.0
2 changes: 1 addition & 1 deletion js/ai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

License: Apache 2.0
2 changes: 1 addition & 1 deletion js/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

License: Apache 2.0
2 changes: 1 addition & 1 deletion js/plugins/checks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,4 @@ Run `genkit start -- tsx --watch src/index.ts` and open the Genkit UI, usually a

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repository. Please file issues and pull requests against that repository.

Usage information and reference details can be found in the [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in the [official Genkit documentation](https://genkit.dev/docs/get-started/).
2 changes: 1 addition & 1 deletion js/plugins/chroma/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

License: Apache 2.0
7 changes: 7 additions & 0 deletions js/plugins/compat-oai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@

This Genkit plugin allows to use OpenAI models through their official APIs.

Official OpenAI-compatible provider documentation:

- [OpenAI](https://genkit.dev/docs/integrations/openai/)
- [xAI (Grok)](https://genkit.dev/docs/integrations/xai/)
- [DeepSeek](https://genkit.dev/docs/integrations/deepseek/)
- [Other compatible APIs](https://genkit.dev/docs/integrations/openai-compatible/)

## Supported models

This plugin also supports OpenAI models, and custom models from other model providers.
Expand Down
2 changes: 1 addition & 1 deletion js/plugins/dev-local-vectorstore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,6 @@ main();

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

License: Apache 2.0
4 changes: 3 additions & 1 deletion js/plugins/express/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This plugin provides utilities for conveninetly exposing Genkit flows and actions via Express HTTP server as REST APIs.

See [official documentation](https://genkit.dev/docs/frameworks/express/) for more.

## Installation

To use this plugin, install it in your project:
Expand Down Expand Up @@ -129,7 +131,7 @@ startFlowServer({

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

## License

Expand Down
7 changes: 6 additions & 1 deletion js/plugins/firebase/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Firebase plugin for Genkit

See the official documentation for more:

- [Deploying Genkit with Firebase](https://genkit.dev/docs/deployment/firebase/)
- [Genkit monitoring with Firebase](https://genkit.dev/docs/observability/getting-started/)

## Installing the plugin

```bash
Expand All @@ -23,6 +28,6 @@ const ai = genkit({

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/).

License: Apache 2.0
2 changes: 1 addition & 1 deletion js/plugins/google-cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Visit the [Getting started](https://genkit.dev/docs/observability/getting-starte

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

License: Apache 2.0
5 changes: 5 additions & 0 deletions js/plugins/google-genai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

This plugin provides a unified interface to connect with Google's generative AI models, offering access through both the **Gemini Developer API** and **Vertex AI**. It is a replacement for the previous `googleAI` and `vertexAI` plugins.

Official documentation:

- [Genkit + Gemini Developer API](https://genkit.dev/docs/integrations/google-genai/)
- [Genkit + Vertex AI](https://genkit.dev/docs/integrations/vertex-ai/)

## Installation

```bash
Expand Down
2 changes: 1 addition & 1 deletion js/plugins/langchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

License: Apache 2.0
2 changes: 2 additions & 0 deletions js/plugins/mcp/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Genkit MCP

See [Genkit MCP documentation](https://genkit.dev/docs/model-context-protocol/).

This plugin provides integration between Genkit and the [Model Context Protocol](https://modelcontextprotocol.io) (MCP). MCP is an open standard allowing developers to build "servers" which provide tools, resources, and prompts to clients. Genkit MCP allows Genkit developers to:
- Consume MCP tools, prompts, and resources as a client using `createMcpHost` or `createMcpClient`.
- Provide Genkit tools and prompts as an MCP server using `createMcpServer`.
Expand Down
4 changes: 3 additions & 1 deletion js/plugins/next/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Genkit Next.js Plugin

See [official documentation](https://genkit.dev/docs/frameworks/nextjs/) for more.

This plugin provides utilities for conveninetly exposing Genkit flows and actions via Next.js app routs for REST APIs.

```ts
Expand Down Expand Up @@ -62,6 +64,6 @@ console.log(await result.output());

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

License: Apache 2.0
2 changes: 2 additions & 0 deletions js/plugins/ollama/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Ollama plugin for Genkit

See [official documentation](https://genkit.dev/docs/integrations/ollama/) for more.

## Installing the plugin

```bash
Expand Down
2 changes: 1 addition & 1 deletion js/plugins/pinecone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ let docs = await ai.retrieve({ retriever: pineconeRetrieverRef, query });

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

License: Apache 2.0
2 changes: 1 addition & 1 deletion js/plugins/vertexai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ async () => {

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Usage information and reference details can be found in [Genkit documentation](https://genkit.dev/docs/get-started).
Usage information and reference details can be found in [official Genkit documentation](https://genkit.dev/docs/get-started/).

License: Apache 2.0
2 changes: 1 addition & 1 deletion js/testapps/vertexai-reranker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,4 @@ This project is licensed under the Apache License, Version 2.0. See the [LICENSE

This sample provides a basic demonstration of using the Vertex AI plugin with Genkit for reranking documents based on a query. It can be extended and adapted to suit more complex use cases and integrations with other data sources and services.

For more information, please refer to the official [Genkit documentation](https://genkit.dev/docs/get-started).
For more information, please refer to the official [official Genkit documentation](https://genkit.dev/docs/get-started/).
2 changes: 1 addition & 1 deletion js/testapps/vertexai-vector-search-bigquery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ This project is licensed under the Apache License, Version 2.0. See the [LICENSE

This sample provides a basic demonstration of using Vertex AI plugins with Genkit for document indexing and retrieval. It can be extended and adapted to suit more complex use cases and integrations with other data sources and services.

For more information, please refer to the official [Genkit documentation](https://genkit.dev/docs/get-started).
For more information, please refer to the official [official Genkit documentation](https://genkit.dev/docs/get-started/).
2 changes: 1 addition & 1 deletion js/testapps/vertexai-vector-search-custom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,4 @@ This project is licensed under the Apache License, Version 2.0. See the [LICENSE

This sample provides a basic demonstration of using Vertex AI plugins with Genkit for document indexing and retrieval. It can be extended and adapted to suit more complex use cases and integrations with other data sources and services.

For more information, please refer to the official [Genkit documentation](https://genkit.dev/docs/get-started).
For more information, please refer to the official [official Genkit documentation](https://genkit.dev/docs/get-started/).
2 changes: 1 addition & 1 deletion js/testapps/vertexai-vector-search-firestore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,4 @@ This project is licensed under the Apache License, Version 2.0. See the [LICENSE

This sample provides a basic demonstration of using Vertex AI plugins with Genkit for document indexing and retrieval. It can be extended and adapted to suit more complex use cases and integrations with other data sources and services.

For more information, please refer to the official [Genkit documentation](https://genkit.dev/docs/get-started).
For more information, please refer to the official [official Genkit documentation](https://genkit.dev/docs/get-started/).
Loading