SAP AI SDK for JavaScript - v2.8.0
    Preparing search index...

    Type Alias ResponseFormatJsonSchema

    Representation of the 'ResponseFormatJsonSchema' schema.

    type ResponseFormatJsonSchema = {
        json_schema: {
            description?: string;
            name: string;
            schema?: ResponseFormatJsonSchemaSchema;
            strict?: boolean | null;
        };
        type: "json_schema";
    }
    Index

    Properties

    json_schema type

    Properties

    json_schema: {
        description?: string;
        name: string;
        schema?: ResponseFormatJsonSchemaSchema;
        strict?: boolean | null;
    }

    Type Declaration

    • Optionaldescription?: string

      A description of what the response format is for, used by the model to determine how to respond in the format.

    • name: string

      The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. Max Length: 64. Pattern: "^[a-zA-Z0-9-_]+$".

    • Optionalschema?: ResponseFormatJsonSchemaSchema
    • Optionalstrict?: boolean | null

      Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the Structured Outputs guide.

    type: "json_schema"

    The type of response format being defined: json_schema

    Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.

    Settings

    Member Visibility

    On This Page

    Properties