openai_file_search_callout
Dispatches the loop owner’s pending file-search assignments against a vector store API compatible backend.
On this page
Dispatches the loop owner’s pending file-search assignments against a vector store API compatible backend.
Configuration Notes
The enclosing iterative router owns model re-entry and openai_agentic_loop owns the loop decision; this filter only executes the assignments the owner recorded, at request-body EOS on re-entry. Streaming composes through the step-local openai_stream_events filter, whose finalizer synthesizes citation-annotated file_search lifecycle frames at EOS. Search queries are forwarded unchanged; model context and citation marker formatting are internal.
Configuration
| Field | Type | Required | Description |
|---|---|---|---|
outbound_chain | string | object | no | Outbound filter chain every vector-store sub-request runs through. The chain carries cross-cutting concerns (observability, credential injection, security) and is bound into a prebuilt pipeline at registration time via [ChainBindingContext::bind_chain]. The destination is supplied by vector_store_url, so the chain never needs an upstream-selecting filter. Private-address gating is centralized in insecure_options.allow_private_upstreams. Optional. Callouts always run through the shared sub-request executor; this chain only adds filters along the way. When omitted it defaults to an empty inline chain (pure passthrough) via default_outbound_chain. Provide it only to attach cross-cutting concerns. When provided, it must be defined inline (outbound_chain: { name: ..., filters: [...] }). A Named reference to a top-level filter_chains entry is rejected at construction by [require_inline_outbound_chain]: this filter runs nested inside an iterative_request_router step, whose pipeline is built with an empty named-chain map, so a named reference could never resolve there. |
user_credential | string | no | Optional callout-credential slot. When configured, every vector-store request uses that caller-scoped value as its Authorization header. |
on_failure | closed | open | no | Behaviour when a vector-store callout fails. |
forward_headers | string[] | no | Headers to forward from the original request to the vector store API for authentication and tenant isolation. No downstream headers are forwarded by default. |
max_response_bytes | integer | no | Maximum response body size in bytes per callout. |
max_total_response_bytes | integer | no | Maximum cumulative successful response bytes per filter execution. |
max_state_bytes | integer | no | Maximum combined iterative-router and file-search continuation bytes. The filter’s value may differ from the enclosing iterative_request_router; the smaller limit wins at runtime. |
timeout_ms | integer | no | Whole-call timeout in milliseconds. Inside an iterative request router, the effective timeout is capped by the router’s remaining deadline. |
vector_store_url | string | yes | Base URL for the vector store API. |