Skip to main content

InteractionTool

Enum InteractionTool 

Source
pub enum InteractionTool {
    Function {
        name: Option<String>,
        description: Option<String>,
        parameters: Option<Value>,
    },
    CodeExecution,
    UrlContext,
    ComputerUse {
        environment: Option<ComputerUseEnvironment>,
        excluded_predefined_functions: Vec<String>,
        enable_prompt_injection_detection: Option<bool>,
        disabled_safety_policies: Vec<ComputerUseSafetyPolicy>,
    },
    McpServer {
        name: Option<String>,
        url: Option<String>,
        headers: Option<Value>,
        allowed_tools: Option<AllowedTools>,
    },
    GoogleSearch {
        search_types: Vec<GoogleSearchType>,
    },
    FileSearch {
        file_search_store_names: Vec<String>,
        top_k: Option<i64>,
        metadata_filter: Option<String>,
    },
    GoogleMaps {
        enable_widget: Option<bool>,
        latitude: Option<f64>,
        longitude: Option<f64>,
    },
    Retrieval {
        retrieval_types: Vec<RetrievalType>,
        exa_ai_search_config: Option<ExaAISearchConfig>,
        parallel_ai_search_config: Option<ParallelAISearchConfig>,
        rag_store_config: Option<RagStoreConfig>,
    },
}
Expand description

Tool declaration — type-tagged polymorphic.

Variants§

§

Function

Fields

§description: Option<String>
§parameters: Option<Value>
§

CodeExecution

§

UrlContext

§

ComputerUse

Fields

§excluded_predefined_functions: Vec<String>
§enable_prompt_injection_detection: Option<bool>
§disabled_safety_policies: Vec<ComputerUseSafetyPolicy>
§

McpServer

Fields

§headers: Option<Value>
§allowed_tools: Option<AllowedTools>
§

GoogleSearch

Fields

§search_types: Vec<GoogleSearchType>
§

FileSearch

Fields

§file_search_store_names: Vec<String>
§top_k: Option<i64>
§metadata_filter: Option<String>
§

GoogleMaps

Fields

§enable_widget: Option<bool>
§latitude: Option<f64>
§longitude: Option<f64>
§

Retrieval

Fields

§retrieval_types: Vec<RetrievalType>
§exa_ai_search_config: Option<ExaAISearchConfig>
§parallel_ai_search_config: Option<ParallelAISearchConfig>
§rag_store_config: Option<RagStoreConfig>

Implementations§

Source§

impl InteractionTool

Source

pub fn function( name: impl Into<String>, description: impl Into<String>, parameters: Value, ) -> Self

Create a function tool.

Create a Google Search tool.

Source

pub fn code_execution() -> Self

Create a code execution tool.

Source

pub fn url_context() -> Self

Create a URL context tool.

Source

pub fn google_maps() -> Self

Create a Google Maps tool.

Create a file search tool.

Source

pub fn mcp_server(name: impl Into<String>, url: impl Into<String>) -> Self

Create an MCP Server tool.

Source

pub fn computer_use(environment: ComputerUseEnvironment) -> Self

Create a computer use tool.

Source

pub fn retrieval(retrieval_types: Vec<RetrievalType>) -> Self

Create a retrieval tool.

Trait Implementations§

Source§

impl Clone for InteractionTool

Source§

fn clone(&self) -> InteractionTool

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 InteractionTool

Source§

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

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

impl<'de> Deserialize<'de> for InteractionTool

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 InteractionTool

Source§

fn eq(&self, other: &InteractionTool) -> 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 InteractionTool

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 InteractionTool

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

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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