Skip to content

Commit 046f8cc

Browse files
authored
Fix typos across repo (#218)
1 parent f6e68f4 commit 046f8cc

File tree

19 files changed

+35
-29
lines changed

19 files changed

+35
-29
lines changed

.changeset/tame-deers-shake.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
"@openai/agents-core": patch
3+
"@openai/agents-openai": patch
4+
"@openai/agents-realtime": patch
5+
---
6+
7+
Fix typos across repo

docs/src/content/docs/extensions/twilio.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ raw audio from a phone call to a WebSocket server. This set up can be used to co
1212
[voice agents](/openai-agents-js/guides/voice-agents) to Twilio. You can use the default Realtime Session transport
1313
in `websocket` mode to connect the events coming from Twilio to your Realtime Session. However,
1414
this requires you to set the right audio format and adjust your own interruption timing as phone
15-
calls will naturally introduce more latency than a web-based converstaion.
15+
calls will naturally introduce more latency than a web-based conversation.
1616

1717
To improve the set up experience, we've created a dedicated transport layer that handles the
1818
connection to Twilio for you, including handling interruptions and audio forwarding for you.
@@ -72,7 +72,7 @@ for more information on how to use the `RealtimeSession` with voice agents.
7272

7373
In order to receive all the necessary events and audio from Twilio, you should create your
7474
`TwilioRealtimeTransportLayer` instance as soon as you have a reference to the WebSocket
75-
connetion and immediately call `session.connect()` afterwards.
75+
connection and immediately call `session.connect()` afterwards.
7676

7777
2. **Access the raw Twilio events.**
7878

docs/src/content/docs/guides/mcp.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ To stream incremental MCP results, pass `stream: true` when you run the `Agent`:
5959

6060
For sensitive operations you can require human approval of individual tool calls. Pass either `requireApproval: 'always'` or a fine‑grained object mapping tool names to `'never'`/`'always'`.
6161

62-
If you can programatically determine whether a tool call is safe, you can use the [`onApproval` callback](https://github.com/openai/openai-agents-js/blob/main/examples/mcp/hosted-mcp-on-approval.ts) to approve or reject the tool call. If you require human approval, you can use the same [human-in-the-loop (HITL) approach](/openai-agents-js/guides/human-in-the-loop/) using `interruptions` as for local function tools.
62+
If you can programmatically determine whether a tool call is safe, you can use the [`onApproval` callback](https://github.com/openai/openai-agents-js/blob/main/examples/mcp/hosted-mcp-on-approval.ts) to approve or reject the tool call. If you require human approval, you can use the same [human-in-the-loop (HITL) approach](/openai-agents-js/guides/human-in-the-loop/) using `interruptions` as for local function tools.
6363

6464
<Code
6565
lang="typescript"

docs/src/content/docs/guides/results.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ There are two ways you can access the inputs for your next turn:
4646

4747
## Last agent
4848

49-
The `lastAgent` property contains the last agent that ran. Depending on your application, this is often useful for the next time the user inputs something. For example, if you have a frontline triage agent that hands off to a language-specific agent, you can store the last agent, and re-use it the next time the user messages the agent.
49+
The `lastAgent` property contains the last agent that ran. Depending on your application, this is often useful for the next time the user inputs something. For example, if you have a frontline triage agent that hands off to a language-specific agent, you can store the last agent, and reuse it the next time the user messages the agent.
5050

5151
In streaming mode it can also be useful to access the `currentAgent` property that's mapping to the current agent that is running.
5252

docs/src/content/docs/guides/voice-agents/quickstart.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ import thinClientExample from '../../../../../../examples/docs/voice-agents/thin
7272

7373
4. **Create a session**
7474

75-
Unlike a regular agent, a Voice Agent is continously running and listening inside a `RealtimeSession` that handles the conversation and connection to the model over time. This session will also handle the audio processing, interruptions, and a lot of the other lifecycle functionality we will cover later on.
75+
Unlike a regular agent, a Voice Agent is continuously running and listening inside a `RealtimeSession` that handles the conversation and connection to the model over time. This session will also handle the audio processing, interruptions, and a lot of the other lifecycle functionality we will cover later on.
7676

7777
```typescript
7878
import { RealtimeSession } from '@openai/agents-realtime';
@@ -113,7 +113,6 @@ import thinClientExample from '../../../../../../examples/docs/voice-agents/thin
113113
From here you can start designing and building your own voice agent. Voice agents include a lot of the same features as regular agents, but have some of their own unique features.
114114

115115
- Learn how to give your voice agent:
116-
117116
- [Tools](/openai-agents-js/guides/voice-agents/build#tools)
118117
- [Handoffs](/openai-agents-js/guides/voice-agents/build#handoffs)
119118
- [Guardrails](/openai-agents-js/guides/voice-agents/build#guardrails)

examples/docs/results/historyLoop.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const agent = new Agent({
77
});
88

99
let history: AgentInputItem[] = [
10-
// intial message
10+
// initial message
1111
user('Are we there yet?'),
1212
];
1313

examples/handoffs/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ async function main() {
7171
result = await run(secondAgent, [
7272
...result.history,
7373
{
74-
content: 'I live in New York City. Whats the population of the city?',
74+
content: "I live in New York City. What's the population of the city?",
7575
role: 'user',
7676
},
7777
]);

examples/tools/web-search.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ async function main() {
2222
const messages = result.history;
2323
messages.push({
2424
role: 'user',
25-
content: 'search the web for more details of the highlighed player.',
25+
content: 'search the web for more details of the highlighted player.',
2626
});
2727

2828
const result2 = await run(agent, messages);

packages/agents-core/src/agent.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,30 +34,30 @@ export type ToolUseBehaviorFlags = 'run_llm_again' | 'stop_on_first_tool';
3434
export type ToolsToFinalOutputResult =
3535
| {
3636
/**
37-
* Wether this is the final output. If `false`, the LLM will run again and receive the tool call output
37+
* Whether this is the final output. If `false`, the LLM will run again and receive the tool call output
3838
*/
3939
isFinalOutput: false;
4040
/**
41-
* Wether the agent was interrupted by a tool approval. If `true`, the LLM will run again and receive the tool call output
41+
* Whether the agent was interrupted by a tool approval. If `true`, the LLM will run again and receive the tool call output
4242
*/
4343
isInterrupted: undefined;
4444
}
4545
| {
4646
isFinalOutput: false;
4747
/**
48-
* Wether the agent was interrupted by a tool approval. If `true`, the LLM will run again and receive the tool call output
48+
* Whether the agent was interrupted by a tool approval. If `true`, the LLM will run again and receive the tool call output
4949
*/
5050
isInterrupted: true;
5151
interruptions: RunToolApprovalItem[];
5252
}
5353
| {
5454
/**
55-
* Wether this is the final output. If `false`, the LLM will run again and receive the tool call output
55+
* Whether this is the final output. If `false`, the LLM will run again and receive the tool call output
5656
*/
5757
isFinalOutput: true;
5858

5959
/**
60-
* Wether the agent was interrupted by a tool approval. If `true`, the LLM will run again and receive the tool call output
60+
* Whether the agent was interrupted by a tool approval. If `true`, the LLM will run again and receive the tool call output
6161
*/
6262
isInterrupted: undefined;
6363

@@ -212,7 +212,7 @@ export interface AgentConfiguration<
212212
* This lets you configure how tool use is handled.
213213
* - run_llm_again: The default behavior. Tools are run, and then the LLM receives the results
214214
* and gets to respond.
215-
* - stop_on_first_tool: The output of the frist tool call is used as the final output. This means
215+
* - stop_on_first_tool: The output of the first tool call is used as the final output. This means
216216
* that the LLM does not process the result of the tool call.
217217
* - A list of tool names: The agent will stop running if any of the tools in the list are called.
218218
* The final output will be the output of the first matching tool call. The LLM does not process
@@ -227,7 +227,7 @@ export interface AgentConfiguration<
227227
toolUseBehavior: ToolUseBehavior;
228228

229229
/**
230-
* Wether to reset the tool choice to the default value after a tool has been called. Defaults
230+
* Whether to reset the tool choice to the default value after a tool has been called. Defaults
231231
* to `true`. This ensures that the agent doesn't enter an infinite loop of tool usage.
232232
*/
233233
resetToolChoice: boolean;
@@ -383,7 +383,7 @@ export class Agent<
383383
}
384384

385385
/**
386-
* Ouput schema name
386+
* Output schema name.
387387
*/
388388
get outputSchemaName(): string {
389389
if (this.outputType === 'text') {

packages/agents-core/src/extensions/handoffFilters.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const TOOL_TYPES = new Set([
1717
]);
1818

1919
/**
20-
* Filters out all tool items: file search, web serach and function calls+output
20+
* Filters out all tool items: file search, web search and function calls+output
2121
* @param handoffInputData
2222
* @returns
2323
*/

0 commit comments

Comments
 (0)