@samchon/openapi/lib/structures/IClaudeSchema.d.mts

OpenAPI definitions and converters for 'typia' and 'nestia'.

import { ILlmSchemaV3_1 } from "./ILlmSchemaV3_1";
/**
 * Type schema info of the Claude.
 *
 * `IClaudeSchema` is a type schema info of the Claude function calling.
 *
 * `IClaudeSchema` seems fully supporting the JSON schema definition of the
 * OpenAPI v3.1 specification; {@link OpenApiV3_1.IJsonSchema}. By the way, as
 * the {@link OpenApiV3_1.IJsonSchema} has too much ambiguous and duplicated
 * expressions, `IClaudeSchema` is designed to be clear and simple for the
 * Claude function calling, by utilizng {@link ILlmSchemaV3_1} which has been
 * transformed from the {@link OpenApi.IJsonSchema} for the convenience and
 * clarity.
 *
 * Therefore, `IClaudeSchema` does not follow the entire specification of the
 * OpenAPI v3.1. It has own specific restrictions and definitions. Here is the
 * list of how `ILlmSchemaV3_1` is different with the OpenAPI v3.1 JSON schema.
 *
 * - Decompose mixed type: {@link OpenApiV3_1.IJsonSchema.IMixed}
 * - Resolve nullable property:
 *   {@link OpenApiV3_1.IJsonSchema.__ISignificant.nullable}
 * - Tuple type is banned: {@link OpenApiV3_1.IJsonSchema.ITuple.prefixItems}
 * - Constant type is banned: {@link OpenApiV3_1.IJsonSchema.IConstant}
 * - Merge {@link OpenApiV3_1.IJsonSchema.IAnyOf} to {@link IClaudeSchema.IOneOf}
 * - Merge {@link OpenApiV3_1.IJsonSchema.IAllOf} to {@link IClaudeSchema.IObject}
 * - Merge {@link OpenApiV3_1.IJsonSchema.IRecursiveReference} to
 *   {@link IClaudeSchema.IReference}
 * - Do not support {@link OpenApiV3_1.IJsonSchema.ITuple} type
 *
 * If compare with the {@link OpenApi.IJsonSchema}, the emended JSON schema
 * specification,
 *
 * - {@link IClaudeSchema.IParameters.$defs} instead of the
 *   {@link OpenApi.IJsonSchema.schemas}
 * - Do not support {@link OpenApi.IJsonSchema.ITuple} type
 * - {@link IClaudeSchema.properties} and {@link IClaudeSchema.required} are always
 *   defined
 *
 * For reference, if you've composed the `IClaudeSchema` type with the
 * {@link IClaudeSchema.IConfig.reference} `false` option (default is `false`),
 * only the recursive named types would be archived into the
 * {@link IClaudeSchema.IParameters.$defs}, and the others would be escaped from
 * the {@link IClaudeSchema.IReference} type.
 *
 * @author Jeongho Nam - https://github.com/samchon
 * @reference https://docs.anthropic.com/en/docs/build-with-claude/tool-use
 * @reference https://docs.anthropic.com/en/docs/test-and-evaluate/strengthen-guardrails/increase-consistency
 */
export type IClaudeSchema = IClaudeSchema.IConstant | IClaudeSchema.IBoolean | IClaudeSchema.IInteger | IClaudeSchema.INumber | IClaudeSchema.IString | IClaudeSchema.IArray | IClaudeSchema.IObject | IClaudeSchema.IReference | IClaudeSchema.IOneOf | IClaudeSchema.INull | IClaudeSchema.IUnknown;
export declare namespace IClaudeSchema {
    /** Configuration for Claude schema composition. */
    interface IConfig {
        /**
         * Whether to allow reference type in everywhere.
         *
         * If you configure this property to `false`, most of reference types
         * represented by {@link IClaudeSchema.IReference} would be escaped to a
         * plain type unless recursive type case.
         *
         * This is because some low sized LLM models does not understand the
         * reference type well, and even the large size LLM models sometimes occur
         * the hallucination.
         *
         * However, the reference type makes the schema size smaller, so that
         * reduces the LLM token cost. Therefore, if you're using the large size of
         * LLM model, and want to reduce the LLM token cost, you can configure this
         * property to `true`.
         *
         * @default true
         */
        reference: boolean;
    }
    /**
     * Type of the function parameters.
     *
     * `IClaudeSchema.IParameters` is a type defining a function's parameters as a
     * keyworded object type.
     *
     * It also can be utilized for the structured output metadata.
     *
     * @reference https://platform.openai.com/docs/guides/structured-outputs
     */
    type IParameters = ILlmSchemaV3_1.IParameters;
    /** Constant value type. */
    type IConstant = ILlmSchemaV3_1.IConstant;
    /** Boolean type info. */
    type IBoolean = ILlmSchemaV3_1.IBoolean;
    /** Integer type info. */
    type IInteger = ILlmSchemaV3_1.IInteger;
    /** Number (double) type info. */
    type INumber = ILlmSchemaV3_1.INumber;
    /** String type info. */
    type IString = ILlmSchemaV3_1.IString;
    /** Array type info. */
    type IArray = ILlmSchemaV3_1.IArray;
    /** Object type info. */
    type IObject = ILlmSchemaV3_1.IObject;
    /** Reference type directing named schema. */
    type IReference = ILlmSchemaV3_1.IReference;
    /**
     * Union type.
     *
     * `IOneOf` represents an union type of the TypeScript (`A | B | C`).
     *
     * For reference, even though your Swagger (or OpenAPI) document has defined
     * `anyOf` instead of the `oneOf`, {@link OpenApi} forcibly converts it to
     * `oneOf` type.
     */
    type IOneOf = ILlmSchemaV3_1.IOneOf;
    namespace IOneOf {
        /** Discriminator info of the union type. */
        type IDiscriminator = ILlmSchemaV3_1.IOneOf.IDiscriminator;
    }
    /** Null type. */
    type INull = ILlmSchemaV3_1.INull;
    /** Unknown, the `any` type. */
    type IUnknown = ILlmSchemaV3_1.IUnknown;
}