Struct Tool 

pub struct Tool {
    pub tool_type: String,
    pub function: Function,
}

Wire types for chat completion requests, responses, and streaming. Chat completion request, response, and message types. Wire types for chat completion requests, responses, and streaming. Chat completion request, response, and message types. A function tool definition passed in the tools array of a request.

Fields

tool_type: String

Always "function" for function-type tools.

function: Function

Function specification.

Implementations

impl Tool

pub fn former() -> ToolFormer<ToolFormerDefinition<(), Tool, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

impl Tool

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

Convenience constructor for a function-type tool.

Examples

use api_openai_compatible::Tool;

let tool = Tool::function(
  "get_weather",
  "Get current weather for a location",
  serde_json::json!({ "type": "object", "properties": {} }),
);

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for Tool

where __End: FormingEnd<ToolFormerDefinitionTypes<__Context, __Formed>>,

type Definition = ToolFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = ToolFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for Tool

type Types = ToolFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation.

impl<Definition> EntityToFormer<Definition> for Tool

where Definition: FormerDefinition<Storage = ToolFormerStorage>,

type Former = ToolFormer<Definition>

The type of the former (builder) used for constructing the entity.

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic.

impl EntityToStorage for Tool

type Storage = ToolFormerStorage

The storage type used for forming the entity.

impl PartialEq for Tool

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Tool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tool