Web search

Let Olive search the web while it answers. Coming soon.

Coming soon

This feature is not available on the API yet. This page describes how it will work.

Web search is not available yet. When it ships, Olive will search the web while it answers. On Responses, Olive will decide when to search, and can open a page and find text in it when it needs more than the search results.

When to use it

  • A question depends on current guidance or a recent drug safety notice.
  • You want Olive to check a claim against a page before it answers.

Responses takes a web_search tool:

curl https://api.avey.ai/llm/responses \
  -H "Authorization: Bearer $AVEY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "olive",
    "input": "Has the guidance on first-line treatment for this condition changed recently?",
    "tools": [{ "type": "web_search" }]
  }'

Chat Completions takes web_search_options instead. Here Olive does not decide: the server searches once, on the last user message, before Olive answers.

response = client.chat.completions.create(
    model="olive",
    web_search_options={},
    messages=[
        {"role": "user", "content": "Has the guidance on first-line treatment for this condition changed recently?"}
    ],
)

The Go samples reuse the Quickstart client. Add the imports each sample uses.

Limits

LimitValue
AvailabilityWhile web search is off, a request that sends web_search or web_search_options returns 400.
Blocked domainsblocked_domains returns 400 on both APIs.
Chat Completions searchesOne per request, on the text of the last user message
Chat Completions citationsA non-streamed answer has url_citation annotations. A streamed answer has none.

Things to know

  • A page can be wrong, out of date, or written to mislead. A clinician checks the answer against the source before it informs care.
  • On Responses, Olive may search again or open a page when its first results are not enough.
Last updated