Skip to main content

ExecutionsClient

Struct ExecutionsClient 

Source
pub struct ExecutionsClient { /* private fields */ }
Expand description

Sub-client for execution operations that are not project-scoped (lookup, resume, cancel, document helpers, await). Obtained via AkribesClient::executions().

For project-scoped operations (run, list, etc.), see ScopedExecutionsClient via [crate::client::ProjectScope::executions].

Implementations§

Source§

impl ExecutionsClient

Source

pub async fn resume( &self, execution_id: &str, token: &str, data: Value, ) -> Result<Value>

Resume a suspended checkpoint within a running execution.

Source

pub async fn cancel(&self, execution_id: &str) -> Result<bool>

Cancel a specific execution by ID; returns true if it was cancelled.

Source

pub async fn children( &self, execution_id: &str, ) -> Result<Vec<ExecutionChildSummary>>

List child executions spawned by execution_id via the engine’s spawn_child_execution callback (#1054). Returns an empty Vec when no children exist (the common case for v1 where parent-linkage columns are typically NULL). Mirrors TS executions.children and Python executions.children.

Source

pub async fn get(&self, execution_id: &str) -> Result<Option<ExecutionStatus>>

Fetch the full status record for an execution.

Source

pub async fn tasks( &self, execution_id: &str, ) -> Result<Option<ExecutionTasksResponse>>

Per-task cost / token / duration breakdown for an execution (GET /executions/{id}/tasks). Reads from the execution_tasks table populated as TaskEnd events arrive, so callers don’t have to parse the event JSON to recover this data. Useful for monolith workflows where there are no spawned children — every agent invocation lives in execution_tasks keyed by task_name.

404 → Ok(None) (the execution doesn’t exist or isn’t accessible to this token), matching get / get_output. Mirrors the TS SDK’s executions.tasks.

Source

pub async fn get_output( &self, execution_id: &str, ) -> Result<Option<ExecutionOutput>>

Fetch only the output (status, error, result) for an execution.

Source

pub async fn get_events( &self, execution_id: &str, after_id: Option<i64>, limit: Option<i64>, types: Option<&str>, ) -> Result<Option<ExecutionEvents>>

Return the persisted event stream for an execution. types is an optional comma-separated allowlist ("TaskEnd,Error,WorkflowEnd") that lets callers slim down responses on long workflows.

Source

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

Get document metadata by ID.

Source

pub async fn get_document_markdown(&self, document_id: &str) -> Result<String>

Get converted markdown for a document.

Source

pub async fn get_document_url(&self, document_id: &str) -> Result<String>

Get a presigned download URL for the original document file.

Source

pub async fn reconvert_document(&self, document_id: &str) -> Result<Value>

Retry conversion on a failed document.

Source

pub async fn run_from_node( &self, project_id: i64, script_name: &str, seed_env: HashMap<String, Value>, skip_node_ids: Vec<usize>, channel: Option<&str>, inputs: Option<HashMap<String, Value>>, ) -> Result<RunResult>

Run a script from a specific point with pre-seeded environment values.

Convenience wrapper that doesn’t require building a ScopedExecutionsClient first — useful for callers (e.g. akribes-mcp) that already know the project_id numerically. Forwards to ScopedExecutionsClient::run_from.

seed_env carries pre-computed variable values for nodes already completed by a prior execution; skip_node_ids lists those node IDs so the engine skips re-running them. channel defaults to draft.

Source

pub async fn await_execution( &self, execution_id: &str, timeout_ms: Option<u64>, poll_interval_ms: Option<u64>, ) -> Result<ExecutionOutput>

Poll get_output until the execution reaches a terminal state.

Source

pub async fn await_result( &self, execution_id: &str, timeout_ms: Option<u64>, poll_interval_ms: Option<u64>, ) -> Result<ExecutionOutput>

Cross-SDK naming alias for [await_execution]. Mirrors the Python SDK’s await_result; forwarded verbatim so callers porting examples across SDKs don’t trip on the rename. Refs #109 (item 3: method-naming consistency).

Trait Implementations§

Source§

impl Clone for ExecutionsClient

Source§

fn clone(&self) -> ExecutionsClient

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ExecutionsClient

Source§

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

Formats the value using the given formatter. 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> Same for T

Source§

type Output = T

Should always be Self
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