IntelligenceX

API Reference

Class

TurnInfo

Namespace IntelligenceX.OpenAI.AppServer.Models
Assembly IntelligenceX
Modifiers sealed

Represents a single chat turn and its outputs.

Inheritance

  • Object
  • TurnInfo

Constructors

TurnInfo 2 overloads
public TurnInfo(String id, String responseId, String status, IReadOnlyList<TurnOutput> outputs, IReadOnlyList<TurnOutput> imageOutputs, JsonObject raw, JsonObject additional, TurnUsage usage = null) #

Initializes a new turn info model.

Parameters

id System.String requiredposition: 0
responseId System.String requiredposition: 1
status System.String requiredposition: 2
outputs System.Collections.Generic.IReadOnlyList{IntelligenceX.OpenAI.AppServer.Models.TurnOutput} requiredposition: 3
imageOutputs System.Collections.Generic.IReadOnlyList{IntelligenceX.OpenAI.AppServer.Models.TurnOutput} requiredposition: 4
raw IntelligenceX.Json.JsonObject requiredposition: 5
additional IntelligenceX.Json.JsonObject requiredposition: 6
usage IntelligenceX.OpenAI.AppServer.Models.TurnUsage = null optionalposition: 7
public TurnInfo(String id, String status, IReadOnlyList<TurnOutput> outputs, IReadOnlyList<TurnOutput> imageOutputs, JsonObject raw, JsonObject additional, TurnUsage usage = null) #

Initializes a new turn info model.

Parameters

id System.String requiredposition: 0
status System.String requiredposition: 1
outputs System.Collections.Generic.IReadOnlyList{IntelligenceX.OpenAI.AppServer.Models.TurnOutput} requiredposition: 2
imageOutputs System.Collections.Generic.IReadOnlyList{IntelligenceX.OpenAI.AppServer.Models.TurnOutput} requiredposition: 3
raw IntelligenceX.Json.JsonObject requiredposition: 4
additional IntelligenceX.Json.JsonObject requiredposition: 5
usage IntelligenceX.OpenAI.AppServer.Models.TurnUsage = null optionalposition: 6

Methods

public static TurnInfo FromJson(JsonObject turnObj) #
Returns: TurnInfo

Parses a turn info model from JSON.

Parameters

turnObj IntelligenceX.Json.JsonObject requiredposition: 0
Source JSON object.

Returns

The parsed turn info.

Properties

public String Id { get; } #

Gets the turn id.

public String ResponseId { get; } #

Gets the response id when available.

public String Status { get; } #

Gets the turn status.

public IReadOnlyList<TurnOutput> Outputs { get; } #

Gets all outputs.

public IReadOnlyList<TurnOutput> ImageOutputs { get; } #

Gets image outputs.

public JsonObject Raw { get; } #

Gets the raw JSON object.

public JsonObject Additional { get; } #

Gets unrecognized fields from the payload.

public TurnUsage Usage { get; } #

Gets token usage details when available.