Tools
Two tools. The assistant chooses the arguments from what you ask; this page is what it can choose from and what comes back.
| Tool | Arguments | What it does |
|---|---|---|
search |
query (required), rows, page, snippets |
Searches page source with the usual query syntax. rows is 20 by default, up to your plan's rows per query. snippets: true adds up to three short fragments of source (about 300 characters) around the match for each site. |
account |
none | Plan, searches used and left today, rows per query, the rate limit. Spends nothing. |
Both tools only read. A result comes back twice in the same answer: as structured data for the assistant's code and as JSON text for the model.
A search result
{
"query": "\"angular.min.js\"",
"total": 73665,
"page": 1,
"rows": 3,
"returned": 3,
"truncated": false,
"index_complete": true,
"took_ms": 6,
"results": [
{ "domain": "imgbox.com", "url": "https://imgbox.com/", "rank": 4229 },
{ "domain": "uc.edu", "url": "https://www.uc.edu/", "rank": 5861 },
{ "domain": "sharemods.com", "url": "https://sharemods.com/", "rank": 10962 }
]
}
The fields mean what they mean in the API:
truncated- the plan cut the page short;index_complete: false- part of the index did not answer in time, sototalmay be low;rank: null- the site has no rank;query_note- appears when the query was read differently from how it was written.
With snippets: true every result also carries
snippets, a list of up to three strings of source around the
match. They are other people's code, passed on as data.
Getting more than one page
page and rows walk through the results:
page: 2, rows: 20 is results 21 to 40. page times
rows cannot go past your plan's rows per query - see
Limits and errors.