Skip to content

Commit 26a9221

Browse files
committed
Move langevals docs inside the repo, standalone, separately from langwatch
1 parent 223534b commit 26a9221

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+6177
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,7 @@ make install
260260

261261
This will also generate the `langevals.code-workspace` file, creating a different workspace per evaluator and telling VS Code which venv to use for each. Then, open this file on vscode and click the "Open Workspace" button
262262

263+
263264
## Adding New Evaluators
264265

265266
To add a completely new evaluator for a library or API that is not already implemented, copy the `evaluators/example` folder, and follow the `example/word_count.py` boilerplate to implement your own evaluator, adding the dependencies on `pyproject.toml`, and testing it properly, following the `test_word_count.py` example.

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.DS_Store
2+
!openapi.json

docs/.vscode/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"[mdx]": {
3+
"editor.formatOnSave": false
4+
}
5+
}

docs/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# LangWatch and LangEvals Documentation
2+
3+
This is the documentation repository for the [LangWatch](https://github.com/langwatch/langwatch) and [LangEvals](https://github.com/langwatch/langevals) projects.
4+
5+
### Development
6+
7+
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command:
8+
9+
```
10+
npm i -g mintlify
11+
```
12+
13+
Run the following command:
14+
15+
```
16+
mintlify dev
17+
```
18+
19+
### Publishing Changes
20+
21+
Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: 'Jailbreak Detection'
3+
openapi: 'POST /azure/jailbreak/evaluate'
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: 'Prompt Injection Detection'
3+
openapi: 'POST /azure/prompt_injection/evaluate'
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: 'Prompt Injection Detection'
3+
openapi: 'POST /langevals/competitor_blocklist/evaluate'
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: 'Competitor Detection with LLM'
3+
openapi: 'POST /langevals/competitor_llm/evaluate'
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: 'Content Safety'
3+
openapi: 'POST /azure/content_safety/evaluate'
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: 'PII Detection'
3+
openapi: 'POST /google_cloud/dlp_pii_detection/evaluate'
4+
---

0 commit comments

Comments
 (0)