Struct AssistantInvokeRequest 

pub struct AssistantInvokeRequest {
    pub assistant_id: AssistantId,
    pub conversation_id: Option<String>,
    pub model: AssistantModel,
    pub messages: Vec<AssistantMessage>,
    pub stream: bool,
    pub request_id: Option<String>,
    pub user_id: Option<String>,
    pub do_sample: Option<bool>,
    pub attachments: Option<Vec<Map<String, Value>>>,
    pub metadata: Option<Map<String, Value>>,
    pub extra_parameters: Option<AssistantExtraParameters>,
}

Invoke an assistant.

Fields

assistant_id: AssistantId

Assistant identifier.

conversation_id: Option<String>

Existing conversation identifier, when continuing a conversation.

model: AssistantModel

Assistant model. This required field is always serialized.

messages: Vec<AssistantMessage>

User messages. The frozen schema requires at least one item.

stream: bool

Streaming flag. The JSON-only send_via path requires this to remain false and serializes it explicitly because the server default is true.

request_id: Option<String>

Caller-provided request identifier (6..=64 characters).

user_id: Option<String>

End-user identifier (6..=128 characters).

do_sample: Option<bool>

Whether sampling is enabled.

attachments: Option<Vec<Map<String, Value>>>

Open attachment objects from the upstream schema.

metadata: Option<Map<String, Value>>

Open metadata map (additionalProperties: true).

extra_parameters: Option<AssistantExtraParameters>

Typed assistant-specific parameters.

Implementations

impl AssistantInvokeRequest

pub fn new(assistant_id: AssistantId, messages: Vec<AssistantMessage>) -> Self

Create an invocation with all OpenAPI-required fields.

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

Continue an existing conversation.

pub fn with_model(self, model: AssistantModel) -> Self

Select the assistant model.

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

Set the caller-provided request identifier.

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

Set the end-user identifier.

pub fn with_sampling(self, enabled: bool) -> Self

Select the sampling behavior.

pub fn with_attachments(self, attachments: Vec<Map<String, Value>>) -> Self

Set attachment objects.

pub fn with_metadata(self, metadata: Map<String, Value>) -> Self

Set open metadata fields.

pub fn with_extra_parameters(self, parameters: AssistantExtraParameters) -> Self

Set typed assistant-specific parameters.

pub fn validate(&self) -> ZaiResult<()>

Validate OpenAPI length and minimum-item constraints.

pub async fn send_via( &self, client: &ZaiClient, ) -> ZaiResult<AssistantInvokeResponse>

Send the request through client.

Trait Implementations

impl Clone for AssistantInvokeRequest

fn clone(&self) -> AssistantInvokeRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssistantInvokeRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AssistantInvokeRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AssistantInvokeRequest

fn eq(&self, other: &AssistantInvokeRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AssistantInvokeRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AssistantInvokeRequest