IntelligenceX

API Reference

Class

TreatmentResult

Edit on GitHub
Namespace IntelligenceX.Treatment
Assembly IntelligenceX
Source Treatment/TreatmentResult.cs:14
Modifiers sealed

Result returned by a treatment provider.

Inheritance

  • Object
  • TreatmentResult

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Constructors

public TreatmentResult(String id, String status, String text, JsonValue json, IReadOnlyList<TreatmentAsset> assets, Object raw, IReadOnlyDictionary<String, String> metadata = null) #
Treatment/TreatmentResult.cs:14

Initializes a new treatment result.

Parameters

id System.String requiredposition: 0
status System.String requiredposition: 1
text System.String requiredposition: 2
json IntelligenceX.Json.JsonValue requiredposition: 3
assets System.Collections.Generic.IReadOnlyList{IntelligenceX.Treatment.TreatmentAsset} requiredposition: 4
raw System.Object requiredposition: 5
metadata System.Collections.Generic.IReadOnlyDictionary{System.String,System.String} = null optionalposition: 6

Properties

public String Id { get; } #
Treatment/TreatmentResult.cs:28

Treatment result id.

public String Status { get; } #
Treatment/TreatmentResult.cs:32

Provider status.

public String Text { get; } #
Treatment/TreatmentResult.cs:36

Aggregated text output.

public JsonValue Json { get; } #
Treatment/TreatmentResult.cs:40

Parsed JSON output when available.

public JsonObject JsonObject { get; } #
Treatment/TreatmentResult.cs:44

Parsed JSON object output when the provider returned an object.

public IReadOnlyList<TreatmentAsset> Assets { get; } #
Treatment/TreatmentResult.cs:48

Assets generated or selected during treatment.

public Object Raw { get; } #
Treatment/TreatmentResult.cs:52

Raw provider result.

public IReadOnlyDictionary<String, String> Metadata { get; } #
Treatment/TreatmentResult.cs:56

Metadata attached by the caller or provider.