Function ToolResultPart

packages/ai/ai/src/Response.ts:1678–1745

(
  name: Name,
  success: Success,
  failure: Failure
)

 * @category Schemas
 */
export const ToolResultPart = <
  const Name extends string,
  Success extends Schema.Schema.Any,
  Failure extends Schema.Schema.All
>(
  name: Name,
  success: Success,
  failure: Failure
): Schema.Schema<
  ToolResultPart<Name, Schema.Schema.Type<Success>, Schema.Schema.Type<Failure>>,
  ToolResultPartEncoded
> => {
  const Base = Schema.Struct({
    id: Schema.String,
    type: Schema.Literal("tool-result"),
    providerName: Schema.optional(Schema.String),
    isFailure: Schema.Boolean
  })
  const ResultSchema = Schema.Union(success, failure)
  const Encoded = Schema.Struct({
    ...Base.fields,
    name: Schema.String,
    result: Schema.encodedSchema(ResultSchema),
    providerExecuted: Schema.optional(Schema.Boolean),
    metadata: Schema.optional(ProviderMetadata)
  })
  const Decoded = Schema.Struct({
    ...Base.fields,
    [PartTypeId]: Schema.Literal(PartTypeId),
    name: Schema.Literal(name),
    result: Schema.typeSchema(ResultSchema),
    encodedResult: Schema.encodedSchema(ResultSchema),
    providerExecuted: Schema.Boolean,
    metadata: ProviderMetadata
  })
  const decodeResult = ParseResult.decode<any, any, never>(ResultSchema as any)
  const encodeResult = ParseResult.encode<any, any, never>(ResultSchema as any)
  return Schema.transformOrFail(
    Encoded,
    Decoded,
    {
      strict: true,
      decode: Effect.fnUntraced(function*(encoded) {
        const decoded = yield* decodeResult(encoded.result)
        const providerExecuted = encoded.providerExecuted ?? false
        return {
          ...encoded,
          [PartTypeId]: PartTypeId,
          name: encoded.name as Name,
          result: decoded,
          encodedResult: encoded.result as any,
          metadata: encoded.metadata ?? {},
          providerExecuted
        } as const
      }),
      encode: Effect.fnUntraced(function*(decoded) {
        const encoded = yield* encodeResult(decoded.result)
        return {