Struct OrchestrateClient 

pub struct OrchestrateClient { /* private fields */ }

WatsonX Orchestrate client for managing custom assistants and document collections

Implementations

impl OrchestrateClient

pub fn new(config: OrchestrateConfig) -> Self

Create a new Orchestrate client (matches wxo-client-main pattern)

pub fn with_token(self, token: String) -> Self

Set the access token for authentication

pub fn set_token(&mut self, token: String)

Set the access token for authentication (mutable)

pub fn config(&self) -> &OrchestrateConfig

Get the current configuration

pub fn is_authenticated(&self) -> bool

Check if authenticated

pub async fn generate_jwt_token(api_key: &str) -> Result<String>

Generate IAM Access Token from Watson Orchestrate API key This is required for Watson Orchestrate SaaS authentication

pub async fn list_assistants(&self) -> Result<Vec<CustomAssistant>>

List all custom assistants

pub async fn send_batch_messages( &self, request: BatchMessageRequest, ) -> Result<BatchMessageResponse>

Send multiple messages in a batch

pub async fn list_skills(&self) -> Result<Vec<Skill>>

List all skills

pub async fn get_skill(&self, skill_id: &str) -> Result<Skill>

Get a specific skill by ID

impl OrchestrateClient

pub async fn list_agents(&self) -> Result<Vec<Agent>>

List all agents (Watson Orchestrate API)

pub async fn get_agent(&self, agent_id: &str) -> Result<Agent>

Get a specific agent by ID

impl OrchestrateClient

pub async fn list_threads( &self, agent_id: Option<&str>, ) -> Result<Vec<ThreadInfo>>

List all threads for an agent

pub async fn create_thread(&self, agent_id: Option<&str>) -> Result<ThreadInfo>

Create a new thread for conversation

pub async fn delete_thread(&self, thread_id: &str) -> Result<()>

Delete a thread

pub async fn get_thread_messages(&self, thread_id: &str) -> Result<Vec<Message>>

Get conversation history from a thread

impl OrchestrateClient

pub async fn list_tools(&self) -> Result<Vec<Tool>>

List all tools

pub async fn get_tool(&self, tool_id: &str) -> Result<Tool>

Get a specific tool by ID

pub async fn execute_tool( &self, request: ToolExecutionRequest, ) -> Result<ToolExecutionResult>

Execute a tool directly

pub async fn update_tool( &self, tool_id: &str, request: ToolUpdateRequest, ) -> Result<Tool>

Update a tool

pub async fn delete_tool(&self, tool_id: &str) -> Result<()>

Delete a tool

pub async fn test_tool( &self, request: ToolTestRequest, ) -> Result<ToolTestResult>

Test a tool with sample input

pub async fn get_tool_execution_history( &self, tool_id: &str, limit: Option<u32>, ) -> Result<Vec<ToolExecutionHistory>>

Get tool execution history

pub async fn get_tool_versions(&self, tool_id: &str) -> Result<Vec<ToolVersion>>

Get tool versions

impl OrchestrateClient

pub async fn get_run(&self, run_id: &str) -> Result<RunInfo>

Get information about a specific run

pub async fn list_runs(&self, agent_id: Option<&str>) -> Result<Vec<RunInfo>>

List all runs for an agent

pub async fn cancel_run(&self, run_id: &str) -> Result<()>

Cancel a running execution

impl OrchestrateClient

pub async fn list_collections(&self) -> Result<Vec<DocumentCollection>>

List all document collections

pub async fn get_collection( &self, collection_id: &str, ) -> Result<DocumentCollection>

Get a specific document collection

pub async fn get_document( &self, collection_id: &str, document_id: &str, ) -> Result<Document>

Get a specific document from a collection

pub async fn delete_document( &self, collection_id: &str, document_id: &str, ) -> Result<()>

Delete a document from a collection

pub async fn search_documents( &self, collection_id: &str, request: SearchRequest, ) -> Result<SearchResponse>

Search documents in a collection

impl OrchestrateClient

pub async fn send_message( &self, agent_id: &str, message: &str, thread_id: Option<String>, ) -> Result<(String, Option<String>)>

Send a message to an agent and get response (matches wxo-client pattern) Uses /runs/stream endpoint and maintains thread_id for conversation continuity

pub async fn stream_message<F>( &self, agent_id: &str, message: &str, thread_id: Option<String>, callback: F, ) -> Result<Option<String>>

where F: FnMut(String) -> Result<()>,

Stream response from an agent (matches wxo-client pattern)

pub async fn get_chat_with_docs_status( &self, agent_id: &str, thread_id: &str, ) -> Result<ChatWithDocsStatus>

Get the status of chat with documents knowledge base for a thread

pub async fn chat_with_docs( &self, agent_id: &str, thread_id: &str, request: ChatWithDocsRequest, ) -> Result<ChatWithDocsResponse>

Send a message with document context (chat with documents)

pub async fn stream_chat_with_docs<F>( &self, agent_id: &str, thread_id: &str, request: ChatWithDocsRequest, callback: F, ) -> Result<()>

where F: FnMut(String) -> Result<()>,

Stream chat with documents response