Skip to content
This repository was archived by the owner on Apr 30, 2026. It is now read-only.

Commit 19c8b2b

Browse files
authored
Fix readme (#4)
* fix readme * increment version --------- Co-authored-by: akhatre <akhatre@users.noreply.github.com>
1 parent 3eae662 commit 19c8b2b

2 files changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ pip install overmind
2727

2828
### Use default Overmind agent
2929

30-
Get your free Overmind API key at [overmind.evallab.dev](overmind.evallab.dev)
30+
Get your free Overmind API key at [overmind.evallab.dev](https://overmind.evallab.dev)
3131

3232
Below we initialise the Overmind client and call GPT-4o-mini using `default_agent`. This will run our `reject_prompt_injection` and `reject_irrelevant_answer` policies.
3333
```python
@@ -37,17 +37,19 @@ from overmind.client import OvermindClient
3737
# Set env variables (or pass directly to the client)
3838
# Get your free overmind API key at overmind.evallab.dev
3939
os.environ["OVERMIND_API_KEY"] = "your_overmind_api_key"
40-
os.environ["OPENAI_API_KEY"] = "youtr_openai_api_key"
40+
os.environ["OPENAI_API_KEY"] = "your_openai_api_key"
4141

4242
overmind = OvermindClient()
4343

4444

4545
# Use existing OpenAI client methods
46-
response = client.openai.chat.completions.create(
46+
response = overmind.openai.chat.completions.create(
4747
model="gpt-4o-mini",
48-
messages=[{"role": "user", "content": "Tell me a joke"}],
48+
messages=[{"role": "user", "content": "Tell me a joke about LLMs"}],
4949
agent_id="default_agent"
5050
)
51+
52+
response.summary()
5153
```
5254

5355

@@ -83,12 +85,14 @@ messages = [
8385
]
8486

8587
# Use existing OpenAI client methods but now you can pass your policies
86-
result = overmind.openai.chat.completions.create(
88+
response = overmind.openai.chat.completions.create(
8789
model='gpt-4o-mini',
8890
messages=messages,
8991
input_policies=[input_pii_policy],
9092
output_policies=[output_llm_judge_criteria]
9193
)
94+
95+
response.summary()
9296
```
9397
## Further usage
9498

@@ -98,4 +102,4 @@ We are not storing your API keys and you are solely responsible for managing the
98102

99103
On ours side we run policy executions for free as this is an alpha stage product. We may impose usage limits and scale our services up and down from time to time.
100104

101-
We apprecaite any feedback, collaboration or other suggestions. You can reach out at [support@evallab.dev](mailto:support@evallab.dev)
105+
We appreciate any feedback, collaboration or other suggestions. You can reach out at [support@evallab.dev](mailto:support@evallab.dev)

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "overmind"
3-
version = "0.1.5"
3+
version = "0.1.6"
44
description = "Python client for Overmind API"
55
authors = ["Overmind Ltd"]
66
readme = "README.md"

0 commit comments

Comments
 (0)