CaptureStructuredOutputsTool Class

Definition

Namespace:

Azure.AI.Extensions.OpenAI

Assembly:

Azure.AI.Extensions.OpenAI.dll

Package:

Azure.AI.Extensions.OpenAI v3.0.0-beta.3

Source:

CaptureStructuredOutputsTool.cs

A tool for capturing structured outputs.

public class CaptureStructuredOutputsTool : OpenAI.Responses.ResponseTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Extensions.OpenAI.CaptureStructuredOutputsTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Extensions.OpenAI.CaptureStructuredOutputsTool>

type CaptureStructuredOutputsTool = class
    inherit ResponseTool
    interface IJsonModel<CaptureStructuredOutputsTool>
    interface IPersistableModel<CaptureStructuredOutputsTool>

Public Class CaptureStructuredOutputsTool
Inherits ResponseTool
Implements IJsonModel(Of CaptureStructuredOutputsTool), IPersistableModel(Of CaptureStructuredOutputsTool)

Inheritance

OpenAI.Responses.ResponseTool

CaptureStructuredOutputsTool

Implements

IJsonModel<CaptureStructuredOutputsTool> IPersistableModel<CaptureStructuredOutputsTool> IPersistableModel<T>

Constructors

Name	Description
CaptureStructuredOutputsTool(StructuredOutputDefinition)	Initializes a new instance of CaptureStructuredOutputsTool.

Properties

Name	Description
Description	Deprecated. This property is deprecated and will be removed in a future version.
Name	Deprecated. This property is deprecated and will be removed in a future version.
OutputDefinition	The structured outputs to capture from the model.
ToolConfigs	Deprecated. This property is deprecated and will be removed in a future version.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<CaptureStructuredOutputsTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<CaptureStructuredOutputsTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<CaptureStructuredOutputsTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<CaptureStructuredOutputsTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<CaptureStructuredOutputsTool>.Write(ModelReaderWriterOptions)