azure.ai.documentintelligence.models package

class azure.ai.documentintelligence.models.AddressValue(*args: Any, **kwargs: Any)[source]

Address field value.

Variables:
  • house_number (str) – House or building number.

  • po_box (str) – Post office box number.

  • road (str) – Street name.

  • city (str) – Name of city, town, village, etc.

  • state (str) – First-level administrative division.

  • postal_code (str) – Postal code used for mail sorting.

  • country_region (str) – Country/region.

  • street_address (str) – Street-level address, excluding city, state, countryRegion, and postalCode.

  • unit (str) – Apartment or office number.

  • city_district (str) – Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London.

  • state_district (str) – Second-level administrative division used in certain locales.

  • suburb (str) – Unofficial neighborhood name, like Chinatown.

  • house (str) – Build name, such as World Trade Center.

  • level (str) – Floor number, such as 3F.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
city: str | None

Name of city, town, village, etc.

city_district: str | None

Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London.

country_region: str | None

Country/region.

house: str | None

Build name, such as World Trade Center.

house_number: str | None

House or building number.

level: str | None

Floor number, such as 3F.

po_box: str | None

Post office box number.

postal_code: str | None

Postal code used for mail sorting.

road: str | None

Street name.

state: str | None

First-level administrative division.

state_district: str | None

Second-level administrative division used in certain locales.

street_address: str | None

Street-level address, excluding city, state, countryRegion, and postalCode.

suburb: str | None

Unofficial neighborhood name, like Chinatown.

unit: str | None

Apartment or office number.

class azure.ai.documentintelligence.models.AnalyzeBatchDocumentsRequest(*args: Any, **kwargs: Any)[source]

Batch document analysis parameters.

All required parameters must be populated in order to send to server.

Variables:
  • azure_blob_source (AzureBlobContentSource) – Azure Blob Storage location containing the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.

  • azure_blob_file_list_source (AzureBlobFileListContentSource) – Azure Blob Storage file list specifying the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.

  • result_container_url (str) – Azure Blob Storage container URL where analyze result files will be stored. Required.

  • result_prefix (str) – Blob name prefix of result files.

  • overwrite_existing (bool) – Overwrite existing analyze result files?.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
azure_blob_file_list_source: _models.AzureBlobFileListContentSource | None

Azure Blob Storage file list specifying the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.

azure_blob_source: _models.AzureBlobContentSource | None

Azure Blob Storage location containing the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.

overwrite_existing: bool | None

Overwrite existing analyze result files?.

result_container_url: str

Azure Blob Storage container URL where analyze result files will be stored. Required.

result_prefix: str | None

Blob name prefix of result files.

class azure.ai.documentintelligence.models.AnalyzeBatchOperationDetail(*args: Any, **kwargs: Any)[source]

Operation detail for a document in a batch analysis.

Variables:
  • status (str or OperationStatus) – Analyze status. succeeded, failed, or skipped. Required. Known values are: “notStarted”, “running”, “failed”, “succeeded”, “completed”, and “canceled”.

  • source_url (str) – URL of the source document. Required.

  • result_url (str) – URL of the analyze result JSON.

  • error (Error) – Encountered error.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
error: _models.Error | None

Encountered error.

result_url: str | None

URL of the analyze result JSON.

source_url: str

URL of the source document. Required.

status: str | _models.OperationStatus

“notStarted”, “running”, “failed”, “succeeded”, “completed”, and “canceled”.

Type:

Analyze status. succeeded, failed, or skipped. Required. Known values are

class azure.ai.documentintelligence.models.AnalyzeBatchResult(*args: Any, **kwargs: Any)[source]

Batch document analysis result.

Variables:
  • succeeded_count (int) – Number of documents that completed with status succeeded. Required.

  • failed_count (int) – Number of documents that completed with status failed. Required.

  • skipped_count (int) – Number of documents that completed with status skipped. Required.

  • details (list[AnalyzeBatchOperationDetail]) – Operation detail for each document in the batch. Required.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
details: List[_models.AnalyzeBatchOperationDetail]

Operation detail for each document in the batch. Required.

failed_count: int

Number of documents that completed with status failed. Required.

skipped_count: int

Number of documents that completed with status skipped. Required.

succeeded_count: int

Number of documents that completed with status succeeded. Required.

class azure.ai.documentintelligence.models.AnalyzeBatchResultOperation(*args: Any, **kwargs: Any)[source]

Status and result of the analyze batch operation.

Variables:
  • status (str or OperationStatus) – Operation status. notStarted, running, completed, or failed. Required. Known values are: “notStarted”, “running”, “failed”, “succeeded”, “completed”, and “canceled”.

  • created_date_time (datetime) – Date and time (UTC) when the operation was submitted. Required.

  • last_updated_date_time (datetime) – Date and time (UTC) when the status was last updated. Required.

  • percent_completed (int) – Operation progress (0-100).

  • error (Error) – Encountered error during batch document analysis.

  • result (AnalyzeBatchResult) – Batch document analysis result.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
created_date_time: datetime

Date and time (UTC) when the operation was submitted. Required.

error: _models.Error | None

Encountered error during batch document analysis.

last_updated_date_time: datetime

Date and time (UTC) when the status was last updated. Required.

percent_completed: int | None

