ChatOptions.ResponseFormat Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the response format for the chat request.
public:
property Microsoft::Extensions::AI::ChatResponseFormat ^ ResponseFormat { Microsoft::Extensions::AI::ChatResponseFormat ^ get(); void set(Microsoft::Extensions::AI::ChatResponseFormat ^ value); };public Microsoft.Extensions.AI.ChatResponseFormat? ResponseFormat { get; set; }member this.ResponseFormat : Microsoft.Extensions.AI.ChatResponseFormat with get, setPublic Property ResponseFormat As ChatResponseFormatProperty Value
Remarks
If null, no response format is specified and the client will use its default. This may be set to Text to specify that the response should be unstructured text, to Json to specify that the response should be structured JSON data, or an instance of ChatResponseFormatJson constructed with a specific JSON schema to request that the response be structured JSON data according to that schema. It is up to the client implementation if or how to honor the request. If the client implementation doesn't recognize the specific kind of ChatResponseFormat, it may be ignored.
