diff --git a/genkit-tools/telemetry-server/README.md b/genkit-tools/telemetry-server/README.md index 301023ddbc..7c2c790d7e 100644 --- a/genkit-tools/telemetry-server/README.md +++ b/genkit-tools/telemetry-server/README.md @@ -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 diff --git a/js/ai/README.md b/js/ai/README.md index 301023ddbc..7c2c790d7e 100644 --- a/js/ai/README.md +++ b/js/ai/README.md @@ -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 diff --git a/js/core/README.md b/js/core/README.md index 301023ddbc..7c2c790d7e 100644 --- a/js/core/README.md +++ b/js/core/README.md @@ -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 diff --git a/js/plugins/checks/README.md b/js/plugins/checks/README.md index 66e7b086b4..8d8ad8025b 100644 --- a/js/plugins/checks/README.md +++ b/js/plugins/checks/README.md @@ -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/). diff --git a/js/plugins/chroma/README.md b/js/plugins/chroma/README.md index 301023ddbc..7c2c790d7e 100644 --- a/js/plugins/chroma/README.md +++ b/js/plugins/chroma/README.md @@ -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 diff --git a/js/plugins/compat-oai/README.md b/js/plugins/compat-oai/README.md index 71ff88bb95..1f6897b869 100644 --- a/js/plugins/compat-oai/README.md +++ b/js/plugins/compat-oai/README.md @@ -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. diff --git a/js/plugins/dev-local-vectorstore/README.md b/js/plugins/dev-local-vectorstore/README.md index e436562640..44f3ada277 100644 --- a/js/plugins/dev-local-vectorstore/README.md +++ b/js/plugins/dev-local-vectorstore/README.md @@ -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 diff --git a/js/plugins/express/README.md b/js/plugins/express/README.md index 56fd87749b..adbed594ac 100644 --- a/js/plugins/express/README.md +++ b/js/plugins/express/README.md @@ -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: @@ -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 diff --git a/js/plugins/firebase/README.md b/js/plugins/firebase/README.md index 1203106a23..4f1c1b2f78 100644 --- a/js/plugins/firebase/README.md +++ b/js/plugins/firebase/README.md @@ -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 @@ -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 diff --git a/js/plugins/google-cloud/README.md b/js/plugins/google-cloud/README.md index 03d2d101cd..7840a95ca4 100644 --- a/js/plugins/google-cloud/README.md +++ b/js/plugins/google-cloud/README.md @@ -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 diff --git a/js/plugins/google-genai/README.md b/js/plugins/google-genai/README.md index 6242290bbb..2ea2904780 100644 --- a/js/plugins/google-genai/README.md +++ b/js/plugins/google-genai/README.md @@ -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 diff --git a/js/plugins/langchain/README.md b/js/plugins/langchain/README.md index 301023ddbc..7c2c790d7e 100644 --- a/js/plugins/langchain/README.md +++ b/js/plugins/langchain/README.md @@ -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 diff --git a/js/plugins/mcp/README.md b/js/plugins/mcp/README.md index 58569fce86..5240691dc4 100644 --- a/js/plugins/mcp/README.md +++ b/js/plugins/mcp/README.md @@ -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`. diff --git a/js/plugins/next/README.md b/js/plugins/next/README.md index 0037b22591..97c2b6e727 100644 --- a/js/plugins/next/README.md +++ b/js/plugins/next/README.md @@ -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 @@ -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 diff --git a/js/plugins/ollama/README.md b/js/plugins/ollama/README.md index 832544042c..d0c15f064d 100644 --- a/js/plugins/ollama/README.md +++ b/js/plugins/ollama/README.md @@ -1,5 +1,7 @@ # Ollama plugin for Genkit +See [official documentation](https://genkit.dev/docs/integrations/ollama/) for more. + ## Installing the plugin ```bash diff --git a/js/plugins/pinecone/README.md b/js/plugins/pinecone/README.md index 73b4d55721..6001d6aa3b 100644 --- a/js/plugins/pinecone/README.md +++ b/js/plugins/pinecone/README.md @@ -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 diff --git a/js/plugins/vertexai/README.md b/js/plugins/vertexai/README.md index 1ffb19fdd2..0d21d53a78 100644 --- a/js/plugins/vertexai/README.md +++ b/js/plugins/vertexai/README.md @@ -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 diff --git a/js/testapps/vertexai-reranker/README.md b/js/testapps/vertexai-reranker/README.md index 06b3f38bbb..b61df1d2dd 100644 --- a/js/testapps/vertexai-reranker/README.md +++ b/js/testapps/vertexai-reranker/README.md @@ -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/). diff --git a/js/testapps/vertexai-vector-search-bigquery/README.md b/js/testapps/vertexai-vector-search-bigquery/README.md index 9ff9d3b4ed..e0b634a7f6 100644 --- a/js/testapps/vertexai-vector-search-bigquery/README.md +++ b/js/testapps/vertexai-vector-search-bigquery/README.md @@ -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/). diff --git a/js/testapps/vertexai-vector-search-custom/README.md b/js/testapps/vertexai-vector-search-custom/README.md index b75b5e0549..6004b88d54 100644 --- a/js/testapps/vertexai-vector-search-custom/README.md +++ b/js/testapps/vertexai-vector-search-custom/README.md @@ -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/). diff --git a/js/testapps/vertexai-vector-search-firestore/README.md b/js/testapps/vertexai-vector-search-firestore/README.md index 90c6a403aa..e17bed58b2 100644 --- a/js/testapps/vertexai-vector-search-firestore/README.md +++ b/js/testapps/vertexai-vector-search-firestore/README.md @@ -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/).