Run Object
id: string
ID of the task that a user can use for polling it's status
result: object | null
status: string - any of completed, failed,in_progress
requirements_resultobject[]
Detailed results for each requirement.
show fields
score float| null
A value between 0 and 1 indicating how well the requirement was fulfilled.
finish_reason string| null
a textual reason what happened - one of Perfect score | Budget exhausted
requirements object[]
A list of search requirement shown in the report.
show fields
name string | null
The name provided (or default name) of the requirement requested to be fulfilled
description string | null
When a user provides the requirement explicitly, it’s what the user provided
score float | null
A value between 0 and 1 indicating how well the requirement was fulfilled.
reason - string | null
A textual reason about why the requirement didn’t reach a perfect score
data_sources object
Specifies the data sources used to retrieve contextual information for a run. Contains optional web_search and file_search results.
show fields
web_search object[]
A list of search web retrieved from web search.
show fields
url string
The URL of the search result.
text string
The snippet or content returned from the search.
score float
The relevance score of the result.
file_search object[]
A list of search web retrieved from user-uploaded files.
show fields
file_name string
The name of the file where the result was found.
text string | null
The text snippet retrieved from the file.
score float
The relevance score of the result.
order integer
The order in which the result appears in the file.