Struct ResponsesApi 

pub struct ResponsesApi { /* private fields */ }

API for creating model responses.

Implementations

impl ResponsesApi

pub fn create(&self, model: impl Into<String>) -> CreateResponseBuilder

Create a new response request builder.

Example

use xai_rust::{XaiClient, Role};

let client = XaiClient::from_env()?;

let response = client.responses()
    .create("grok-4")
    .message(Role::System, "You are a helpful assistant.")
    .message(Role::User, "Hello!")
    .temperature(0.7)
    .send()
    .await?;

pub fn deferred(&self, response_id: impl Into<String>) -> DeferredResponsePoller

Create a deferred response poller.

pub fn chat(&self, model: impl Into<String>) -> StatefulChat

Create a stateful chat handle for multi-turn interactions.

This helper keeps a local message list and lets you append messages over time, then sample or stream with the accumulated context.

pub async fn get(&self, response_id: &str) -> Result<Response>

Get a previous response by ID.

pub async fn delete(&self, response_id: &str) -> Result<()>

Delete a response by ID.

pub async fn poll_until_ready( &self, response_id: &str, max_attempts: u32, ) -> Result<Response>

Poll a response until output is available or attempts are exhausted.

Trait Implementations

impl Clone for ResponsesApi

fn clone(&self) -> ResponsesApi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponsesApi

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.