Struct StreamingApi 

pub struct StreamingApi { /* private fields */ }

Streaming API client (extends ResponsesApi)

Implementations

impl StreamingApi

pub fn new(api_key: impl Into<String>) -> Result<Self>

Create a new StreamingApi client

pub fn with_base_url<S: Into<String>>(api_key: S, base_url: S) -> Result<Self>

Create a new StreamingApi client with custom base URL

pub async fn create_response_stream( &self, request: &ResponseRequest, ) -> Result<ResponseStream>

Create a streaming response

pub async fn create_text_stream( &self, model: impl Into<String>, prompt: impl Into<String>, ) -> Result<ResponseStream>

Create a simple text streaming response

pub async fn create_chat_stream( &self, model: impl Into<String>, messages: Vec<Message>, ) -> Result<ResponseStream>

Create a streaming chat response

pub async fn create_instructed_stream( &self, model: impl Into<String>, input: impl Into<String>, instructions: impl Into<String>, ) -> Result<ResponseStream>

Create a streaming response with instructions

pub async fn collect_stream_response(stream: ResponseStream) -> Result<String>

Collect all chunks from a stream into a single response

pub async fn create_channel_stream( &self, request: &ResponseRequest, ) -> Result<UnboundedReceiverStream<Result<StreamChunk>>>

Create a channel-based stream for easier handling

pub async fn create_function_stream( &self, request: &ResponseRequest, tools: Vec<Tool>, tool_choice: Option<ToolChoice>, ) -> Result<FunctionStream>

Create a streaming response with function calling support

pub async fn call_function_stream( &self, model: impl Into<String>, prompt: impl Into<String>, tools: Vec<Tool>, tool_choice: Option<ToolChoice>, ) -> Result<FunctionStream>

Create a simple function call stream

pub fn responses_api(&self) -> &ResponsesApi

Get access to the underlying ResponsesApi

Trait Implementations

impl ApiClientConstructors for StreamingApi

fn from_http_client(http_client: HttpClient) -> Self

Create a new instance with the HTTP client

fn new<S: Into<String>>(api_key: S) -> Result<Self>

Creates a new API client

fn new_with_base_url<S: Into<String>>(api_key: S, base_url: S) -> Result<Self>

Creates a new API client with custom base URL

impl Clone for StreamingApi

fn clone(&self) -> StreamingApi

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.