Implementation:Openai Openai python Response File Search Call In Progress

Knowledge Sources	Openai_Openai_python OpenAI API Reference
Domains	API_Types, Responses_API
Last Updated	2026-02-15 00:00 GMT

Overview

Concrete streaming event type emitted when a file search call is initiated, provided by the openai-python SDK.

Description

ResponseFileSearchCallInProgressEvent is a Pydantic model representing a streaming event emitted when a file search tool call begins execution. It contains the item_id identifying the output item that initiated the search, an output_index for the item position, a sequence_number for event ordering, and a fixed type of "response.file_search_call.in_progress". This type is auto-generated from the OpenAI OpenAPI specification by Stainless.

Usage

Import ResponseFileSearchCallInProgressEvent when handling streaming events and you need to detect that a file search tool call has started (for example, to show a loading indicator).

Code Reference

Source Location

• Repository: openai-python
• File: src/openai/types/responses/response_file_search_call_in_progress_event.py

Signature

class ResponseFileSearchCallInProgressEvent(BaseModel):
    """Emitted when a file search call is initiated."""

    item_id: str
    output_index: int
    sequence_number: int
    type: Literal["response.file_search_call.in_progress"]

Import

from openai.types.responses import ResponseFileSearchCallInProgressEvent

I/O Contract

Fields

Name	Type	Required	Description
item_id	str	Yes	The ID of the output item that the file search call is initiated.
output_index	int	Yes	The index of the output item that the file search call is initiated.
sequence_number	int	Yes	The sequence number of this event.
type	Literal["response.file_search_call.in_progress"]	Yes	The type of the event. Always "response.file_search_call.in_progress".

Usage Examples

from openai.types.responses import ResponseFileSearchCallInProgressEvent

# Show progress indicator when file search starts
for event in stream:
    if isinstance(event, ResponseFileSearchCallInProgressEvent):
        print(f"File search in progress for item {event.item_id}...")
        show_loading_indicator(event.item_id)

Related Pages

• Environment:Openai_Openai_python_Python_3_9_Plus