Share via


InsightSample Class

Definition

A sample from the analysis. Please note this is the abstract base class. The derived classes available for instantiation are: EvaluationResultSample.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.UnknownInsightSample))]
public abstract class InsightSample : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.InsightSample>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.InsightSample>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.UnknownInsightSample))>]
type InsightSample = class
    interface IJsonModel<InsightSample>
    interface IPersistableModel<InsightSample>
Public MustInherit Class InsightSample
Implements IJsonModel(Of InsightSample), IPersistableModel(Of InsightSample)
Inheritance
InsightSample
Derived
Attributes
Implements

Properties

Name Description
CorrelationInfo

Info about the correlation for the analysis sample.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

Features

Features to help with additional filtering of data in UX.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

Id

The unique identifier for the analysis sample.

Methods

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

Explicit Interface Implementations

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

Applies to