Skip to content

cayu.providers.hosted

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

from cayu.providers import HostedToolCapabilityError

A provider target cannot honor admitted provider-hosted authority.

Bases: ValueError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

from cayu.providers import OpenAIWebSearch

Registration-time authority for OpenAI’s hosted Responses web search.

Bases: BaseModel.

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
type Literal['openai_web_search'] 'openai_web_search'
search_context_size Literal['low', 'medium', 'high'] 'medium'
external_web_access StrictBool True
allowed_domains tuple[str, ...] Field(default=(), max_length=100)
blocked_domains tuple[str, ...] Field(default=(), max_length=100)
return_token_budget Literal['default', 'unlimited'] 'default'
include_sources StrictBool True
OpenAIWebSearch.validate_domains(value: object, info) -> tuple[str, ...]
OpenAIWebSearch.validate_filters() -> OpenAIWebSearch

Release source · Runtime guarantees · Capability guides