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.
HostedToolCapabilityError
Section titled “HostedToolCapabilityError”from cayu.providers import HostedToolCapabilityErrorA 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
OpenAIWebSearch
Section titled “OpenAIWebSearch”from cayu.providers import OpenAIWebSearchRegistration-time authority for OpenAI’s hosted Responses web search.
Bases: BaseModel.
Fields and attributes
Section titled “Fields and attributes”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 |
validate_domains (method)
Section titled “validate_domains (method)”OpenAIWebSearch.validate_domains(value: object, info) -> tuple[str, ...]validate_filters (method)
Section titled “validate_filters (method)”OpenAIWebSearch.validate_filters() -> OpenAIWebSearch