ResponsesArguments

Struct ResponsesArguments 

Source
pub struct ResponsesArguments {
    pub model: String,
    pub input: Vec<ResponsesMessage>,
    pub tools: Option<Vec<GrokTool>>,
    pub temperature: Option<f32>,
    pub max_output_tokens: Option<u32>,
}
Expand description

Request arguments for xAI’s Responses API endpoint (/v1/responses).

This API provides agentic tool calling where the model autonomously explores, searches, and executes code. Unlike the Chat Completions API, the Responses API uses input instead of messages and tools instead of server_tools.

§Example

use openai_rust2::chat::{ResponsesArguments, ResponsesMessage, GrokTool};

let args = ResponsesArguments::new(
    "grok-4-1-fast-reasoning",
    vec![ResponsesMessage {
        role: "user".to_string(),
        content: "What is the current price of Bitcoin?".to_string(),
    }],
).with_tools(vec![GrokTool::web_search()]);

Fields§

§model: String§input: Vec<ResponsesMessage>§tools: Option<Vec<GrokTool>>§temperature: Option<f32>§max_output_tokens: Option<u32>

Implementations§

Source§

impl ResponsesArguments

Source

pub fn new(model: impl AsRef<str>, input: Vec<ResponsesMessage>) -> Self

Create new ResponsesArguments for the xAI Responses API.

Source

pub fn with_tools(self, tools: Vec<GrokTool>) -> Self

Add tools for agentic capabilities.

Source

pub fn with_temperature(self, temperature: f32) -> Self

Set the temperature for response generation.

Source

pub fn with_max_output_tokens(self, max_tokens: u32) -> Self

Set the maximum output tokens.

Trait Implementations§

Source§

impl Clone for ResponsesArguments

Source§

fn clone(&self) -> ResponsesArguments

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ResponsesArguments

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Serialize for ResponsesArguments

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more