ChatCompletionsResponseFormatJsonSchemaDefinition interface

Paket:

@azure-rest/ai-inference

Definierar svarsformatet för chattavslut som JSON med ett visst schema. AI-modellen måste följa det här schemat när du genererar slutföranden.

Egenskaper

description	En beskrivning av svarsformatet som används av AI-modellen för att avgöra hur svar ska genereras i det här formatet.
name	Ett namn som etiketterar det här JSON-schemat. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och bindestreck, med en maximal längd på 64.
schema	Definitionen av JSON-schemat. Se https://json-schema.org/overview/what-is-jsonschema. Observera att AI-modeller vanligtvis bara stöder en delmängd av nyckelorden som definieras av JSON-schemat. Läs dokumentationen om DIN AI-modell för att avgöra vad som stöds.
strict	Om värdet är true får tjänsten ett felmeddelande om det angivna JSON-schemat innehåller nyckelord som inte stöds av AI-modellen. Ett exempel på ett sådant nyckelord kan vara maxLength för JSON-typ string. Om det är falskt och det angivna JSON-schemat innehåller nyckelord som inte stöds av AI-modellen kommer AI-modellen inte att felsökas. I stället ignoreras nyckelord som inte stöds.

Egenskapsinformation

description

En beskrivning av svarsformatet som används av AI-modellen för att avgöra hur svar ska genereras i det här formatet.

description?: string

Egenskapsvärde

string

name

Ett namn som etiketterar det här JSON-schemat. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och bindestreck, med en maximal längd på 64.

name: string

Egenskapsvärde

string

schema

Definitionen av JSON-schemat. Se https://json-schema.org/overview/what-is-jsonschema. Observera att AI-modeller vanligtvis bara stöder en delmängd av nyckelorden som definieras av JSON-schemat. Läs dokumentationen om DIN AI-modell för att avgöra vad som stöds.

schema: Record<string, unknown>

Egenskapsvärde

Record<string, unknown>

strict

Om värdet är true får tjänsten ett felmeddelande om det angivna JSON-schemat innehåller nyckelord som inte stöds av AI-modellen. Ett exempel på ett sådant nyckelord kan vara maxLength för JSON-typ string. Om det är falskt och det angivna JSON-schemat innehåller nyckelord som inte stöds av AI-modellen kommer AI-modellen inte att felsökas. I stället ignoreras nyckelord som inte stöds.

strict?: boolean

Egenskapsvärde

boolean