Skip to content

Commit

Permalink
Update Pebblo Docs Footer (#517)
Browse files Browse the repository at this point in the history
  • Loading branch information
rutujaac authored Aug 31, 2024
1 parent f13be94 commit d8b15b0
Show file tree
Hide file tree
Showing 15 changed files with 31 additions and 4 deletions.
2 changes: 2 additions & 0 deletions docs/gh_pages/docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,5 @@ logging:
```

This flexibility empowers users to tailor configurations to their specific needs while retaining default values for other sections or fields.

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=7abf7d3d-2654-4615-9d7a-d3db68033da7" />
2 changes: 2 additions & 0 deletions docs/gh_pages/docs/daemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ $ tree
│   │   │   └── metadata.json
│   │   └── report.json
```

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=b1163405-aa55-41aa-bc9f-9a594c7eb4a3" />
2 changes: 2 additions & 0 deletions docs/gh_pages/docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,5 @@ to open a pull request against the main Pebblo repo.
Please join Discord server [https://discord.gg/wyAfaYXwwv](https://discord.gg/wyAfaYXwwv) to reach out to the Pebblo maintainers, contributors and users.

![Discord](https://img.shields.io/discord/1199861582776246403?logo=discord)

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=5dcf02e7-b7ad-472b-89a9-0f235430dbad" />
2 changes: 2 additions & 0 deletions docs/gh_pages/docs/entityclassifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,5 @@ User can get details of classified entities for their loader source files in Peb
Different sections of Pebblo report such as , `Top Files with Most Findings`, `Data Source Findings Table` and `Snippets` helps to get overview of pebblo entity classifier output for user's Rag application.

For more details refer - [Reports](reports.md)

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=64a603c5-db24-48b3-bbaa-0e5ca775e1cf" />
1 change: 1 addition & 0 deletions docs/gh_pages/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,4 @@ brew install pango
sudo apt-get install libpango-1.0-0 libpangoft2-1.0-0
```

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=ebe2593f-57f9-4e35-9b17-da30daa6c509" />
2 changes: 2 additions & 0 deletions docs/gh_pages/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,5 @@ Pebblo has two components.
- [Configuration](config.md)
- [Reports](reports.md)
- [Troubleshooting](troubleshooting.md)

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=5e0e30b5-5738-4d87-90d7-ff7e5324200c" />
2 changes: 2 additions & 0 deletions docs/gh_pages/docs/llama_index_safe_reader.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,5 @@ The following LlamaIndex DocumentReaders are currently supported.


> Note : _Most other LlamaIndex document readers that implement load_data() method should work. The above list indicates the ones that are explicitly tested. If you have successfully tested a particular DocumentReader other than this list above, please consider raising a PR.
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=cd474d67-1474-4733-a400-7b17e403590c" />
2 changes: 2 additions & 0 deletions docs/gh_pages/docs/rag.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,5 @@ The following Langchain DocumentLoaders are currently supported.
1. SharePointLoader

> Note <sup>1</sup>: _Most other Langchain document loaders that implement load() and lazy_load() methods should work. The above list indicates the ones that are explicitly tested. If you have successfully tested a particular DocumentLoader other than this list above, please consider raising an PR._
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=663e4c29-b156-42a6-b49e-359111bfbd5b" />
2 changes: 2 additions & 0 deletions docs/gh_pages/docs/reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,5 @@ This table provides a summary of all the different Topics and Entities found acr
# Snippets

This sections provides the actual text inspected by the `Pebblo Server` using the `Pebblo Topic Classifier` and `Pebblo Entity Classifier`. This will be useful to quickly inspect and remediate text that should not be ingested into the Gen-AI RAG application. Each snippet shows the exact file the snippet is loaded from easy remediation.

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=50c3c41f-d0e1-4b3e-ad99-dc9ab5ad2ac1" />
4 changes: 3 additions & 1 deletion docs/gh_pages/docs/retrieval_chain.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,4 +207,6 @@ I don't know, I'm sorry.
## Prompt Governance
When a user sends any prompt to the LLM using PebbloRetrieveQA, Pebblo captures the findings from that prompt. This behavior is enabled by default.

***Coming Soon***: Ability to block or anonymize prompts based on policy.
***Coming Soon***: Ability to block or anonymize prompts based on policy.

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=fd3b5c16-cba2-4212-87b2-9b9a9bea9ee1" />
4 changes: 3 additions & 1 deletion docs/gh_pages/docs/safe_retriever.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,6 @@ This page shows all the prompt with findings for all the applications.
1. **Entity Name**: The name of the entity which is present in the prompts.
2. **Prompts**: Number of prompts in which the entity was detected.
3. **Users**: Users who have used this entity in the prompt.
4. **Apps** : Application in which the entity is present.
4. **Apps** : Application in which the entity is present.

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=9302659d-2a79-4999-9bc7-7ac1172fb264" />
4 changes: 3 additions & 1 deletion docs/gh_pages/docs/safe_retriever_samples.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,6 @@ This section provides a identity-filtering focused sample of Pebblo Safe Retrive
This section provides a semantic-filtering focused sample of Pebblo Safe Retriver enabled RAG applications loading documents from `GoogleDrive` folder and storing in `Qdrant` VectorDB collection.

**Link:**
[Google Drive-Qdrant Semantic RAG Sample App](https://github.com/daxa-ai/pebblo/tree/main/pebblo_saferetriever/langchain/semantic-rag/googledrive-qdrant)
[Google Drive-Qdrant Semantic RAG Sample App](https://github.com/daxa-ai/pebblo/tree/main/pebblo_saferetriever/langchain/semantic-rag/googledrive-qdrant)

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=bea40d19-c5e8-4cee-ad9f-26c124996bb3" />
2 changes: 2 additions & 0 deletions docs/gh_pages/docs/topicclassifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,5 @@ User can get details of classified topics for their loader source files in Pebbl
Different sections of Pebblo report such as , `Top Files With Most Findings`, `Data Source Findings Table` and `Snippets` helps to get overview of pebblo topic classifier output for user's rag application.

For more details refer - [Reports](reports.md)

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=fa7fbe6b-f5a4-490b-8492-526b023d5cdc" />
2 changes: 2 additions & 0 deletions docs/gh_pages/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@
sudo apt-get update
sudo apt-get install libpango1.0-0
```

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=4f6e05d7-1d73-45dc-abc9-244ee4d905ff" />
2 changes: 1 addition & 1 deletion docs/gh_pages/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ const config: Config = {
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} Daxa, Inc.`,
},
prism: {
theme: prismThemes.github,
Expand Down

0 comments on commit d8b15b0

Please sign in to comment.