Share via


ReasoningItemParam Class

Definition

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

public class ReasoningItemParam : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ItemParam, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ReasoningItemParam>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ReasoningItemParam>
type ReasoningItemParam = class
    inherit ItemParam
    interface IUtf8JsonSerializable
    interface IJsonModel<ReasoningItemParam>
    interface IPersistableModel<ReasoningItemParam>
Public Class ReasoningItemParam
Inherits ItemParam
Implements IJsonModel(Of ReasoningItemParam), IPersistableModel(Of ReasoningItemParam)
Inheritance
ReasoningItemParam
Implements

Constructors

Name Description
ReasoningItemParam()

Initializes a new instance of ReasoningItemParam for deserialization.

ReasoningItemParam(IEnumerable<ReasoningItemSummaryPart>)

Initializes a new instance of ReasoningItemParam.

ReasoningItemParam(ItemType, IDictionary<String,BinaryData>, String, IList<ReasoningItemSummaryPart>)

Initializes a new instance of ReasoningItemParam.

Properties

Name Description
EncryptedContent

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

SerializedAdditionalRawData (Inherited from ItemParam)
Summary

Reasoning text contents. Please note ReasoningItemSummaryPart is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ReasoningItemSummaryTextPart.

Type

Gets or sets the type.

(Inherited from ItemParam)

Methods

Name Description
DeserializeReasoningItemParam(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<ItemParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ItemParam)
IJsonModel<ItemParam>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ItemParam)
IJsonModel<ReasoningItemParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ReasoningItemParam>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ItemParam)
IPersistableModel<ItemParam>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ItemParam)
IPersistableModel<ItemParam>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ItemParam)
IPersistableModel<ReasoningItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ReasoningItemParam>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ReasoningItemParam>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to