shreemaan-abhishek commented on code in PR #11568: URL: https://github.com/apache/apisix/pull/11568#discussion_r1774814251
########## docs/en/latest/plugins/ai-rag.md: ########## @@ -0,0 +1,200 @@ +--- +title: ai-rag +keywords: + - Apache APISIX + - API Gateway + - Plugin + - ai-rag +description: This document contains information about the Apache APISIX ai-rag Plugin. +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +## Description + +The `ai-rag` plugin integrates Retrieval-Augmented Generation (RAG) capabilities with AI models. +It allows efficient retrieval of relevant documents or information from external data sources and +augments the AI's responses with that data, improving the accuracy and context of generated outputs. + +**_This plugin must be used in routes that proxy requests to LLMs only._** + +## Plugin Attributes + +| **Field** | **Required** | **Type** | **Description** | +| ----------------------------------------------- | ------------ | -------- | -------------------------------------------- | +| embeddings_provider | Yes | Object | Configuration for the embeddings provider | +| embeddings_provider.azure_openai | Yes | Object | Configuration for Azure OpenAI embeddings | Review Comment: yes, we might have to support other providers if the need be. So I have written code in a modular way. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
