@azure/ai-content-understanding package

Classes

ContentUnderstandingClient

Interfaces

AnalysisContent	Media content base class.
AnalysisInput	Additional input to analyze.
AnalysisResult	Analyze operation result.
AnalysisResultPoller
AnalyzeBinaryOptionalParams	Optional parameters for the analyzeBinary operation.
AnalyzeOptionalParams	Optional parameters for the analyze operation.
ArrayField	Array field extracted from the content.
AudioVisualContent	Audio visual content. Ex. audio/wav, video/mp4.
AudioVisualContentSegment	Detected audio/visual content segment.
BooleanField	Boolean field extracted from the content.
ContentAnalyzer	Analyzer that extracts content and fields from multimodal documents.
ContentAnalyzerAnalyzeOperationStatus	Provides status details for analyze operations.
ContentAnalyzerConfig	Configuration settings for an analyzer.
ContentAnalyzerOperationStatus	Provides status details for analyzer creation operations.
ContentCategoryDefinition	Content category definition.
ContentField	Field extracted from the content.
ContentFieldDefinition	Definition of the field using a JSON Schema like syntax.
ContentFieldSchema	Schema of fields to be extracted from documents.
ContentSpan	Position of the element in markdown, specified as a character offset and length.
ContentUnderstandingClientOptionalParams	Optional parameters for the client.
ContentUnderstandingDefaults	Default settings for this Content Understanding resource.
CopyAnalyzerOptionalParams	Optional parameters.
CopyAuthorization	Copy authorization details for cross-resource copy.
CreateAnalyzerOptionalParams	Optional parameters.
DateField	Date field extracted from the content.
DeleteAnalyzerOptionalParams	Optional parameters.
DeleteResultOptionalParams	Optional parameters.
DocumentAnnotation	Annotation in a document, such as a strikethrough or a comment.
DocumentAnnotationComment	Comment associated with a document annotation.
DocumentBarcode	Barcode in a document.
DocumentCaption	Caption of a table or figure.
DocumentChartFigure	Figure containing a chart, such as a bar chart, line chart, or pie chart.
DocumentContent	Document content. Ex. text/plain, application/pdf, image/jpeg.
DocumentContentSegment	Detected document content segment.
DocumentFigure	Figure in a document.
DocumentFootnote	Footnote of a table or figure.
DocumentFormula	Mathematical formula in a document.
DocumentHyperlink	Hyperlink in a document, such as a link to a web page or an email address.
DocumentLine	Line in a document, consisting of an contiguous sequence of words.
DocumentMermaidFigure	Figure containing a diagram, such as a flowchart or network diagram.
DocumentPage	Content from a document page.
DocumentParagraph	Paragraph in a document, generally consisting of an contiguous sequence of lines with common alignment and spacing.
DocumentSection	Section in a document.
DocumentTable	Table in a document, consisting table cells arranged in a rectangular layout.
DocumentTableCell	Table cell in a document table.
DocumentWord	Word in a document, consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word.
GetAnalyzerOptionalParams	Optional parameters.
GetDefaultsOptionalParams	Optional parameters.
GetOperationStatusOptionalParams	Optional parameters.
GetResultFileOptionalParams	Optional parameters.
GetResultOptionalParams	Optional parameters.
GrantCopyAuthorizationOptionalParams	Optional parameters.
IntegerField	Integer field extracted from the content.
JsonField	JSON field extracted from the content.
KnowledgeSource	Knowledge source.
LabeledDataKnowledgeSource	Labeled data knowledge source.
ListAnalyzersOptionalParams	Optional parameters.
NumberField	Number field extracted from the content.
ObjectField	Object field extracted from the content.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
RecordMergePatchUpdate	model interface RecordMergePatchUpdate
StringField	String field extracted from the content.
SupportedModels	Chat completion and embedding models supported by the analyzer.
TimeField	Time field extracted from the content.
TranscriptPhrase	Transcript phrase.
TranscriptWord	Transcript word.
UpdateAnalyzerOptionalParams	Optional parameters.
UpdateDefaultsOptionalParams	Optional parameters.
UsageDetails	Usage details.

Type Aliases

AnalysisContentKind	Kind of media content.
AnalysisContentUnion	Alias for AnalysisContentUnion
AnnotationFormat	Representation format of annotations in analyze result markdown.
ChartFormat	Representation format of charts in analyze result markdown.
ContentAnalyzerStatus	Status of a resource.
ContentFieldType	Semantic data type of the field value.
ContentFieldUnion	Alias for ContentFieldUnion
ContinuablePage	An interface that describes a page of results.
DocumentAnnotationKind	Document annotation kind.
DocumentBarcodeKind	Barcode kind.
DocumentFigureKind	Figure kind.
DocumentFigureUnion	Alias for DocumentFigureUnion
DocumentFormulaKind	Formula kind.
DocumentTableCellKind	Table cell kind.
GenerationMethod	Generation method.
KnowledgeSourceKind	Knowledge source kind.
KnowledgeSourceUnion	Alias for KnowledgeSourceUnion
LengthUnit	Length unit used by the width, height, and source properties.
OperationState	Enum describing allowed operation states.
ProcessingLocation	The location where the data may be processed.
SemanticRole	Semantic role of the paragraph.
TableFormat	Representation format of tables in analyze result markdown.

Enums

KnownVersions

Service API versions.