Struct AssistantsClient 

pub struct AssistantsClient<'a, T = ()> { /* private fields */ }

Client for assistants API.

Implementations

impl<T: Default + Send + Sync> AssistantsClient<'_, T>

pub async fn create(&self, builder: AssistantBuilder) -> Result<AssistantObject>

Create a new assistant.

Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::assistants::AssistantBuilder;

let client = Client::from_env()?;
let builder = AssistantBuilder::new("gpt-4")
    .name("Math Tutor")
    .instructions("You are a helpful math tutor.");
let assistant = client.assistants().create(builder).await?;
println!("Created assistant: {}", assistant.id);

pub async fn list( &self, limit: Option<i32>, order: Option<&str>, after: Option<&str>, before: Option<&str>, ) -> Result<ListAssistantsResponse>

List assistants with pagination.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.assistants().list(Some(20), None, None, None).await?;
println!("Found {} assistants", response.data.len());

pub async fn get( &self, assistant_id: impl Into<String>, ) -> Result<AssistantObject>

Get an assistant by ID.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let assistant = client.assistants().get("asst_123").await?;
println!("Assistant: {}", assistant.name.unwrap_or_default());

pub async fn update( &self, assistant_id: impl Into<String>, builder: AssistantBuilder, ) -> Result<AssistantObject>

Update an assistant.

Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::assistants::AssistantBuilder;

let client = Client::from_env()?;
let builder = AssistantBuilder::new("gpt-4")
    .name("Updated Name")
    .instructions("Updated instructions");
let assistant = client.assistants().update("asst_123", builder).await?;
println!("Updated: {}", assistant.id);

pub async fn delete( &self, assistant_id: impl Into<String>, ) -> Result<DeleteAssistantResponse>

Delete an assistant.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.assistants().delete("asst_123").await?;
println!("Deleted: {}", response.deleted);

pub async fn create_run( &self, thread_id: impl Into<String>, builder: RunBuilder, ) -> Result<RunObject>

Create a run on a thread.

Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::assistants::RunBuilder;

let client = Client::from_env()?;
let builder = RunBuilder::new("asst_123");
let run = client.assistants().create_run("thread_123", builder).await?;
println!("Run created: {}", run.id);

pub async fn list_runs( &self, thread_id: impl Into<String>, limit: Option<i32>, order: Option<&str>, after: Option<&str>, before: Option<&str>, ) -> Result<ListRunsResponse>

List runs on a thread.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.assistants().list_runs("thread_123", None, None, None, None).await?;
println!("Found {} runs", response.data.len());

pub async fn get_run( &self, thread_id: impl Into<String>, run_id: impl Into<String>, ) -> Result<RunObject>

Get a run.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let run = client.assistants().get_run("thread_123", "run_123").await?;
println!("Run status: {}", run.status);

pub async fn cancel_run( &self, thread_id: impl Into<String>, run_id: impl Into<String>, ) -> Result<RunObject>

Cancel a run.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let run = client.assistants().cancel_run("thread_123", "run_123").await?;
println!("Run cancelled: {}", run.status);

pub async fn submit_tool_outputs( &self, thread_id: impl Into<String>, run_id: impl Into<String>, tool_outputs: Vec<SubmitToolOutputsRunRequestToolOutputsInner>, ) -> Result<RunObject>

Submit tool outputs to a run.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let outputs = vec![
    SubmitToolOutputsRunRequestToolOutputsInner::new("call_123", "output data")
];
let run = client.assistants().submit_tool_outputs("thread_123", "run_123", outputs).await?;
println!("Tool outputs submitted: {}", run.id);

pub async fn create_message( &self, thread_id: impl Into<String>, builder: MessageBuilder, ) -> Result<MessageObject>

Create a message on a thread.

Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::assistants::MessageBuilder;

let client = Client::from_env()?;
let builder = MessageBuilder::new("user", "Hello, assistant!");
let message = client.assistants().create_message("thread_123", builder).await?;
println!("Message created: {}", message.id);

pub async fn list_messages( &self, thread_id: impl Into<String>, limit: Option<i32>, order: Option<&str>, after: Option<&str>, before: Option<&str>, run_id: Option<&str>, ) -> Result<ListMessagesResponse>

List messages on a thread.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.assistants().list_messages("thread_123", None, None, None, None, None).await?;
println!("Found {} messages", response.data.len());

pub async fn get_message( &self, thread_id: impl Into<String>, message_id: impl Into<String>, ) -> Result<MessageObject>

Get a message.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let message = client.assistants().get_message("thread_123", "msg_123").await?;
println!("Message role: {}", message.role);

pub async fn list_run_steps( &self, thread_id: impl Into<String>, run_id: impl Into<String>, limit: Option<i32>, order: Option<&str>, after: Option<&str>, before: Option<&str>, include: Option<Vec<String>>, ) -> Result<ListRunStepsResponse>

List run steps.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.assistants().list_run_steps("thread_123", "run_123", None, None, None, None, None).await?;
println!("Found {} run steps", response.data.len());

pub async fn get_run_step( &self, thread_id: impl Into<String>, run_id: impl Into<String>, step_id: impl Into<String>, include: Option<Vec<String>>, ) -> Result<RunStepObject>

Get a run step.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let step = client.assistants().get_run_step("thread_123", "run_123", "step_123", None).await?;
println!("Step type: {}", step.type_);

Trait Implementations

impl<'a, T: Clone> Clone for AssistantsClient<'a, T>

fn clone(&self) -> AssistantsClient<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for AssistantsClient<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Copy> Copy for AssistantsClient<'a, T>