--- title: "GET /documentClassifiers/{classifierId}/analyzeResults/{resultId}" method: GET path: "/documentClassifiers/{classifierId}/analyzeResults/{resultId}" --- # GET /documentClassifiers/{classifierId}/analyzeResults/{resultId} `GET /documentClassifiers/{classifierId}/analyzeResults/{resultId}` Gets the result of document classifier. ## Path parameters - `classifierId` string, required - `resultId` string, uuid, required ## Query parameters - `api-version` string, required ## Response `200` The request has succeeded. - AnalyzeOperation — Status and result of the analyze operation. - `status` 'notStarted' | 'running' | 'failed' | 'succeeded' | 'canceled' | 'skipped', required — Operation status. - `createdDateTime` string, date-time, required — Date and time (UTC) when the analyze operation was submitted. - `lastUpdatedDateTime` string, date-time, required — Date and time (UTC) when the status was last updated. - `error` DocumentIntelligenceError — The error object. - `code` string, required — One of a server-defined set of error codes. - `message` string, required — A human-readable representation of the error. - `target` string — The target of the error. - `details` DocumentIntelligenceError[] — An array of details about specific errors that led to this reported error. - `innererror` DocumentIntelligenceInnerError — An object containing more specific information about the error. - `code` string — One of a server-defined set of error codes. - `message` string — A human-readable representation of the error. - `innererror` DocumentIntelligenceInnerError — recursive - `analyzeResult` AnalyzeResult — Document analysis result. - `apiVersion` string, required — API version used to produce this result. - `modelId` string, required — Document model ID used to produce this result. - `stringIndexType` 'textElements' | 'unicodeCodePoint' | 'utf16CodeUnit', required — Method used to compute string offset and length. - `contentFormat` 'text' | 'markdown' — Format of the content in analyzed result. - `content` string, required — Concatenate string representation of all textual and visual elements in reading order. - `pages` DocumentPage[], required — Analyzed pages. - `pageNumber` integer, required — 1-based page number in the input document. - `angle` number, float — The general orientation of the content in clockwise direction, measured in degrees between (-180, 180]. - `width` number, float — The width of the image/PDF in pixels/inches, respectively. - `height` number, float — The height of the image/PDF in pixels/inches, respectively. - `unit` 'pixel' | 'inch' — The unit used by the width, height, and polygon properties. For images, the unit is "pixel". For PDF, the unit is "inch". - `spans` DocumentSpan[], required — Location of the page in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `words` DocumentWord[] — Extracted words from the page. - `content` string, required — Text content of the word. - `polygon` number[] — Bounding polygon of the word, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `span` DocumentSpan, required — Contiguous region of the concatenated content property, specified as an offset and length. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `confidence` number, float, required — Confidence of correctly extracting the word. - `selectionMarks` DocumentSelectionMark[] — Extracted selection marks from the page. - `state` 'selected' | 'unselected', required — State of the selection mark. - `polygon` number[] — Bounding polygon of the selection mark, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `span` DocumentSpan, required — Contiguous region of the concatenated content property, specified as an offset and length. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `confidence` number, float, required — Confidence of correctly extracting the selection mark. - `lines` DocumentLine[] — Extracted lines from the page, potentially containing both textual and visual elements. - `content` string, required — Concatenated content of the contained elements in reading order. - `polygon` number[] — Bounding polygon of the line, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the line in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `barcodes` DocumentBarcode[] — Extracted barcodes from the page. - `kind` 'QRCode' | 'PDF417' | 'UPCA' | 'UPCE' | 'Code39' | 'Code128' | 'EAN8' | 'EAN13' | 'DataBar' | 'Code93' | 'Codabar' | 'DataBarExpanded' | 'ITF' | 'MicroQRCode' | 'Aztec' | 'DataMatrix' | 'MaxiCode', required — Barcode kind. - `value` string, required — Barcode value. - `polygon` number[] — Bounding polygon of the barcode, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `span` DocumentSpan, required — Contiguous region of the concatenated content property, specified as an offset and length. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `confidence` number, float, required — Confidence of correctly extracting the barcode. - `formulas` DocumentFormula[] — Extracted formulas from the page. - `kind` 'inline' | 'display', required — Formula kind. - `value` string, required — LaTex expression describing the formula. - `polygon` number[] — Bounding polygon of the formula, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `span` DocumentSpan, required — Contiguous region of the concatenated content property, specified as an offset and length. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `confidence` number, float, required — Confidence of correctly extracting the formula. - `paragraphs` DocumentParagraph[] — Extracted paragraphs. - `role` 'pageHeader' | 'pageFooter' | 'pageNumber' | 'title' | 'sectionHeading' | 'footnote' | 'formulaBlock' — Semantic role of the paragraph. - `content` string, required — Concatenated content of the paragraph in reading order. - `boundingRegions` BoundingRegion[] — Bounding regions covering the paragraph. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the paragraph in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `tables` DocumentTable[] — Extracted tables. - `rowCount` integer, required — Number of rows in the table. - `columnCount` integer, required — Number of columns in the table. - `cells` DocumentTableCell[], required — Cells contained within the table. - `kind` 'content' | 'rowHeader' | 'columnHeader' | 'stubHead' | 'description' — Table cell kind. - `rowIndex` integer, required — Row index of the cell. - `columnIndex` integer, required — Column index of the cell. - `rowSpan` integer — Number of rows spanned by this cell. - `columnSpan` integer — Number of columns spanned by this cell. - `content` string, required — Concatenated content of the table cell in reading order. - `boundingRegions` BoundingRegion[] — Bounding regions covering the table cell. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the table cell in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `elements` DocumentElement[] — Child elements of the table cell. - `boundingRegions` BoundingRegion[] — Bounding regions covering the table. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the table in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `caption` DocumentCaption — A caption object describing a table or figure. - `content` string, required — Content of the caption. - `boundingRegions` BoundingRegion[] — Bounding regions covering the caption. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the caption in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `elements` DocumentElement[] — Child elements of the caption. - `footnotes` DocumentFootnote[] — List of footnotes associated with the table. - `content` string, required — Content of the footnote. - `boundingRegions` BoundingRegion[] — Bounding regions covering the footnote. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the footnote in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `elements` DocumentElement[] — Child elements of the footnote. - `figures` DocumentFigure[] — Extracted figures. - `boundingRegions` BoundingRegion[] — Bounding regions covering the figure. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the figure in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `elements` DocumentElement[] — Child elements of the figure, excluding any caption or footnotes. - `caption` DocumentCaption — A caption object describing a table or figure. - `content` string, required — Content of the caption. - `boundingRegions` BoundingRegion[] — Bounding regions covering the caption. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the caption in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `elements` DocumentElement[] — Child elements of the caption. - `footnotes` DocumentFootnote[] — List of footnotes associated with the figure. - `content` string, required — Content of the footnote. - `boundingRegions` BoundingRegion[] — Bounding regions covering the footnote. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the footnote in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `elements` DocumentElement[] — Child elements of the footnote. - `id` string — Figure ID. - `sections` DocumentSection[] — Extracted sections. - `spans` DocumentSpan[], required — Location of the section in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `elements` DocumentElement[] — Child elements of the section. - `keyValuePairs` DocumentKeyValuePair[] — Extracted key-value pairs. - `key` DocumentKeyValueElement, required — An object representing the field key or value in a key-value pair. - `content` string, required — Concatenated content of the key-value element in reading order. - `boundingRegions` BoundingRegion[] — Bounding regions covering the key-value element. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the key-value element in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `value` DocumentKeyValueElement — An object representing the field key or value in a key-value pair. - `content` string, required — Concatenated content of the key-value element in reading order. - `boundingRegions` BoundingRegion[] — Bounding regions covering the key-value element. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the key-value element in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `confidence` number, float, required — Confidence of correctly extracting the key-value pair. - `styles` DocumentStyle[] — Extracted font styles. - `isHandwritten` boolean — Is content handwritten? - `similarFontFamily` string — Visually most similar font from among the set of supported font families, with fallback fonts following CSS convention (ex. 'Arial, sans-serif'). - `fontStyle` 'normal' | 'italic' — Font style. - `fontWeight` 'normal' | 'bold' — Font weight. - `color` string — Foreground color in #rrggbb hexadecimal format. - `backgroundColor` string — Background color in #rrggbb hexadecimal format.. - `spans` DocumentSpan[], required — Location of the text elements in the concatenated content the style applies to. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `confidence` number, float, required — Confidence of correctly identifying the style. - `languages` DocumentLanguage[] — Detected languages. - `locale` string, required — Detected language. Value may an ISO 639-1 language code (ex. "en", "fr") or BCP 47 language tag (ex. "zh-Hans"). - `spans` DocumentSpan[], required — Location of the text elements in the concatenated content the language applies to. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `confidence` number, float, required — Confidence of correctly identifying the language. - `documents` AnalyzedDocument[] — Extracted documents. - `docType` string, required — Document type. - `boundingRegions` BoundingRegion[] — Bounding regions covering the document. - `pageNumber` integer, required — 1-based page number of page containing the bounding region. - `polygon` number[], required — Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. - `spans` DocumentSpan[], required — Location of the document in the reading order concatenated content. - `offset` integer, required — Zero-based index of the content represented by the span. - `length` integer, required — Number of characters in the content represented by the span. - `fields` object — Dictionary of named field values. - `confidence` number, float, required — Confidence of correctly extracting the document. - `warnings` DocumentIntelligenceWarning[] — List of warnings encountered. - `code` string, required — One of a server-defined set of warning codes. - `message` string, required — A human-readable representation of the warning. - `target` string — The target of the error. ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/azure/apis/ai-documentintelligence.md) · [All operations](https://skmtc.net/azure/apis/ai-documentintelligence/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/ai-documentintelligence/versions/3f750834da9e/schema)