Struct TextBatchRequest 

pub struct TextBatchRequest {

    pub id: String,
    pub model_id: ModelId,
    pub system: Option<Instructions>,
    pub prompt: Option<String>,
    pub messages: Option<Vec<Message>>,
    pub allow_system_in_messages: bool,
    pub tools: ToolSet,
    pub tool_choice: Option<ToolChoice>,
    pub active_tools: Option<Vec<ToolName>>,
    pub tool_order: Vec<ToolName>,
    pub tools_context: Option<JsonValue>,
    pub settings: CallSettings,
    pub response_format: Option<ResponseFormat>,
}

A text generation request of a batch (the settings part of generate_text, without callbacks or cancellation).

Fields

id: String

Request id, unique within the batch.

model_id: ModelId

Model id at the provider.

system: Option<Instructions>

System instructions.

prompt: Option<String>

Single user prompt (exclusive with messages).

messages: Option<Vec<Message>>

Conversation (exclusive with prompt).

allow_system_in_messages: bool

Whether system messages may appear inside messages.

tools: ToolSet

Tools offered to the model (the batch provider cannot execute them).

tool_choice: Option<ToolChoice>

Tool choice.

active_tools: Option<Vec<ToolName>>

Tools sent to the model (all when None).

tool_order: Vec<ToolName>

Tool order.

tools_context: Option<JsonValue>

Shared tool context used to resolve dynamic descriptions.

settings: CallSettings

Sampling settings and provider options.

response_format: Option<ResponseFormat>

Response format.

Implementations

impl TextBatchRequest

pub fn new(id: impl Into<String>, model_id: impl Into<ModelId>) -> Self

Creates a request for model_id.

pub fn system(self, system: impl Into<Instructions>) -> Self

Sets the system instructions.

pub fn prompt(self, prompt: impl Into<String>) -> Self

Sets a single user prompt.

pub fn messages(self, messages: impl IntoIterator<Item = Message>) -> Self

Sets the conversation.

pub fn allow_system_in_messages(self, allow: bool) -> Self

Allows system messages inside the conversation.

pub fn tools(self, tools: ToolSet) -> Self

Sets the tools.

pub fn tool_choice(self, tool_choice: ToolChoice) -> Self

Sets the tool choice.

pub fn active_tools( self, active_tools: impl IntoIterator<Item = impl Into<ToolName>>, ) -> Self

Restricts the tools sent to the model.

pub fn tool_order( self, tool_order: impl IntoIterator<Item = impl Into<ToolName>>, ) -> Self

Sets the tool order.

pub fn tools_context(self, context: JsonValue) -> Self

Sets the shared tool context.

pub fn settings(self, settings: CallSettings) -> Self

Sets the sampling settings and provider options.

pub fn response_format(self, response_format: ResponseFormat) -> Self

Sets the response format.

pub fn provider_options(self, provider_options: ProviderOptions) -> Self

Sets the provider options.

Trait Implementations

impl Clone for TextBatchRequest

fn clone(&self) -> TextBatchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextBatchRequest

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

Formats the value using the given formatter.

impl From<TextBatchRequest> for BatchRequest

fn from(request: TextBatchRequest) -> Self

Converts to this type from the input type.