From b2208d48ae8de5607838651c56dba38d001fe644 Mon Sep 17 00:00:00 2001 From: Rajendra Kadam Date: Mon, 7 Oct 2024 18:16:40 +0530 Subject: [PATCH] Incorporated review comments: - Updated the classifier_url description with a link to the Pebblo Server Configuration. - Fixed values for classifier_location. --- docs/gh_pages/docs/rag.md | 22 +++++++++++----------- docs/gh_pages/docs/retrieval_chain.md | 24 ++++++++++++------------ 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/gh_pages/docs/rag.md b/docs/gh_pages/docs/rag.md index f4810145..b0ede4d0 100644 --- a/docs/gh_pages/docs/rag.md +++ b/docs/gh_pages/docs/rag.md @@ -45,17 +45,17 @@ export PEBBLO_CLASSIFIER_URL="" ## Parameters PebbloSafeLoader takes the following parameters: -| Parameter | Type | Description | -|:-------------------|:--------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| name | str | Name of the application; should be unique across the loader and retriever applications. | -| owner | str | (**Optional**, Default: None) Owner of the application. | -| description | str | (**Optional**, Default: None) Description of the application. | -| loader | DocumentLoader| Langchain DocumentLoader. | -| api_key | str | (**Optional**, Default: None) API Key for Pebblo Cloud; if not provided, PebbloSafeLoader will look for `PEBBLO_API_KEY` in the environment. If found, documents will be sent to Pebblo Cloud.| -| load_semantic | bool | (**Optional**, Default: False) Indicates whether to include semantic metadata in the documents being loaded into VectorDB. | -| classifier_url | str | (**Optional**, Default: http://localhost:8000) URL of the Pebblo Classifier Server. | -| classifier_location| str | (**Optional**, Default: local) Location of the classifier, local or cloud. | -| anonymize_snippets | bool | (**Optional**, Default: False) Indicates whether to anonymize snippets in the document. | +| Parameter | Type | Description | +|:-------------------|:--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | str | Name of the application; should be unique across the loader and retriever applications. | +| owner | str | (**Optional**, Default: None) Owner of the application. | +| description | str | (**Optional**, Default: None) Description of the application. | +| loader | DocumentLoader| Langchain DocumentLoader. | +| api_key | str | (**Optional**, Default: None) API Key for Pebblo Cloud; if not provided, PebbloSafeLoader will look for `PEBBLO_API_KEY` in the environment. If found, documents will be sent to Pebblo Cloud. | +| load_semantic | bool | (**Optional**, Default: False) Indicates whether to include semantic metadata in the documents being loaded into VectorDB. | +| classifier_url | str | (**Optional**, Default: http://localhost:8000) URL of the Pebblo Classifier Server. For more details on configuring the server URL, see [Pebblo Server Configuration](https://daxa-ai.github.io/pebblo/config#server). | +| classifier_location| str | (**Optional**, Default: local) Location of the classifier, 'local' or 'pebblo-cloud'. | +| anonymize_snippets | bool | (**Optional**, Default: False) Indicates whether to anonymize snippets in the document. | ## Supported Document Loaders diff --git a/docs/gh_pages/docs/retrieval_chain.md b/docs/gh_pages/docs/retrieval_chain.md index 88060027..af26de17 100644 --- a/docs/gh_pages/docs/retrieval_chain.md +++ b/docs/gh_pages/docs/retrieval_chain.md @@ -150,18 +150,18 @@ def ask(question: str, auth_context: dict): ### Parameters PebbloRetrievalQA takes the following parameters: -| Parameter | Type | Description | -|:-------------------|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| llm | BaseLanguageModel | Langchain LLM instance. | -| app_name | str | Name of the application; should be unique across the loader and retriever applications. | -| owner | str | (**Optional**, Default: None) Owner of the application. | -| description | str | (**Optional**, Default: None) Description of the application. | -| chain_type | str | Type of document combining chain to use. Should be one of "stuff", "map_reduce", "map_rerank", and "refine". | -| retriever | VectorStoreRetriever| Vector database retriever. | -| verbose | bool | (**Optional**, Default: False) Whether chains should be run in verbose mode or not. | -| api_key | str | (**Optional**, Default: None) API Key for Pebblo Cloud; if not provided, PebbloRetrievalQA will look for `PEBBLO_API_KEY` in the environment. If found, retrieval data will be sent to Pebblo Cloud.| -| classifier_url | str | (**Optional**, Default: http://localhost:8000) URL of the Pebblo Classifier Server. | -| classifier_location| str | (**Optional**, Default: local) Location of the classifier, local or cloud. | +| Parameter | Type | Description | +|:-------------------|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| llm | BaseLanguageModel | Langchain LLM instance. | +| app_name | str | Name of the application; should be unique across the loader and retriever applications. | +| owner | str | (**Optional**, Default: None) Owner of the application. | +| description | str | (**Optional**, Default: None) Description of the application. | +| chain_type | str | Type of document combining chain to use. Should be one of "stuff", "map_reduce", "map_rerank", and "refine". | +| retriever | VectorStoreRetriever | Vector database retriever. | +| verbose | bool | (**Optional**, Default: False) Whether chains should be run in verbose mode or not. | +| api_key | str | (**Optional**, Default: None) API Key for Pebblo Cloud; if not provided, PebbloRetrievalQA will look for `PEBBLO_API_KEY` in the environment. If found, retrieval data will be sent to Pebblo Cloud. | +| classifier_url | str | (**Optional**, Default: http://localhost:8000) URL of the Pebblo Classifier Server. For more details on configuring the server URL, see [Pebblo Server Configuration](https://daxa-ai.github.io/pebblo/config#server). | +| classifier_location| str | (**Optional**, Default: local) Location of the classifier, 'local' or 'pebblo-cloud'. | \* _In addition to the above-mentioned parameters, `PebbloRetrievalQA` also supports the keyword arguments that are supported by the [Langchain Chain class](https://python.langchain.com/api_reference/langchain/chains/langchain.chains.base.Chain.html#langchain.chains.base.Chain)._