AnalysisResult Class

Definition

Analyze operation result.

public class AnalysisResult : System.ClientModel.Primitives.IJsonModel<Azure.AI.ContentUnderstanding.AnalysisResult>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.ContentUnderstanding.AnalysisResult>
type AnalysisResult = class
    interface IJsonModel<AnalysisResult>
    interface IPersistableModel<AnalysisResult>
Public Class AnalysisResult
Implements IJsonModel(Of AnalysisResult), IPersistableModel(Of AnalysisResult)
Inheritance
AnalysisResult
Implements

Properties

Name Description
AnalyzerId

The unique identifier of the analyzer.

ApiVersion

The version of the API used to analyze the document.

Contents

The extracted content.

CreatedAt

The date and time when the result was created.

StringEncoding

The string encoding format for content spans in the response. Possible values are 'codePoint', 'utf16', and utf8. Default is codePoint.")

Warnings

Warnings encountered while analyzing the document.

Methods

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

Explicit Interface Implementations

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

Extension Methods

Name Description
ToLlmInput(AnalysisResult, IDictionary<String,Object>, LlmInputOptions)

Converts a Content Understanding analysis result into LLM-friendly text.

Produces a YAML front matter block followed by markdown body, suitable for injecting into an LLM prompt, storing in a vector database, or passing as tool output.

The YAML front matter (delimited by ---) may include: contentType (document, image, audio, video), pages (page range), timeRange (media time span), category (classification label), fields (extracted structured fields as YAML), rai_warnings (content safety flags), and any caller-supplied metadata entries.

The markdown body contains the extracted text with page-break markers (<!-- page N -->) inserted at page boundaries so downstream consumers can locate content by page number.

Applies to