Skip to content

Commit 69797b4

Browse files
authored
Merge pull request #33 from AliYmn/26
fix: correct typos in general documentation
2 parents 0d02a02 + 684b8cf commit 69797b4

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ from agents import set_default_openai_key
1010
set_default_openai_key("sk-...")
1111
```
1212

13-
Alternatively, you can also configure an OpenAI client to be used. By default, the SDK creates an `AsyncOpenAI` instance, using the API key from the environment variable or the default key set above. You can chnage this by using the [set_default_openai_client()][agents.set_default_openai_client] function.
13+
Alternatively, you can also configure an OpenAI client to be used. By default, the SDK creates an `AsyncOpenAI` instance, using the API key from the environment variable or the default key set above. You can change this by using the [set_default_openai_client()][agents.set_default_openai_client] function.
1414

1515
```python
1616
from openai import AsyncOpenAI

docs/guardrails.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Input guardrails run in 3 steps:
2121

2222
## Output guardrails
2323

24-
Output guardrailas run in 3 steps:
24+
Output guardrails run in 3 steps:
2525

2626
1. First, the guardrail receives the same input passed to the agent.
2727
2. Next, the guardrail function runs to produce a [`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput], which is then wrapped in an [`OutputGuardrailResult`][agents.guardrail.OutputGuardrailResult]
@@ -33,7 +33,7 @@ Output guardrailas run in 3 steps:
3333

3434
## Tripwires
3535

36-
If the input or output fails the guardrail, the Guardrail can signal this with a tripwire. As soon as we see a guardail that has triggered the tripwires, we immediately raise a `{Input,Output}GuardrailTripwireTriggered` exception and halt the Agent execution.
36+
If the input or output fails the guardrail, the Guardrail can signal this with a tripwire. As soon as we see a guardrail that has triggered the tripwires, we immediately raise a `{Input,Output}GuardrailTripwireTriggered` exception and halt the Agent execution.
3737

3838
## Implementing a guardrail
3939

docs/tracing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Agents SDK includes built-in tracing, collecting a comprehensive record of e
1616
- `trace_id`: A unique ID for the trace. Automatically generated if you don't pass one. Must have the format `trace_<32_alphanumeric>`.
1717
- `group_id`: Optional group ID, to link multiple traces from the same conversation. For example, you might use a chat thread ID.
1818
- `disabled`: If True, the trace will not be recorded.
19-
- `metadata`: Optiona metadata for the trace.
19+
- `metadata`: Optional metadata for the trace.
2020
- **Spans** represent operations that have a start and end time. Spans have:
2121
- `started_at` and `ended_at` timestamps.
2222
- `trace_id`, to represent the trace they belong to

0 commit comments

Comments
 (0)