Skip to content

docs: document file search result limits #1981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HAYDEN-OAI wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Open

docs: document file search result limits #1981

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions helpers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,26 @@ openai.beta.threads.runs.submitToolOutputsStream();

This method can be used to submit a tool output to a run waiting on the output and start a stream.

### Configuring file search results

`max_num_results` is a run-level `file_search` tool override. Set it at
`tools[].file_search.max_num_results` when creating or streaming a run:

```ts
const run = openai.beta.threads.runs.stream(thread.id, {
assistant_id: assistant.id,
tools: [
{
type: 'file_search',
file_search: { max_num_results: 10 },
},
],
});
```

Message attachments only associate a file with the `file_search` tool, so their `tools` entries use
`{ type: 'file_search' }` without a nested `file_search` configuration object.

### Assistant Events

The assistant API provides events you can subscribe to for the following events.
Expand Down
Loading