Skip to main content

Type Alias: GatewayInferenceResponseFormatJsonSchema

type GatewayInferenceResponseFormatJsonSchema = {
[key: string]: unknown;
  type: "json_schema";
  json_schema: {
   [key: string]: unknown;
     description?: string;
     name: string;
     schema?: GatewayInferenceResponseFormatJsonSchemaSchema;
     strict?: boolean | null;
  };
};

Defined in: src/models/ai-gateway-inference.ts:1806

Portkey ResponseFormatJsonSchema; additive response fields are preserved.

Example​

`GatewayInferenceResponseFormatJsonSchemaSchema.parse(value);`

Indexable​

[key: string]: unknown

Properties​

type​

type: "json_schema";

Defined in: src/models/ai-gateway-inference.ts:1807

json_schema​

json_schema: {
[key: string]: unknown;
  description?: string;
  name: string;
  schema?: GatewayInferenceResponseFormatJsonSchemaSchema;
  strict?: boolean | null;
};

Defined in: src/models/ai-gateway-inference.ts:1808

Index Signature​

[key: string]: unknown

description?​

optional description?: string;

name​

name: string;

schema?​

optional schema?: GatewayInferenceResponseFormatJsonSchemaSchema;

strict?​

optional strict?: boolean | null;