Skip to content

Latest commit

 

History

History
25 lines (14 loc) · 1.09 KB

updatepromptresponseformat.md

File metadata and controls

25 lines (14 loc) · 1.09 KB

UpdatePromptResponseFormat

An object specifying the format that the model must output.

Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema

Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

Supported Types

models.UpdatePromptResponseFormat1

value: models.UpdatePromptResponseFormat1 = /* values here */

models.UpdatePromptResponseFormat2

value: models.UpdatePromptResponseFormat2 = /* values here */