Skip to main content

HostedToolOutput

providers_kit::hosted

Enum HostedToolOutput 

Source 
pub enum HostedToolOutput {
    WebSearch {
        status: Option<HostedToolStatus>,
        action: Option<HostedWebSearchAction>,
        results: Vec<HostedWebSearchResult>,
        citations: Vec<Citation>,
    },
    FileSearch {
        status: Option<HostedToolStatus>,
        queries: Vec<String>,
        results: Option<Vec<HostedFileSearchResult>>,
        citations: Vec<Citation>,
    },
    CodeExecution {
        status: Option<HostedToolStatus>,
        code: Vec<HostedExecutableCode>,
        results: Vec<HostedCodeExecutionResult>,
        artifacts: Vec<Artifact>,
    },
    UrlContext {
        requested_url: Option<String>,
        retrieved_url: Option<String>,
        status: Option<HostedToolStatus>,
        citations: Vec<Citation>,
    },
}
Expand description

One normalized provider-hosted operation or unpaired native activity.

Related invocation and result records are combined only when native identity or an unambiguous native ordering establishes the relationship. A result from an earlier turn can retain absent action or source fields. Opaque native replay remains in the returned assistant continuation, independently of this projection.

Variants§

§

WebSearch

Provider-managed web-search output.

Fields

§status: Option<HostedToolStatus>

Provider-authored execution status, when available.

§action: Option<HostedWebSearchAction>

Search action details, when returned.

§results: Vec<HostedWebSearchResult>

Normalized search results.

§citations: Vec<Citation>

Citations returned by the provider.

§

FileSearch

Provider-managed file-search output.

Fields

§status: Option<HostedToolStatus>

Provider-authored execution status, when available.

§queries: Vec<String>

Search queries issued by the provider.

§results: Option<Vec<HostedFileSearchResult>>

None means the provider omitted result details; Some([]) means included-empty.

§citations: Vec<Citation>

Citations returned by the provider.

§

CodeExecution

Provider-managed code-execution output.

Fields

§status: Option<HostedToolStatus>

Provider-authored execution status, when available.

§code: Vec<HostedExecutableCode>

Provider-returned executable code declarations, independently of execution results.

§results: Vec<HostedCodeExecutionResult>

Normalized execution results.

§artifacts: Vec<Artifact>

Artifacts produced by execution.

§

UrlContext

Provider-managed URL-retrieval output.

Fields

§requested_url: Option<String>

URL supplied to this tool invocation, when reported.

§retrieved_url: Option<String>

URL the provider attempted to retrieve, when reported.

§status: Option<HostedToolStatus>

Provider-authored execution status, when available.

§citations: Vec<Citation>

Citations returned by the provider.

Trait Implementations§

Source§

impl Clone for HostedToolOutput

Source§

fn clone(&self) -> Self

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 HostedToolOutput

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for HostedToolOutput

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for HostedToolOutput

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for HostedToolOutput

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for HostedToolOutput

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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