Skip to content

Commit

Permalink
Incorporated review comments:
Browse files Browse the repository at this point in the history 
- Updated the classifier_url description with a link to the Pebblo Server Configuration.
- Fixed values for classifier_location.
  • Loading branch information
@Raj725
Raj725 committed Oct 7, 2024
1 parent ceea03e commit b2208d4
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 23 deletions.
22 changes: 11 additions & 11 deletions docs/gh_pages/docs/rag.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,17 @@ export PEBBLO_CLASSIFIER_URL="<pebblo-server-host:pebblo-server-port>"
## 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
Expand Down
24 changes: 12 additions & 12 deletions docs/gh_pages/docs/retrieval_chain.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)._

Expand Down

0 comments on commit b2208d4

Please sign in to comment.