Operation progress (0-100).

result: _models.AnalyzeBatchResult | None

Batch document analysis result.

status: str | _models.OperationStatus

Operation status. notStarted, running, completed, or failed. Required. Known values are: “notStarted”, “running”, “failed”, “succeeded”, “completed”, and “canceled”.

class azure.ai.documentintelligence.models.AnalyzeDocumentRequest(*args: Any, **kwargs: Any)[source]

Document analysis parameters.

Variables:
  • url_source (str) – Document URL to analyze. Either url_source or bytes_source must be specified.

  • bytes_source (bytes) – Document bytes to analyze. Either url_source or bytes_source must be specified.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
bytes_source: bytes | None

Document bytes to analyze. Either url_source or bytes_source must be specified.

url_source: str | None

Document URL to analyze. Either urlSource or base64Source must be specified.

class azure.ai.documentintelligence.models.AnalyzeOutputOption(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Additional output to generate during analysis.

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

FIGURES = 'figures'

Generate cropped images of detected figures.

PDF = 'pdf'

Generate searchable PDF output.

class azure.ai.documentintelligence.models.AnalyzeResult(*args: Any, **kwargs: Any)[source]

Document analysis result.

Variables:
  • api_version (str) – API version used to produce this result. Required.

  • model_id (str) – Document model ID used to produce this result. Required.

  • string_index_type (str or StringIndexType) – Method used to compute string offset and length. Required. Known values are: “textElements”, “unicodeCodePoint”, and “utf16CodeUnit”.

  • content_format (str or ContentFormat) – Format of the analyze result top-level content. Known values are: “text” and “markdown”.

  • content (str) – Concatenate string representation of all textual and visual elements in reading order. Required.

  • pages (list[DocumentPage]) – Analyzed pages. Required.

  • paragraphs (list[DocumentParagraph]) – Extracted paragraphs.

  • tables (list[DocumentTable]) – Extracted tables.

  • figures (list[DocumentFigure]) – Extracted figures.

  • sections (list[DocumentSection]) – Extracted sections.

  • key_value_pairs (list[DocumentKeyValuePair]) – Extracted key-value pairs.

  • styles (list[DocumentStyle]) – Extracted font styles.

  • languages (list[DocumentLanguage]) – Detected languages.

  • documents (list[Document]) – Extracted documents.

  • warnings (list[Warning]) – List of warnings encountered.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
api_version: str

API version used to produce this result. Required.

content: str

Concatenate string representation of all textual and visual elements in reading order. Required.

content_format: str | _models.ContentFormat | None

“text” and “markdown”.

Type:

Format of the analyze result top-level content. Known values are

documents: List[_models.Document] | None

Extracted documents.

figures: List[_models.DocumentFigure] | None

Extracted figures.

key_value_pairs: List[_models.DocumentKeyValuePair] | None

Extracted key-value pairs.

languages: List[_models.DocumentLanguage] | None

Detected languages.

model_id: str

Document model ID used to produce this result. Required.

pages: List[_models.DocumentPage]

Analyzed pages. Required.

paragraphs: List[_models.DocumentParagraph] | None

Extracted paragraphs.

sections: List[_models.DocumentSection] | None

Extracted sections.

string_index_type: str | _models.StringIndexType

“textElements”, “unicodeCodePoint”, and “utf16CodeUnit”.

Type:

Method used to compute string offset and length. Required. Known values are

styles: List[_models.DocumentStyle] | None

Extracted font styles.

tables: List[_models.DocumentTable] | None

Extracted tables.

warnings: List[_models.Warning] | None

List of warnings encountered.

class azure.ai.documentintelligence.models.AnalyzeResultOperation(*args: Any, **kwargs: Any)[source]

Status and result of the analyze operation.

Variables:
  • status (str or OperationStatus) – Operation status. notStarted, running, succeeded, or failed. Required. Known values are: “notStarted”, “running”, “failed”, “succeeded”, “completed”, and “canceled”.

  • created_date_time (datetime) – Date and time (UTC) when the analyze operation was submitted. Required.

  • last_updated_date_time (datetime) – Date and time (UTC) when the status was last updated. Required.

  • error (Error) – Encountered error during document analysis.

  • analyze_result (AnalyzeResult) – Document analysis result.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
analyze_result: _models.AnalyzeResult | None

Document analysis result.

created_date_time: datetime

Date and time (UTC) when the analyze operation was submitted. Required.

error: _models.Error | None

Encountered error during document analysis.

last_updated_date_time: datetime

Date and time (UTC) when the status was last updated. Required.

status: str | _models.OperationStatus

Operation status. notStarted, running, succeeded, or failed. Required. Known values are: “notStarted”, “running”, “failed”, “succeeded”, “completed”, and “canceled”.

class azure.ai.documentintelligence.models.AuthorizeClassifierCopyRequest(*args: Any, **kwargs: Any)[source]

Request body to authorize document classifier copy.

All required parameters must be populated in order to send to server.

Variables:
  • classifier_id (str) – Unique document classifier name. Required.

  • description (str) – Document classifier description.

  • tags (dict[str, str]) – List of key-value tag attributes associated with the document classifier.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
classifier_id: str

Unique document classifier name. Required.

description: str | None

Document classifier description.

tags: Dict[str, str] | None

List of key-value tag attributes associated with the document classifier.

class azure.ai.documentintelligence.models.AuthorizeCopyRequest(*args: Any, **kwargs: Any)[source]

Request body to authorize document model copy.

All required parameters must be populated in order to send to server.

Variables:
  • model_id (str) – Unique document model name. Required.

  • description (str) – Document model description.

  • tags (dict[str, str]) – List of key-value tag attributes associated with the document model.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
description: str | None

Document model description.

model_id: str

Unique document model name. Required.

tags: Dict[str, str] | None

List of key-value tag attributes associated with the document model.

class azure.ai.documentintelligence.models.AzureBlobContentSource(*args: Any, **kwargs: Any)[source]

Azure Blob Storage content.

Variables:
  • container_url (str) – Azure Blob Storage container URL. Required.

  • prefix (str) – Blob name prefix.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
container_url: str

Azure Blob Storage container URL. Required.

prefix: str | None

Blob name prefix.

class azure.ai.documentintelligence.models.AzureBlobFileListContentSource(*args: Any, **kwargs: Any)[source]

File list in Azure Blob Storage.

Variables:
  • container_url (str) – Azure Blob Storage container URL. Required.

  • file_list (str) – Path to a JSONL file within the container specifying a subset of documents. Required.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
container_url: str

Azure Blob Storage container URL. Required.

file_list: str

Path to a JSONL file within the container specifying a subset of documents. Required.

class azure.ai.documentintelligence.models.BoundingRegion(*args: Any, **kwargs: Any)[source]

Bounding polygon on a specific page of the input.

Variables:
  • page_number (int) – 1-based page number of page containing the bounding region. Required.

  • polygon (list[float]) – 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. Required.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
page_number: int

1-based page number of page containing the bounding region. Required.

polygon: List[float]

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. Required.

class azure.ai.documentintelligence.models.BuildDocumentClassifierRequest(*args: Any, **kwargs: Any)[source]

Request body to build a new custom document classifier.

All required parameters must be populated in order to send to server.

Variables:
  • classifier_id (str) – Unique document classifier name. Required.

  • description (str) – Document classifier description.

  • base_classifier_id (str) – Base classifierId on top of which to train the classifier.

  • doc_types (dict[str, ClassifierDocumentTypeDetails]) – List of document types to classify against. Required.

  • allow_overwrite (bool) – Allow overwriting an existing classifier with the same name.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
allow_overwrite: bool | None

Allow overwriting an existing classifier with the same name.

base_classifier_id: str | None

Base classifierId on top of which to train the classifier.

classifier_id: str

Unique document classifier name. Required.

description: str | None

Document classifier description.

doc_types: Dict[str, _models.ClassifierDocumentTypeDetails]

List of document types to classify against. Required.

class azure.ai.documentintelligence.models.BuildDocumentModelRequest(*args: Any, **kwargs: Any)[source]

Request body to build a new custom document model.

All required parameters must be populated in order to send to server.

Variables:
  • model_id (str) – Unique document model name. Required.

  • description (str) – Document model description.

  • build_mode (str or DocumentBuildMode) – Custom document model build mode. Required. Known values are: “template”, “neural”, and “generative”.

  • azure_blob_source (AzureBlobContentSource) – Azure Blob Storage location containing the training data. Either azureBlobSource or azureBlobFileListSource must be specified.

  • azure_blob_file_list_source (AzureBlobFileListContentSource) – Azure Blob Storage file list specifying the training data. Either azureBlobSource or azureBlobFileListSource must be specified.

  • tags (dict[str, str]) – List of key-value tag attributes associated with the document model.

  • max_training_hours (float) – Max number of V100-equivalent GPU hours to use for model training. Default=0.5.

  • allow_overwrite (bool) – Allow overwriting an existing model with the same name.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
allow_overwrite: bool | None

Allow overwriting an existing model with the same name.

azure_blob_file_list_source: _models.AzureBlobFileListContentSource | None

Azure Blob Storage file list specifying the training data. Either azureBlobSource or azureBlobFileListSource must be specified.

azure_blob_source: _models.AzureBlobContentSource | None

Azure Blob Storage location containing the training data. Either azureBlobSource or azureBlobFileListSource must be specified.

build_mode: str | _models.DocumentBuildMode

“template”, “neural”, and “generative”.

Type:

Custom document model build mode. Required. Known values are

description: str | None

Document model description.

max_training_hours: float | None

Max number of V100-equivalent GPU hours to use for model training. Default=0.5.

model_id: str

Unique document model name. Required.

tags: Dict[str, str] | None

List of key-value tag attributes associated with the document model.

class azure.ai.documentintelligence.models.ClassifierCopyAuthorization(*args: Any, **kwargs: Any)[source]

Authorization to copy a document classifier to the specified target resource and classifierId.

Variables:
  • target_resource_id (str) – ID of the target Azure resource where the document classifier should be copied to. Required.

  • target_resource_region (str) – Location of the target Azure resource where the document classifier should be copied to. Required.

  • target_classifier_id (str) – Identifier of the target document classifier. Required.

  • target_classifier_location (str) – URL of the copied document classifier in the target account. Required.

  • access_token (str) – Token used to authorize the request. Required.

  • expiration_date_time (datetime) – Date/time when the access token expires. Required.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
access_token: str

Token used to authorize the request. Required.

expiration_date_time: datetime

Date/time when the access token expires. Required.

target_classifier_id: str

Identifier of the target document classifier. Required.

target_classifier_location: str

URL of the copied document classifier in the target account. Required.

target_resource_id: str

ID of the target Azure resource where the document classifier should be copied to. Required.

target_resource_region: str

Location of the target Azure resource where the document classifier should be copied to. Required.

class azure.ai.documentintelligence.models.ClassifierDocumentTypeDetails(*args: Any, **kwargs: Any)[source]

Classifier document type info.

Variables:
  • source_kind (str or ContentSourceKind) – Type of training data source. Known values are: “url”, “base64”, “azureBlob”, and “azureBlobFileList”.

  • azure_blob_source (AzureBlobContentSource) – Azure Blob Storage location containing the training data for a classifier document type. Either azureBlobSource or azureBlobFileListSource must be specified.

  • azure_blob_file_list_source (AzureBlobFileListContentSource) – Azure Blob Storage file list specifying the training data for a classifier document type. Either azureBlobSource or azureBlobFileListSource must be specified.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
azure_blob_file_list_source: _models.AzureBlobFileListContentSource | None

Azure Blob Storage file list specifying the training data for a classifier document type. Either azureBlobSource or azureBlobFileListSource must be specified.

azure_blob_source: _models.AzureBlobContentSource | None

Azure Blob Storage location containing the training data for a classifier document type. Either azureBlobSource or azureBlobFileListSource must be specified.

source_kind: str | _models.ContentSourceKind | None

“url”, “base64”, “azureBlob”, and “azureBlobFileList”.

Type:

Type of training data source. Known values are

class azure.ai.documentintelligence.models.ClassifyDocumentRequest(*args: Any, **kwargs: Any)[source]

Document classification parameters.

Variables:
  • url_source (str) – Document URL to classify. Either url_source or bytes_source must be specified.

  • bytes_source (bytes) – Document bytes to classify. Either url_source or bytes_source must be specified.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
bytes_source: bytes | None

Document bytes to classify. Either url_source or bytes_source must be specified.

url_source: str | None

Document URL to classify. Either urlSource or base64Source must be specified.

class azure.ai.documentintelligence.models.ComposeDocumentModelRequest(*args: Any, **kwargs: Any)[source]

Request body to create a composed document model from component document models.

All required parameters must be populated in order to send to server.

Variables:
  • model_id (str) – Unique document model name. Required.

  • description (str) – Document model description.

  • classifier_id (str) – Custom classifier to split and classify the input file. Required.

  • split (str or SplitMode) – File splitting behavior. Known values are: “auto”, “none”, and “perPage”.

  • doc_types (dict[str, DocumentTypeDetails]) – Dictionary mapping supported docTypes to the corresponding document models. Required.

  • tags (dict[str, str]) – List of key-value tag attributes associated with the document model.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
classifier_id: str

Custom classifier to split and classify the input file. Required.

description: str | None

Document model description.

doc_types: Dict[str, _models.DocumentTypeDetails]

Dictionary mapping supported docTypes to the corresponding document models. Required.

model_id: str

Unique document model name. Required.

split: str | _models.SplitMode | None

“auto”, “none”, and “perPage”.

Type:

File splitting behavior. Known values are

tags: Dict[str, str] | None

List of key-value tag attributes associated with the document model.

class azure.ai.documentintelligence.models.ContentFormat(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Format of the content in analyzed result.

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

MARKDOWN = 'markdown'

Markdown representation of the document content with section headings, tables, etc.

TEXT = 'text'

Plain text representation of the document content without any formatting.

class azure.ai.documentintelligence.models.ContentSourceKind(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Type of content source.

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

AZURE_BLOB = 'azureBlob'

Files in a path within an Azure Blob Storage container.

AZURE_BLOB_FILE_LIST = 'azureBlobFileList'

A file list specifying individual files in an Azure Blob Storage container.

BASE64 = 'base64'

Content represented via Base64 encoding.

URL = 'url'

Content at a specific URL.

class azure.ai.documentintelligence.models.CopyAuthorization(*args: Any, **kwargs: Any)[source]

Authorization to copy a document model to the specified target resource and modelId.

Variables:
  • target_resource_id (str) – ID of the target Azure resource where the document model should be copied to. Required.

  • target_resource_region (str) – Location of the target Azure resource where the document model should be copied to. Required.

  • target_model_id (str) – Identifier of the target document model. Required.

  • target_model_location (str) – URL of the copied document model in the target account. Required.

  • access_token (str) – Token used to authorize the request. Required.

  • expiration_date_time (datetime) – Date/time when the access token expires. Required.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
access_token: str

Token used to authorize the request. Required.

expiration_date_time: datetime

Date/time when the access token expires. Required.

target_model_id: str

Identifier of the target document model. Required.

target_model_location: str

URL of the copied document model in the target account. Required.

target_resource_id: str

ID of the target Azure resource where the document model should be copied to. Required.

target_resource_region: str

Location of the target Azure resource where the document model should be copied to. Required.

class azure.ai.documentintelligence.models.CurrencyValue(*args: Any, **kwargs: Any)[source]

Currency field value.

Variables:
  • amount (float) – Currency amount. Required.

  • currency_symbol (str) – Currency symbol label, if any.

  • currency_code (str) – Resolved currency code (ISO 4217), if any.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
amount: float

Currency amount. Required.

currency_code: str | None

Resolved currency code (ISO 4217), if any.

currency_symbol: str | None

Currency symbol label, if any.

class azure.ai.documentintelligence.models.CustomDocumentModelsDetails(*args: Any, **kwargs: Any)[source]

Details regarding custom document models.

Variables:
  • count (int) – Number of custom document models in the current resource. Required.

  • limit (int) – Maximum number of custom document models supported in the current resource. Required.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
count: int

Number of custom document models in the current resource. Required.

limit: int

Maximum number of custom document models supported in the current resource. Required.

class azure.ai.documentintelligence.models.Document(*args: Any, **kwargs: Any)[source]

An object describing the location and semantic content of a document.

Variables:
  • doc_type (str) – Document type. Required.

  • bounding_regions (list[BoundingRegion]) – Bounding regions covering the document.

  • spans (list[DocumentSpan]) – Location of the document in the reading order concatenated content. Required.

  • fields (dict[str, DocumentField]) – Dictionary of named field values.

  • confidence (float) – Confidence of correctly extracting the document. Required.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
bounding_regions: List[_models.BoundingRegion] | None

Bounding regions covering the document.

confidence: float

Confidence of correctly extracting the document. Required.

doc_type: str

Document type. Required.

fields: Dict[str, _models.DocumentField] | None

Dictionary of named field values.

spans: List[_models.DocumentSpan]

Location of the document in the reading order concatenated content. Required.

class azure.ai.documentintelligence.models.DocumentAnalysisFeature(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Document analysis features to enable.

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

BARCODES = 'barcodes'

Enable the detection of barcodes in the document.

FORMULAS = 'formulas'

Enable the detection of mathematical expressions in the document.

KEY_VALUE_PAIRS = 'keyValuePairs'

Enable the detection of general key value pairs (form fields) in the document.

LANGUAGES = 'languages'

Enable the detection of the text content language.

OCR_HIGH_RESOLUTION = 'ocrHighResolution'

Perform OCR at a higher resolution to handle documents with fine print.

QUERY_FIELDS = 'queryFields'

Enable the extraction of additional fields via the queryFields query parameter.

STYLE_FONT = 'styleFont'

Enable the recognition of various font styles.

class azure.ai.documentintelligence.models.DocumentBarcode(*args: Any, **kwargs: Any)[source]

A barcode object.

Variables:
  • kind (str or DocumentBarcodeKind) – Barcode kind. Required. Known values are: “QRCode”, “PDF417”, “UPCA”, “UPCE”, “Code39”, “Code128”, “EAN8”, “EAN13”, “DataBar”, “Code93”, “Codabar”, “DataBarExpanded”, “ITF”, “MicroQRCode”, “Aztec”, “DataMatrix”, and “MaxiCode”.

  • value (str) – Barcode value. Required.

  • polygon (list[float]) – 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) – Location of the barcode in the reading order concatenated content. Required.

  • confidence (float) – Confidence of correctly extracting the barcode. Required.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
confidence: float

Confidence of correctly extracting the barcode. Required.

kind: str | _models.DocumentBarcodeKind

“QRCode”, “PDF417”, “UPCA”, “UPCE”, “Code39”, “Code128”, “EAN8”, “EAN13”, “DataBar”, “Code93”, “Codabar”, “DataBarExpanded”, “ITF”, “MicroQRCode”, “Aztec”, “DataMatrix”, and “MaxiCode”.

Type:

Barcode kind. Required. Known values are

polygon: List[float] | None

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: _models.DocumentSpan

Location of the barcode in the reading order concatenated content. Required.

value: str

Barcode value. Required.

class azure.ai.documentintelligence.models.DocumentBarcodeKind(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Barcode kind.

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

AZTEC = 'Aztec'
Type:

Aztec code, as defined in ISO/IEC 24778

CODABAR = 'Codabar'

Codabar barcode, as defined in ANSI/AIM BC3-1995.

CODE128 = 'Code128'
Type:

Code 128 barcode, as defined in ISO/IEC 15417

CODE39 = 'Code39'
Type:

Code 39 barcode, as defined in ISO/IEC 16388

CODE93 = 'Code93'

Code 93 barcode, as defined in ANSI/AIM BC5-1995.

DATA_BAR = 'DataBar'

GS1 DataBar barcode.

DATA_BAR_EXPANDED = 'DataBarExpanded'

GS1 DataBar Expanded barcode.

DATA_MATRIX = 'DataMatrix'
Type:

Data matrix code, as defined in ISO/IEC 16022

EAN13 = 'EAN13'

GS1 13-digit International Article Number (European Article Number).

EAN8 = 'EAN8'

GS1 8-digit International Article Number (European Article Number).

ITF = 'ITF'

Interleaved 2 of 5 barcode, as defined in ANSI/AIM BC2-1995.

MAXI_CODE = 'MaxiCode'
Type:

MaxiCode, as defined in ISO/IEC 16023

MICRO_Q_R_CODE = 'MicroQRCode'
Type:

Micro QR code, as defined in ISO/IEC 23941

PDF417 = 'PDF417'

PDF417, as defined in ISO 15438.

Q_R_CODE = 'QRCode'
Type:

QR code, as defined in ISO/IEC 18004

UPCA = 'UPCA'

GS1 12-digit Universal Product Code.

UPCE = 'UPCE'

GS1 6-digit Universal Product Code.

class azure.ai.documentintelligence.models.DocumentBuildMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Custom document model build mode.

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

GENERATIVE = 'generative'

Enable documents of all types using generative AI techniques.

NEURAL = 'neural'

Support documents with diverse visual templates.

TEMPLATE = 'template'

Target documents with similar visual templates.

class azure.ai.documentintelligence.models.DocumentCaption(*args: Any, **kwargs: Any)[source]

A caption object describing a table or figure.

Variables:
  • content (str) – Content of the caption. Required.

  • bounding_regions (list[BoundingRegion]) – Bounding regions covering the caption.

  • spans (list[DocumentSpan]) – Location of the caption in the reading order concatenated content. Required.

  • elements (list[str]) – Child elements of the caption.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
bounding_regions: List[_models.BoundingRegion] | None

Bounding regions covering the caption.

content: str

Content of the caption. Required.

elements: List[str] | None

Child elements of the caption.

spans: List[_models.DocumentSpan]

Location of the caption in the reading order concatenated content. Required.

class azure.ai.documentintelligence.models.DocumentClassifierBuildOperationDetails(*args: Any, **kwargs: Any)[source]

Get Operation response object.

Variables:
  • operation_id (str) – Operation ID. Required.

  • status (str or OperationStatus) – Operation status. notStarted, running, completed, or failed. Required. Known values are: “notStarted”, “running”, “failed”, “succeeded”, “completed”, and “canceled”.

  • percent_completed (int) – Operation progress (0-100).

  • created_date_time (datetime) – Date and time (UTC) when the operation was created. Required.

  • last_updated_date_time (datetime) – Date and time (UTC) when the status was last updated. Required.

  • resource_location (str) – URL of the resource targeted by this operation. Required.

  • api_version (str) – API version used to create this operation.

  • tags (dict[str, str]) – List of key-value tag attributes associated with the document model.

  • error (Error) – Encountered error.

  • result (DocumentClassifierDetails) – Operation result upon success.

  • kind (str or DOCUMENT_CLASSIFIER_BUILD) – Type of operation. Required. Build a new custom classifier model.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
api_version: str | None

API version used to create this operation.

created_date_time: datetime.datetime

Date and time (UTC) when the operation was created. Required.

error: '_models.Error' | None

Encountered error.

kind: Literal[OperationKind.DOCUMENT_CLASSIFIER_BUILD]

Type of operation. Required. Build a new custom classifier model.

last_updated_date_time: datetime.datetime

Date and time (UTC) when the status was last updated. Required.

operation_id: str

Operation ID. Required.

percent_completed: int | None

Operation progress (0-100).

resource_location: str

URL of the resource targeted by this operation. Required.

result: _models.DocumentClassifierDetails | None

Operation result upon success.

status: str | '_models.OperationStatus'

Operation status. notStarted, running, completed, or failed. Required. Known values are: “notStarted”, “running”, “failed”, “succeeded”, “completed”, and “canceled”.

tags: Dict[str, str] | None

List of key-value tag attributes associated with the document model.

class azure.ai.documentintelligence.models.DocumentClassifierCopyToOperationDetails(*args: Any, **kwargs: Any)[source]

Get Operation response object.

Variables:
  • operation_id (str) – Operation ID. Required.

  • status (str or OperationStatus) – Operation status. notStarted, running, completed, or failed. Required. Known values are: “notStarted”, “running”, “failed”, “succeeded”, “completed”, and “canceled”.

  • percent_completed (int) – Operation progress (0-100).

  • created_date_time (datetime) – Date and time (UTC) when the operation was created. Required.

  • last_updated_date_time (datetime) – Date and time (UTC) when the status was last updated. Required.

  • resource_location (str) – URL of the resource targeted by this operation. Required.

  • api_version (str) – API version used to create this operation.

  • tags (dict[str, str]) – List of key-value tag attributes associated with the document model.

  • error (Error) – Encountered error.

  • result (DocumentClassifierDetails) – Operation result upon success.

  • kind (str or DOCUMENT_CLASSIFIER_COPY_TO) – Type of operation. Required. Copy an existing document classifier to potentially a different resource, region, or subscription.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
api_version: str | None

API version used to create this operation.

created_date_time: datetime.datetime

Date and time (UTC) when the operation was created. Required.

error: '_models.Error' | None

Encountered error.

kind: Literal[OperationKind.DOCUMENT_CLASSIFIER_COPY_TO]

Type of operation. Required. Copy an existing document classifier to potentially a different resource, region, or subscription.

last_updated_date_time: datetime.datetime

Date and time (UTC) when the status was last updated. Required.

operation_id: str

Operation ID. Required.

percent_completed: int | None

Operation progress (0-100).

resource_location: str

URL of the resource targeted by this operation. Required.

result: _models.DocumentClassifierDetails | None

Operation result upon success.

status: str | '_models.OperationStatus'

Operation status. notStarted, running, completed, or failed. Required. Known values are: “notStarted”, “running”, “failed”, “succeeded”, “completed”, and “canceled”.

tags: Dict[str, str] | None

List of key-value tag attributes associated with the document model.

class azure.ai.documentintelligence.models.DocumentClassifierDetails(*args: Any, **kwargs: Any)[source]

Document classifier info.

Variables:
  • classifier_id (str) – Unique document classifier name. Required.

  • description (str) – Document classifier description.

  • created_date_time (datetime) – Date and time (UTC) when the document classifier was created. Required.

  • expiration_date_time (datetime) – Date and time (UTC) when the document classifier will expire.

  • api_version (str) – API version used to create this document classifier. Required.

  • base_classifier_id (str) – Base classifierId on top of which the classifier was trained.

  • doc_types (dict[str, ClassifierDocumentTypeDetails]) – List of document types to classify against. Required.

  • warnings (list[Warning]) – List of warnings encountered while building the classifier.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
api_version: str

API version used to create this document classifier. Required.

base_classifier_id: str | None

Base classifierId on top of which the classifier was trained.

classifier_id: str

Unique document classifier name. Required.

created_date_time: datetime

Date and time (UTC) when the document classifier was created. Required.

description: str | None

Document classifier description.

doc_types: Dict[str, _models.ClassifierDocumentTypeDetails]

List of document types to classify against. Required.

expiration_date_time: datetime | None

Date and time (UTC) when the document classifier will expire.

warnings: List[_models.Warning] | None

List of warnings encountered while building the classifier.

class azure.ai.documentintelligence.models.DocumentField(*args: Any, **kwargs: Any)[source]

An object representing the content and location of a field value.

Variables:
  • type (str or DocumentFieldType) – Data type of the field value. Required. Known values are: “string”, “date”, “time”, “phoneNumber”, “number”, “integer”, “selectionMark”, “countryRegion”, “signature”, “array”, “object”, “currency”, “address”, “boolean”, and “selectionGroup”.

  • value_string (str) – String value.

  • value_date (date) – Date value in YYYY-MM-DD format (ISO 8601).

  • value_time (time) – Time value in hh:mm:ss format (ISO 8601).

  • value_phone_number (str) – Phone number value in E.164 format (ex. +19876543210).

  • value_number (float) – Floating point value.

  • value_integer (int) – Integer value.

  • value_selection_mark (str or DocumentSelectionMarkState) – Selection mark value. Known values are: “selected” and “unselected”.

  • value_signature (str or DocumentSignatureType) – Presence of signature. Known values are: “signed” and “unsigned”.

  • value_country_region (str) – 3-letter country code value (ISO 3166-1 alpha-3).

  • value_array (list[DocumentField]) – Array of field values.

  • value_object (dict[str, DocumentField]) – Dictionary of named field values.

  • value_currency (CurrencyValue) – Currency value.

  • value_address (AddressValue) – Address value.

  • value_boolean (bool) – Boolean value.

  • value_selection_group (list[str]) – Selection group value.

  • content (str) – Field content.

  • bounding_regions (list[BoundingRegion]) – Bounding regions covering the field.

  • spans (list[DocumentSpan]) – Location of the field in the reading order concatenated content.

  • confidence (float) – Confidence of correctly extracting the field.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
bounding_regions: List[_models.BoundingRegion] | None

Bounding regions covering the field.

confidence: float | None

Confidence of correctly extracting the field.

content: str | None

Field content.

spans: List[_models.DocumentSpan] | None

Location of the field in the reading order concatenated content.

type: str | _models.DocumentFieldType

“string”, “date”, “time”, “phoneNumber”, “number”, “integer”, “selectionMark”, “countryRegion”, “signature”, “array”, “object”, “currency”, “address”, “boolean”, and “selectionGroup”.

Type:

Data type of the field value. Required. Known values are

value_address: _models.AddressValue | None

Address value.

value_array: List[_models.DocumentField] | None

Array of field values.

value_boolean: bool | None

Boolean value.

value_country_region: str | None

3-letter country code value (ISO 3166-1 alpha-3).

value_currency: _models.CurrencyValue | None

Currency value.

value_date: date | None

Date value in YYYY-MM-DD format (ISO 8601).

value_integer: int | None

Integer value.

value_number: float | None

Floating point value.

value_object: Dict[str, _models.DocumentField] | None

Dictionary of named field values.

value_phone_number: str | None

Phone number value in E.164 format (ex. +19876543210).

value_selection_group: List[str] | None

Selection group value.

value_selection_mark: str | _models.DocumentSelectionMarkState | None

“selected” and “unselected”.

Type:

Selection mark value. Known values are

value_signature: str | _models.DocumentSignatureType | None

“signed” and “unsigned”.

Type:

Presence of signature. Known values are

value_string: str | None

String value.

value_time: time | None

ss format (ISO 8601).

Type:

Time value in hh

Type:

mm

class azure.ai.documentintelligence.models.DocumentFieldSchema(*args: Any, **kwargs: Any)[source]

Description of the field semantic schema using a JSON Schema style syntax.

Variables:
  • type (str or DocumentFieldType) – Semantic data type of the field value. Required. Known values are: “string”, “date”, “time”, “phoneNumber”, “number”, “integer”, “selectionMark”, “countryRegion”, “signature”, “array”, “object”, “currency”, “address”, “boolean”, and “selectionGroup”.

  • description (str) – Field description.

  • example (str) – Example field content.

  • items_property (DocumentFieldSchema) – Field type schema of each array element.

  • properties (dict[str, DocumentFieldSchema]) – Named sub-fields of the object field.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
description: str | None

Field description.

example: str | None

Example field content.

items_property: _models.DocumentFieldSchema | None

Field type schema of each array element.

properties: Dict[str, _models.DocumentFieldSchema] | None

Named sub-fields of the object field.

type: str | _models.DocumentFieldType

“string”, “date”, “time”, “phoneNumber”, “number”, “integer”, “selectionMark”, “countryRegion”, “signature”, “array”, “object”, “currency”, “address”, “boolean”, and “selectionGroup”.

Type:

Semantic data type of the field value. Required. Known values are

class azure.ai.documentintelligence.models.DocumentFieldType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Semantic data type of the field value.

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

ADDRESS = 'address'

Parsed address.

ARRAY = 'array'

List of subfields of the same type.

BOOLEAN = 'boolean'

Boolean value, normalized to true or false.

COUNTRY_REGION = 'countryRegion'

Country/region, normalized to ISO 3166-1 alpha-3 format (ex. USA).

CURRENCY = 'currency'

Currency amount with optional currency symbol and unit.

DATE = 'date'

Date, normalized to ISO 8601 (YYYY-MM-DD) format.

INTEGER = 'integer'

Integer number, normalized to 64-bit signed integer.

NUMBER = 'number'

Floating point number, normalized to double precision floating point.

OBJECT = 'object'

Named list of subfields of potentially different types.

PHONE_NUMBER = 'phoneNumber'

Phone number, normalized to E.164 (+{CountryCode}{SubscriberNumber}) format.

SELECTION_GROUP = 'selectionGroup'

Array of selected string values.

SELECTION_MARK = 'selectionMark'

Is field selected?

SIGNATURE = 'signature'

Is signature present?

STRING = 'string'

Plain text.

TIME = 'time'

ss) format.

Type:

Time, normalized to ISO 8601 (hh

Type:

mm

class azure.ai.documentintelligence.models.DocumentFigure(*args: Any, **kwargs: Any)[source]

An object representing a figure in the document.

Variables:
  • bounding_regions (list[BoundingRegion]) – Bounding regions covering the figure.

  • spans (list[DocumentSpan]) – Location of the figure in the reading order concatenated content. Required.

  • elements (list[str]) – Child elements of the figure, excluding any caption or footnotes.

  • caption (DocumentCaption) – Caption associated with the figure.

  • footnotes (list[DocumentFootnote]) – List of footnotes associated with the figure.

  • id (str) – Figure ID.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
bounding_regions: List[_models.BoundingRegion] | None

Bounding regions covering the figure.

caption: _models.DocumentCaption | None

Caption associated with the figure.

elements: List[str] | None

Child elements of the figure, excluding any caption or footnotes.

footnotes: List[_models.DocumentFootnote] | None

List of footnotes associated with the figure.

id: str | None

Figure ID.

spans: List[_models.DocumentSpan]

Location of the figure in the reading order concatenated content. Required.

class azure.ai.documentintelligence.models.DocumentFootnote(*args: Any, **kwargs: Any)[source]

A footnote object describing a table or figure.

Variables:
  • content (str) – Content of the footnote. Required.

  • bounding_regions (list[BoundingRegion]) – Bounding regions covering the footnote.

  • spans (list[DocumentSpan]) – Location of the footnote in the reading order concatenated content. Required.

  • elements (list[str]) – Child elements of the footnote.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
bounding_regions: List[_models.BoundingRegion] | None

Bounding regions covering the footnote.

content: str

Content of the footnote. Required.

elements: List[str] | None

Child elements of the footnote.

spans: List[_models.DocumentSpan]

Location of the footnote in the reading order concatenated content. Required.

class azure.ai.documentintelligence.models.DocumentFormula(*args: Any, **kwargs: Any)[source]

A formula object.

Variables:
  • kind (str or DocumentFormulaKind) – Formula kind. Required. Known values are: “inline” and “display”.

  • value (str) – LaTex expression describing the formula. Required.

  • polygon (list[float]) – 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) – Location of the formula in the reading order concatenated content. Required.

  • confidence (float) – Confidence of correctly extracting the formula. Required.

as_dict(*, exclude_readonly: bool = False) Dict[str, Any]

Return a dict that can be JSONify using json.dump.

Keyword Arguments:

exclude_readonly (bool) – Whether to remove the readonly properties.

Returns:

A dict JSON compatible object

Return type:

dict

clear() None.  Remove all items from D.
copy() Model
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values
confidence: float

Confidence of correctly extracting the formula. Required.

kind: str | _models.DocumentFormulaKind

“inline” and “display”.

Type:

Formula kind. Required. Known values are

polygon: List[float] | None

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: _models.DocumentSpan

Location of the formula in the reading order concatenated content. Required.

value: str

LaTex expression describing the formula. Required.

class azure.ai.documentintelligence.models.DocumentFormulaKind(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Formula kind.

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()