Function ToolResultPart

packages/effect/src/unstable/ai/Response.ts:1645–1696

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

    }
  >
> = <
  const Name extends string,
  Success extends Schema.Constraint,
  Failure extends Schema.Constraint
>(
  name: Name,
  success: Success,
  failure: Failure
) => {
  const ResultSchema = Schema.Union([success, failure])
  const Common = {
    id: Schema.String,
    type: Schema.Literal("tool-result"),
    isFailure: Schema.Boolean,
    name: Schema.Literal(name)
  }
  const Decoded = Schema.Struct({
    ...Common,
    [PartTypeId]: Schema.Literal(PartTypeId),
    result: ResultSchema,
    providerExecuted: Schema.Boolean,
    metadata: ProviderMetadata,
    encodedResult: Schema.toEncoded(ResultSchema),
    preliminary: Schema.Boolean
  })
  const Encoded = Schema.Struct({
    ...Common,
    result: Schema.toEncoded(ResultSchema),
    providerExecuted: Schema.optional(Schema.Boolean),
    metadata: Schema.optional(ProviderMetadata),
    preliminary: Schema.optional(Schema.Boolean)
  })
  return Decoded.pipe(Schema.encodeTo(
    Encoded,
    SchemaTransformation.transform({
      decode: (encoded) => ({
        ...encoded,
        [PartTypeId]: PartTypeId,
        providerExecuted: encoded.providerExecuted ?? false,
        metadata: encoded.metadata ?? {},
        encodedResult: encoded.result,
        preliminary: encoded.preliminary ?? false
      }),
      encode: identity
    })
  )).annotate({ identifier: `ToolResultPart(${name})` }) satisfies Schema.Codec<
    ToolResultPart<Name, Success["Type"], Failure["Type"]>,
    ToolResultPartEncoded,
    Success["EncodingServices"] | Failure["EncodingServices"],
    Success["DecodingServices"] | Failure["DecodingServices"]
  >
}

/**
 * Constructs a new tool result part.