Function ToolCallPart

packages/ai/ai/src/Response.ts:1475–1496

(
  /**
   * Name of the tool.
   */
  name: Name,
  /**
   * Schema for the tool parameters.
   */
  params: Params
)

 * @category Schemas
 */
export const ToolCallPart = <const Name extends string, Params extends Tool.AnyParametersSchema>(
  /**
   * Name of the tool.
   */
  name: Name,
  /**
   * Schema for the tool parameters.
   */
  params: Params
): Schema.Schema<ToolCallPart<Name, Schema.Schema.Type<Params>>, ToolCallPartEncoded> =>
  Schema.Struct({
    type: Schema.Literal("tool-call"),
    id: Schema.String,
    name: Schema.Literal(name),
    params,
    providerName: Schema.optional(Schema.String),
    providerExecuted: Schema.optionalWith(Schema.Boolean, { default: constFalse }),
    metadata: Schema.optionalWith(ProviderMetadata, { default: constEmptyObject })
  }).pipe(
    Schema.attachPropertySignature(PartTypeId, PartTypeId),
    Schema.annotations({ identifier: "ToolCallPart" })
  ) as any

/**
 * Constructs a new tool call part.