AgentsApiResponseFormat Class

Reference

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.0.0-beta.1

Source:: AgentsApiResponseFormat.cs

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.

An object describing the expected output of the model. If json_object only function type tools are allowed to be passed to the Run. If text the model can return text or any value needed.

public class AgentsApiResponseFormat : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.AgentsApiResponseFormat>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.AgentsApiResponseFormat>

type AgentsApiResponseFormat = class
    interface IJsonModel<AgentsApiResponseFormat>
    interface IPersistableModel<AgentsApiResponseFormat>

Public Class AgentsApiResponseFormat
Implements IJsonModel(Of AgentsApiResponseFormat), IPersistableModel(Of AgentsApiResponseFormat)

Inheritance: Object
AgentsApiResponseFormat

Implements: IJsonModel<AgentsApiResponseFormat> IPersistableModel<AgentsApiResponseFormat> IPersistableModel<T>

Constructors

AgentsApiResponseFormat()

Initializes a new instance of AgentsApiResponseFormat.

Properties

Type	Must be one of `text` or `json_object`.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<AgentsApiResponseFormat>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AgentsApiResponseFormat>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AgentsApiResponseFormat>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AgentsApiResponseFormat>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AgentsApiResponseFormat>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via