effect-io-ai

Package: @effect/ai
Module: Response

Response.ToolResultPart

Response part representing the result of a tool call.

Example

import { Either } from "effect"
import { Response } from "@effect/ai"

interface WeatherData {
  temperature: number
  condition: string
  humidity: number
}

const toolResultPart: Response.ToolResultPart<
  "get_weather",
  WeatherData,
  never
> = Response.toolResultPart({
  id: "call_123",
  name: "get_weather",
  isFailure: false,
  result: {
    temperature: 22,
    condition: "sunny",
    humidity: 65
  },
  encodedResult: {
    temperature: 22,
    condition: "sunny",
    humidity: 65
  },
  providerExecuted: false
})

Signature

type ToolResultPart<Name, Success, Failure> = | ToolResultSuccess<Name, Success>
  | ToolResultFailure<Name, Failure>

Source

Since v1.0.0