azure.ai.language.conversations.authoring.models package
- class azure.ai.language.conversations.authoring.models.AssignProjectResourcesDetails(*args: Any, **kwargs: Any)[source]
Represents the payload for assigning Azure resources to a project.
- Variables:
metadata (list[ResourceMetadata]) – Represents the metadata for the project resources to be assigned. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- metadata: list[_models.ResourceMetadata]
Represents the metadata for the project resources to be assigned. Required.
- class azure.ai.language.conversations.authoring.models.AssignedProjectDeploymentMetadata(*args: Any, **kwargs: Any)[source]
Represents the metadata for an assigned deployment.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.AssignedProjectDeploymentsMetadata(*args: Any, **kwargs: Any)[source]
Represents the metadata for assigned deployments for a project.
- Variables:
project_name (str) – Represents the project name. Required.
deployments_metadata (list[AssignedProjectDeploymentMetadata]) – Represents the resource region. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- deployments_metadata: list[_models.AssignedProjectDeploymentMetadata]
Represents the resource region. Required.
- class azure.ai.language.conversations.authoring.models.AssignedProjectResource(*args: Any, **kwargs: Any)[source]
Represents the assigned project resource.
- Variables:
resource_id (str) – The Azure resource ID of the language or AI resource. Required.
region (str) – The Azure resource region. Required.
assigned_aoai_resource (DataGenerationConnectionInfo) – Represents the AOAI resource assigned for data generation.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- assigned_aoai_resource: _models.DataGenerationConnectionInfo | None
Represents the AOAI resource assigned for data generation.
- class azure.ai.language.conversations.authoring.models.CompositionMode(*values)[source]
Type of CompositionMode.
- 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.
- 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()
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()
Return True if the string ends with the specified suffix, False otherwise.
- suffix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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()
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)
Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping, /)
Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index()
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 all characters in the string are printable, False otherwise.
A character is printable if repr() may use it in its output.
- 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.
- 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()
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()
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()
Return True if the string starts with the specified prefix, False otherwise.
- prefix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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.
- COMBINE_COMPONENTS = 'combineComponents'
When two or more components are found in the text and overlap, the components’ spans are merged together into one span combining all of them.
- REQUIRE_EXACT_OVERLAP = 'requireExactOverlap'
All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return.
- RETURN_LONGEST_OVERLAP = 'returnLongestOverlap'
When two or more components are found in the text and overlap, the component with the longest set of characters is returned.
- SEPARATE_COMPONENTS = 'separateComponents'
Every component’s match or prediction is returned as a separate instance of the entity.
- class azure.ai.language.conversations.authoring.models.ConfusionMatrixCell(*args: Any, **kwargs: Any)[source]
Represents a cell in a confusion matrix.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ConfusionMatrixRow(*args: Any, **kwargs: Any)[source]
ConfusionMatrixRow.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ConversationExportedAssociatedEntityLabel(*args: Any, **kwargs: Any)[source]
Represents an associated entity label for an intent.
- Variables:
category (str) – The category of the entity label. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ConversationExportedEntity(*args: Any, **kwargs: Any)[source]
Represents an entity with its components.
- Variables:
category (str) – The category of the entity. Required.
description (str) – The entity description.
composition_mode (str or CompositionMode) – The behavior to follow when the entity’s components overlap with each other. Known values are: “returnLongestOverlap”, “requireExactOverlap”, “separateComponents”, and “combineComponents”.
entities (ExportedEntityList) – The list component of the entity.
prebuilts (list[ExportedPrebuiltEntity]) – The prebuilt entities components.
regex (ExportedEntityRegex) – The regex component of the entity.
required_components (list[str]) – The required components. Allowed values are ‘learned’, ‘list’, ‘prebuilts’ and ‘regex’.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- composition_mode: str | _models.CompositionMode | None
The behavior to follow when the entity’s components overlap with each other. Known values are: “returnLongestOverlap”, “requireExactOverlap”, “separateComponents”, and “combineComponents”.
- entities: _models.ExportedEntityList | None
The list component of the entity.
- prebuilts: list[_models.ExportedPrebuiltEntity] | None
The prebuilt entities components.
- regex: _models.ExportedEntityRegex | None
The regex component of the entity.
- class azure.ai.language.conversations.authoring.models.ConversationExportedIntent(*args: Any, **kwargs: Any)[source]
Represents an exported intent of a conversational project.
- Variables:
category (str) – The intent category. Required.
description (str) – The intent description.
associated_entities (list[ConversationExportedAssociatedEntityLabel]) – The list of associated entities.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- associated_entities: list[_models.ConversationExportedAssociatedEntityLabel] | None
The list of associated entities.
- class azure.ai.language.conversations.authoring.models.ConversationExportedProjectAsset(*args: Any, **kwargs: Any)[source]
Represents the exported assets of a conversational project.
- Variables:
intents (list[ConversationExportedIntent]) – The intents defined in the project.
entities (list[ConversationExportedEntity]) – The entities defined in the project.
utterances (list[ConversationExportedUtterance]) – The utterances defined in the project.
project_kind (str or CONVERSATION) – The type of project containing the assets. Required. A project to build natural language into apps, bots, and IoT devices.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- entities: list[_models.ConversationExportedEntity] | None
The entities defined in the project.
- intents: list[_models.ConversationExportedIntent] | None
The intents defined in the project.
- project_kind: Literal[ProjectKind.CONVERSATION]
The type of project containing the assets. Required. A project to build natural language into apps, bots, and IoT devices.
- utterances: list[_models.ConversationExportedUtterance] | None
The utterances defined in the project.
- class azure.ai.language.conversations.authoring.models.ConversationExportedUtterance(*args: Any, **kwargs: Any)[source]
Represents an exported utterance for a conversational project.
- Variables:
entities (list[ExportedUtteranceEntityLabel]) – Represents the entity labels of the utterance.
text (str) – The utterance text. Required.
language (str) – Represents the utterance’s language. This is BCP-47 representation of a language. For example, use “en” for English, “en-gb” for English (UK), “es” for Spanish etc.
intent (str) – The intent of the utterance. Required.
dataset (str or DatasetType) – The dataset for this utterance. Allowed values are ‘Train’ and ‘Test’. Known values are: “Train” and “Test”.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- dataset: str | _models.DatasetType | None
The dataset for this utterance. Allowed values are ‘Train’ and ‘Test’. Known values are: “Train” and “Test”.
- entities: list[_models.ExportedUtteranceEntityLabel] | None
Represents the entity labels of the utterance.
- class azure.ai.language.conversations.authoring.models.CopyProjectDetails(*args: Any, **kwargs: Any)[source]
Represents the options for copying an existing project to another Azure resource.
- Variables:
project_kind (str or ProjectKind) – Represents the project kind. Required. Known values are: “Conversation”, “Orchestration”, and “CustomConversationSummarization”.
target_project_name (str) – The project name to be copied-into. Required.
access_token (str) – The access token. Required.
expires_at (datetime) – The expiration of the access token. Required.
target_resource_id (str) – Represents the target Azure resource ID. Required.
target_resource_region (str) – Represents the target Azure resource region. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.CopyProjectState(*args: Any, **kwargs: Any)[source]
Represents the state of a copy job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.CreateDeploymentDetails(*args: Any, **kwargs: Any)[source]
Represents the options for creating or updating a project deployment.
- Variables:
trained_model_label (str) – Represents the trained model label. Required.
assigned_resources (list[DeploymentResource]) – Represents the resources to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- assigned_resources: list[_models.DeploymentResource] | None
Represents the resources to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.
- class azure.ai.language.conversations.authoring.models.CreateProjectOptions(*args: Any, **kwargs: Any)[source]
Represents the options used to create or update a project.
- Variables:
project_kind (str or ProjectKind) – Represents the project kind. Required. Known values are: “Conversation”, “Orchestration”, and “CustomConversationSummarization”.
settings (ProjectSettings) – The project settings.
storage_input_container_name (str) – The storage container name in case of conversation summarization.
project_name (str) – The new project name. Required.
multilingual (bool) – Whether the project would be used for multiple languages or not.
description (str) – The project description.
language (str) – The project language. This is BCP-47 representation of a language. For example, use “en” for English, “en-gb” for English (UK), “es” for Spanish etc. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- language: str
The project language. This is BCP-47 representation of a language. For example, use “en” for English, “en-gb” for English (UK), “es” for Spanish etc. Required.
- project_kind: str | _models.ProjectKind
“Conversation”, “Orchestration”, and “CustomConversationSummarization”.
- Type:
Represents the project kind. Required. Known values are
- settings: _models.ProjectSettings | None
The project settings.
- class azure.ai.language.conversations.authoring.models.DataGenerationConnectionInfo(*args: Any, **kwargs: Any)[source]
Represents the connection info for the Azure resource to use during data generation.
- Variables:
kind (str or DataGenerationConnectionKind) – Connection type for data generation settings. Currently only supports Azure OpenAI. Required. “AzureOpenAI”
deployment_name (str) – Deployment name of model to be used for synthetic data generation. Required.
resource_id (str) – Resource ID for the data generation resource. Looks something like “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{resourceName}”.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.DataGenerationConnectionKind(*values)[source]
Represents the connection kind for Azure OpenAI deployment.
- 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.
- 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()
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()
Return True if the string ends with the specified suffix, False otherwise.
- suffix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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()
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)
Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping, /)
Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index()
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 all characters in the string are printable, False otherwise.
A character is printable if repr() may use it in its output.
- 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.
- 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()
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()
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()
Return True if the string starts with the specified prefix, False otherwise.
- prefix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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_OPEN_AI = 'AzureOpenAI'
- class azure.ai.language.conversations.authoring.models.DataGenerationSettings(*args: Any, **kwargs: Any)[source]
Settings to enable data generation for training augmentation.
- Variables:
enable_data_generation (bool) – Must be explicitly set to True to enable data generation to augment training data. Required.
data_generation_connection_info (DataGenerationConnectionInfo) – Must be filled out to enable data generation to augment training data. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- data_generation_connection_info: _models.DataGenerationConnectionInfo
Must be filled out to enable data generation to augment training data. Required.
- class azure.ai.language.conversations.authoring.models.DatasetType(*values)[source]
The dataset for this utterance. Allowed values are ‘Train’ and ‘Test’.
- 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.
- 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()
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()
Return True if the string ends with the specified suffix, False otherwise.
- suffix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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()
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)
Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping, /)
Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index()
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 all characters in the string are printable, False otherwise.
A character is printable if repr() may use it in its output.
- 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.
- 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()
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()
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()
Return True if the string starts with the specified prefix, False otherwise.
- prefix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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.
- TEST = 'Test'
Split the data according to the chosen dataset for every example in the data.
- TRAIN = 'Train'
Split the data into training and test sets according to user-defined percentages.
- class azure.ai.language.conversations.authoring.models.DeploymentDeleteFromResourcesState(*args: Any, **kwargs: Any)[source]
Represents the state of an existing delete deployment from specific resources job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.DeploymentResource(*args: Any, **kwargs: Any)[source]
Represents an Azure resource assigned to a deployment.
- Variables:
resource_id (str) – Represents the Azure resource Id. Required.
region (str) – Represents the resource region. Required.
assigned_aoai_resource (DataGenerationConnectionInfo) – Represents the AOAI resource assigned for data generation.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- assigned_aoai_resource: _models.DataGenerationConnectionInfo | None
Represents the AOAI resource assigned for data generation.
- class azure.ai.language.conversations.authoring.models.DeploymentState(*args: Any, **kwargs: Any)[source]
Represents the state of a deployment job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.EntitiesEvaluationSummary(*args: Any, **kwargs: Any)[source]
Represents the evaluation result summary for the project’s entities.
- Variables:
confusion_matrix (dict[str, ConfusionMatrixRow]) – Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted. Required.
entities (dict[str, EntityEvaluationSummary]) – Represents the entities evaluation summary. Required.
micro_f1 (float) – Represents the micro F1. Expected value is a float between 0 and 1 inclusive. Required.
micro_precision (float) – Represents the micro precision. Expected value is a float between 0 and 1 inclusive. Required.
micro_recall (float) – Represents the micro recall. Expected value is a float between 0 and 1 inclusive. Required.
macro_f1 (float) – Represents the macro F1. Expected value is a float between 0 and 1 inclusive. Required.
macro_precision (float) – Represents the macro precision. Expected value is a float between 0 and 1 inclusive. Required.
macro_recall (float) – Represents the macro recall. Expected value is a float between 0 and 1 inclusive. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- confusion_matrix: dict[str, _models.ConfusionMatrixRow]
Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted. Required.
- entities: dict[str, _models.EntityEvaluationSummary]
Represents the entities evaluation summary. Required.
- macro_f1: float
Represents the macro F1. Expected value is a float between 0 and 1 inclusive. Required.
- macro_precision: float
Represents the macro precision. Expected value is a float between 0 and 1 inclusive. Required.
- macro_recall: float
Represents the macro recall. Expected value is a float between 0 and 1 inclusive. Required.
- micro_f1: float
Represents the micro F1. Expected value is a float between 0 and 1 inclusive. Required.
- class azure.ai.language.conversations.authoring.models.EntityEvaluationSummary(*args: Any, **kwargs: Any)[source]
Represents the evaluation result for an entity.
- Variables:
f1 (float) – Represents the model F1 score. Required.
precision (float) – Represents the model precision. Required.
recall (float) – Represents the model precision. Required.
true_positive_count (int) – Represents the count of true positive. Required.
true_negative_count (int) – Represents the count of true negative. Required.
false_positive_count (int) – Represents the count of false positive. Required.
false_negative_count (int) – Represents the count of false negative. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.EvalSummary(*args: Any, **kwargs: Any)[source]
Represents the evaluation result summary.
- Variables:
entities_evaluation (EntitiesEvaluationSummary) – Contains the data related to entities evaluation. Required.
intents_evaluation (IntentsEvaluationSummary) – Contains the data related to intents evaluation. Required.
evaluation_options (EvaluationDetails) – The options that were used while running the evaluation.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- entities_evaluation: _models.EntitiesEvaluationSummary
Contains the data related to entities evaluation. Required.
- evaluation_options: _models.EvaluationDetails | None
The options that were used while running the evaluation.
- intents_evaluation: _models.IntentsEvaluationSummary
Contains the data related to intents evaluation. Required.
- class azure.ai.language.conversations.authoring.models.EvaluationDetails(*args: Any, **kwargs: Any)[source]
Represents the options used running the evaluation.
- Variables:
kind (str or EvaluationKind) – Represents the evaluation kind. By default, the evaluation kind is set to percentage. Known values are: “percentage” and “manual”.
training_split_percentage (int) – Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.
testing_split_percentage (int) – Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- kind: str | _models.EvaluationKind | None
Represents the evaluation kind. By default, the evaluation kind is set to percentage. Known values are: “percentage” and “manual”.
- class azure.ai.language.conversations.authoring.models.EvaluationJobResult(*args: Any, **kwargs: Any)[source]
EvaluationJobResult.
- Variables:
evaluation_details (EvaluationDetails) – Represents the options used running the evaluation. Required.
model_label (str) – Represents trained model label. Required.
training_config_version (str) – Represents training config version. Required.
percent_complete (int) – Represents progress percentage. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- evaluation_details: _models.EvaluationDetails
Represents the options used running the evaluation. Required.
- class azure.ai.language.conversations.authoring.models.EvaluationKind(*values)[source]
Type of EvaluationKind.
- 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.
- 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()
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()
Return True if the string ends with the specified suffix, False otherwise.
- suffix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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()
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)
Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping, /)
Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index()
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 all characters in the string are printable, False otherwise.
A character is printable if repr() may use it in its output.
- 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.
- 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()
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()
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()
Return True if the string starts with the specified prefix, False otherwise.
- prefix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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.
- MANUAL = 'manual'
Split the data according to the chosen dataset for every example in the data.
- PERCENTAGE = 'percentage'
Split the data into training and test sets according to user-defined percentages.
- class azure.ai.language.conversations.authoring.models.EvaluationState(*args: Any, **kwargs: Any)[source]
Represents the state of a evaluation job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
result (EvaluationJobResult) – Represents evaluation task detailed result. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- result: _models.EvaluationJobResult
Represents evaluation task detailed result. Required.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.ExportProjectState(*args: Any, **kwargs: Any)[source]
Represents the state of an export job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
result_uri (str) – The URL to use in order to download the exported project.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.ExportedConversationOrchestration(*args: Any, **kwargs: Any)[source]
Defines the orchestration details for a Conversational project target.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ExportedConversationOrchestrationDetails(*args: Any, **kwargs: Any)[source]
Represents the orchestration options for a Conversational project target.
- Variables:
conversation_orchestration (ExportedConversationOrchestration) – The Conversational project target details. Required.
target_project_kind (str or CONVERSATION) – The kind of the target used in the orchestration flow. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- conversation_orchestration: _models.ExportedConversationOrchestration
The Conversational project target details. Required.
- class azure.ai.language.conversations.authoring.models.ExportedEntityList(*args: Any, **kwargs: Any)[source]
Represents a list component of an entity.
- Variables:
sublists (list[ExportedEntitySublist]) – The sub-lists of the list component.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- sublists: list[_models.ExportedEntitySublist] | None
The sub-lists of the list component.
- class azure.ai.language.conversations.authoring.models.ExportedEntityListSynonym(*args: Any, **kwargs: Any)[source]
Represents a list of synonyms inside a list component.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ExportedEntityRegex(*args: Any, **kwargs: Any)[source]
Represents a regex component of an entity.
- Variables:
expressions (list[ExportedEntityRegexExpression]) – The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- expressions: list[_models.ExportedEntityRegexExpression] | None
The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions.
- class azure.ai.language.conversations.authoring.models.ExportedEntityRegexExpression(*args: Any, **kwargs: Any)[source]
Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ExportedEntitySublist(*args: Any, **kwargs: Any)[source]
Represents a sub-list inside a list component.
- Variables:
list_key (str) – The key of the sub-list.
synonyms (list[ExportedEntityListSynonym]) – The phrases of that correspond to the sub-list.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- synonyms: list[_models.ExportedEntityListSynonym] | None
The phrases of that correspond to the sub-list.
- class azure.ai.language.conversations.authoring.models.ExportedLuisOrchestration(*args: Any, **kwargs: Any)[source]
Defines the orchestration details for a LUIS application target.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ExportedLuisOrchestrationDetails(*args: Any, **kwargs: Any)[source]
Represents the orchestration options for a LUIS application target.
- Variables:
luis_orchestration (ExportedLuisOrchestration) – The LUIS application target details. Required.
target_project_kind (str or LUIS) – The kind of the target used in the orchestration flow. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- luis_orchestration: _models.ExportedLuisOrchestration
The LUIS application target details. Required.
- class azure.ai.language.conversations.authoring.models.ExportedModelDetails(*args: Any, **kwargs: Any)[source]
Represents the options for creating or replacing an exported model.
- Variables:
trained_model_label (str) – The trained model label. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ExportedModelState(*args: Any, **kwargs: Any)[source]
Represents the state of a job to create or updated an exported model.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.ExportedOrchestrationDetails(*args: Any, **kwargs: Any)[source]
Represents the options used to define the orchestration behavior of an intent.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ExportedConversationOrchestrationDetails, ExportedLuisOrchestrationDetails, ExportedQuestionAnsweringOrchestrationDetails
- Variables:
target_project_kind (str or OrchestrationTargetProjectKind) – Required. Known values are: “Luis”, “Conversation”, and “QuestionAnswering”.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ExportedPrebuiltEntity(*args: Any, **kwargs: Any)[source]
Represents an exported prebuilt entity component.
- Variables:
category (str) – The prebuilt entity category. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ExportedProject(*args: Any, **kwargs: Any)[source]
Represents an exported project.
- Variables:
project_file_version (str) – The version of the exported file. Required.
string_index_type (str or StringIndexType) – Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. Required. Known values are: “Utf16CodeUnit”, “Utf8CodeUnit”, and “Utf32CodeUnit”.
metadata (CreateProjectOptions) – Represents the project metadata. Required.
assets (ExportedProjectAsset) – Represents the project assets.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- assets: _models.ExportedProjectAsset | None
Represents the project assets.
- metadata: _models.CreateProjectOptions
Represents the project metadata. Required.
- string_index_type: str | _models.StringIndexType
Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. Required. Known values are: “Utf16CodeUnit”, “Utf8CodeUnit”, and “Utf32CodeUnit”.
- class azure.ai.language.conversations.authoring.models.ExportedProjectAsset(*args: Any, **kwargs: Any)[source]
Represents the assets of an exported project.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ConversationExportedProjectAsset, OrchestrationExportedProjectAsset
- Variables:
project_kind (str or ProjectKind) – The type of project containing the assets. Required. Known values are: “Conversation”, “Orchestration”, and “CustomConversationSummarization”.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ExportedProjectFormat(*values)[source]
Type of ExportedProjectFormat.
- 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.
- 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()
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()
Return True if the string ends with the specified suffix, False otherwise.
- suffix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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()
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)
Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping, /)
Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index()
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 all characters in the string are printable, False otherwise.
A character is printable if repr() may use it in its output.
- 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.
- 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()
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()
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()
Return True if the string starts with the specified prefix, False otherwise.
- prefix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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.
- CONVERSATION = 'Conversation'
Specifies the format for a conversational project.
- LUIS = 'Luis'
Specifies the format for an application that was exported from LUIS.
- class azure.ai.language.conversations.authoring.models.ExportedQuestionAnsweringOrchestration(*args: Any, **kwargs: Any)[source]
Defines the orchestration details for a Question Answering project target.
- Variables:
project_name (str) – The name of the target project. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ExportedQuestionAnsweringOrchestrationDetails(*args: Any, **kwargs: Any)[source]
Represents the orchestration options for a Question Answering project target.
- Variables:
question_answering_orchestration (ExportedQuestionAnsweringOrchestration) – The Question Answering project details. Required.
target_project_kind (str or QUESTION_ANSWERING) – The kind of the target used in the orchestration flow. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- question_answering_orchestration: _models.ExportedQuestionAnsweringOrchestration
The Question Answering project details. Required.
- class azure.ai.language.conversations.authoring.models.ExportedTrainedModel(*args: Any, **kwargs: Any)[source]
Represents an exported trained model.
- Variables:
exported_model_name (str) – The exported model name. Required.
model_id (str) – The model ID. Required.
last_trained_on (datetime) – The last trained date time of the model. Required.
last_exported_model_on (datetime) – The last exported date time of the model. Required.
model_expired_on (date) – The model expiration date. Required.
model_training_config_version (str) – The model training config version. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ExportedUtteranceEntityLabel(*args: Any, **kwargs: Any)[source]
Represents an entity label for an utterance.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ImportProjectState(*args: Any, **kwargs: Any)[source]
Represents the state of an import job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.IntentEvaluationSummary(*args: Any, **kwargs: Any)[source]
The evaluation summary for an intent.
- Variables:
f1 (float) – Represents the model precision. Required.
precision (float) – Represents the model recall. Required.
recall (float) – Represents the model F1 score. Required.
true_positive_count (int) – Represents the count of true positive. Required.
true_negative_count (int) – Represents the count of true negative. Required.
false_positive_count (int) – Represents the count of false positive. Required.
false_negative_count (int) – Represents the count of false negative. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.IntentsEvaluationSummary(*args: Any, **kwargs: Any)[source]
Represents the evaluation summary for the project’s intents.
- Variables:
confusion_matrix (dict[str, ConfusionMatrixRow]) – Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted. Required.
intents (dict[str, IntentEvaluationSummary]) – Represents the intents evaluation summary. Required.
micro_f1 (float) – Represents the micro F1. Expected value is a float between 0 and 1 inclusive. Required.
micro_precision (float) – Represents the micro precision. Expected value is a float between 0 and 1 inclusive. Required.
micro_recall (float) – Represents the micro recall. Expected value is a float between 0 and 1 inclusive. Required.
macro_f1 (float) – Represents the macro F1. Expected value is a float between 0 and 1 inclusive. Required.
macro_precision (float) – Represents the macro precision. Expected value is a float between 0 and 1 inclusive. Required.
macro_recall (float) – Represents the macro recall. Expected value is a float between 0 and 1 inclusive. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- confusion_matrix: dict[str, _models.ConfusionMatrixRow]
Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted. Required.
- intents: dict[str, _models.IntentEvaluationSummary]
Represents the intents evaluation summary. Required.
- macro_f1: float
Represents the macro F1. Expected value is a float between 0 and 1 inclusive. Required.
- macro_precision: float
Represents the macro precision. Expected value is a float between 0 and 1 inclusive. Required.
- macro_recall: float
Represents the macro recall. Expected value is a float between 0 and 1 inclusive. Required.
- micro_f1: float
Represents the micro F1. Expected value is a float between 0 and 1 inclusive. Required.
- class azure.ai.language.conversations.authoring.models.LoadSnapshotState(*args: Any, **kwargs: Any)[source]
Represents the state of loading a snapshot job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.OperationStatus(*values)[source]
Type of OperationStatus.
- 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.
- 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()
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()
Return True if the string ends with the specified suffix, False otherwise.
- suffix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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()
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)
Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping, /)
Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index()
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 all characters in the string are printable, False otherwise.
A character is printable if repr() may use it in its output.
- 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.
- 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()
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()
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()
Return True if the string starts with the specified prefix, False otherwise.
- prefix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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.
- CANCELLED = 'cancelled'
- CANCELLING = 'cancelling'
- FAILED = 'failed'
- NOT_STARTED = 'notStarted'
- PARTIALLY_COMPLETED = 'partiallyCompleted'
- RUNNING = 'running'
- SUCCEEDED = 'succeeded'
- class azure.ai.language.conversations.authoring.models.OrchestrationExportedIntent(*args: Any, **kwargs: Any)[source]
Represents an exported intent for an orchestration project.
- Variables:
orchestration (ExportedOrchestrationDetails) – Specifies the behavior of this intent in the orchestration flow.
category (str) – The intent category. Required.
description (str) – The intent description.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- orchestration: _models.ExportedOrchestrationDetails | None
Specifies the behavior of this intent in the orchestration flow.
- class azure.ai.language.conversations.authoring.models.OrchestrationExportedProjectAsset(*args: Any, **kwargs: Any)[source]
Represents the assets of an orchestration project.
- Variables:
intents (list[OrchestrationExportedIntent]) – Represents the intents of the project.
utterances (list[OrchestrationExportedUtterance]) – Represents the utterances of the project.
project_kind (str or ORCHESTRATION) – The type of project containing the assets. Required. A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- intents: list[_models.OrchestrationExportedIntent] | None
Represents the intents of the project.
- project_kind: Literal[ProjectKind.ORCHESTRATION]
The type of project containing the assets. Required. A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project.
- utterances: list[_models.OrchestrationExportedUtterance] | None
Represents the utterances of the project.
- class azure.ai.language.conversations.authoring.models.OrchestrationExportedUtterance(*args: Any, **kwargs: Any)[source]
Represents an utterance of an orchestration project.
- Variables:
text (str) – The utterance text. Required.
language (str) – Represents the utterance’s language. This is BCP-47 representation of a language. For example, use “en” for English, “en-gb” for English (UK), “es” for Spanish etc.
intent (str) – The intent of the utterance. Required.
dataset (str) – The dataset for this utterance. Allowed values are ‘Train’ and ‘Test’.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.OrchestrationTargetProjectKind(*values)[source]
Type of OrchestrationTargetProjectKind.
- 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.
- 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()
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()
Return True if the string ends with the specified suffix, False otherwise.
- suffix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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()
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)
Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping, /)
Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index()
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 all characters in the string are printable, False otherwise.
A character is printable if repr() may use it in its output.
- 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.
- 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()
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()
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()
Return True if the string starts with the specified prefix, False otherwise.
- prefix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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.
- CONVERSATION = 'Conversation'
- LUIS = 'Luis'
- QUESTION_ANSWERING = 'QuestionAnswering'
- class azure.ai.language.conversations.authoring.models.PrebuiltEntity(*args: Any, **kwargs: Any)[source]
Represents a supported prebuilt entity.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ProjectDeletionState(*args: Any, **kwargs: Any)[source]
Represents the state of a project deletion job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.ProjectDeployment(*args: Any, **kwargs: Any)[source]
Represents a project deployment.
- Variables:
deployment_name (str) – Represents deployment name. Required.
model_id (str) – Represents deployment modelId. Required.
last_trained_on (datetime) – Represents deployment last trained time. Required.
last_deployed_on (datetime) – Represents deployment last deployed time. Required.
deployment_expired_on (date) – Represents deployment expiration date in the runtime. Required.
model_training_config_version (str) – Represents model training config version. Required.
assigned_resources (list[AssignedProjectResource]) – Represents the metadata of the assigned Azure resources. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- assigned_resources: list[_models.AssignedProjectResource]
Represents the metadata of the assigned Azure resources. Required.
- class azure.ai.language.conversations.authoring.models.ProjectDetails(*args: Any, **kwargs: Any)[source]
Represents the metadata of a project.
- Variables:
created_on (datetime) – Represents the project creation datetime. Required.
last_modified_on (datetime) – Represents the project creation datetime. Required.
last_trained_on (datetime) – Represents the project last trained datetime.
last_deployed_on (datetime) – Represents the project last deployed datetime.
project_kind (str or ProjectKind) – Represents the project kind. Required. Known values are: “Conversation”, “Orchestration”, and “CustomConversationSummarization”.
settings (ProjectSettings) – The project settings.
storage_input_container_name (str) – The storage container name in case of conversation summarization.
project_name (str) – The new project name. Required.
multilingual (bool) – Whether the project would be used for multiple languages or not.
description (str) – The project description.
language (str) – The project language. This is BCP-47 representation of a language. For example, use “en” for English, “en-gb” for English (UK), “es” for Spanish etc. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- language: str
The project language. This is BCP-47 representation of a language. For example, use “en” for English, “en-gb” for English (UK), “es” for Spanish etc. Required.
- project_kind: str | _models.ProjectKind
“Conversation”, “Orchestration”, and “CustomConversationSummarization”.
- Type:
Represents the project kind. Required. Known values are
- settings: _models.ProjectSettings | None
The project settings.
- class azure.ai.language.conversations.authoring.models.ProjectKind(*values)[source]
Type of ProjectKind.
- 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.
- 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()
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()
Return True if the string ends with the specified suffix, False otherwise.
- suffix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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()
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)
Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping, /)
Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index()
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 all characters in the string are printable, False otherwise.
A character is printable if repr() may use it in its output.
- 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.
- 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()
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()
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()
Return True if the string starts with the specified prefix, False otherwise.
- prefix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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.
- CONVERSATION = 'Conversation'
A project to build natural language into apps, bots, and IoT devices.
- CUSTOM_CONVERSATION_SUMMARIZATION = 'CustomConversationSummarization'
A project to build conversation summarization models which are able to summarize long conversations.
- ORCHESTRATION = 'Orchestration'
A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project.
- class azure.ai.language.conversations.authoring.models.ProjectResourceIds(*args: Any, **kwargs: Any)[source]
Represents the payload for deleting a project deployment.
- Variables:
azure_resource_ids (list[str]) – Represents the Language or AIService resource IDs to unassign from the project or delete the deployment from.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ProjectResourcesState(*args: Any, **kwargs: Any)[source]
Represents the state of a project resources job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.ProjectSettings(*args: Any, **kwargs: Any)[source]
Represents the settings used to define the project behavior.
- Variables:
confidence_threshold (float) – The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to “None”. The value of the threshold should be between 0 and 1 inclusive. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ProjectTrainedModel(*args: Any, **kwargs: Any)[source]
Represents a trained model.
- Variables:
label (str) – The trained model label. Required.
model_id (str) – The model ID. Required.
last_trained_on (datetime) – The last trained date time of the model. Required.
last_training_duration_in_seconds (int) – The duration of the model’s last training request in seconds. Required.
model_expired_on (date) – The model expiration date. Required.
model_training_config_version (str) – The model training config version. Required.
has_snapshot (bool) – The flag to indicate if the trained model has a snapshot ready. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.ResourceMetadata(*args: Any, **kwargs: Any)[source]
Represents metadata for the Azure resource..
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.StringIndexType(*values)[source]
Type of StringIndexType.
- 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.
- 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()
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()
Return True if the string ends with the specified suffix, False otherwise.
- suffix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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()
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)
Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping, /)
Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index()
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 all characters in the string are printable, False otherwise.
A character is printable if repr() may use it in its output.
- 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.
- 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()
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()
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()
Return True if the string starts with the specified prefix, False otherwise.
- prefix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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.
- UTF16_CODE_UNIT = 'Utf16CodeUnit'
The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript.
- UTF32_CODE_UNIT = 'Utf32CodeUnit'
- UTF8_CODE_UNIT = 'Utf8CodeUnit'
- class azure.ai.language.conversations.authoring.models.SubTrainingState(*args: Any, **kwargs: Any)[source]
Represents the detailed state of a training sub-operation.
- Variables:
percent_complete (int) – Represents progress percentage. Required.
started_on (datetime) – Represents the start date time.
ended_on (datetime) – Represents the end date time.
status (str or OperationStatus) – Represents the status of the sub-operation. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.SupportedLanguage(*args: Any, **kwargs: Any)[source]
Represents a supported language.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.SwapDeploymentsDetails(*args: Any, **kwargs: Any)[source]
Represents the options for swapping two deployments together.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.SwapDeploymentsState(*args: Any, **kwargs: Any)[source]
Represents the state of a deployment job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.TrainingConfigVersion(*args: Any, **kwargs: Any)[source]
Represents a training config version.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.TrainingJobDetails(*args: Any, **kwargs: Any)[source]
Represents the options for starting a new training job.
- Variables:
model_label (str) – Represents the output model label. Required.
training_config_version (str) – Represents training config version. By default, “latest” value is used which uses the latest released training config version.
training_mode (str or TrainingMode) – Represents the mode of the training operation. Required. Known values are: “advanced” and “standard”.
evaluation_options (EvaluationDetails) – Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.
data_generation_settings (DataGenerationSettings) – For customers to populate if they wish to use data generation for their model training job.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- data_generation_settings: _models.DataGenerationSettings | None
For customers to populate if they wish to use data generation for their model training job.
- evaluation_options: _models.EvaluationDetails | None
Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.
- class azure.ai.language.conversations.authoring.models.TrainingJobResult(*args: Any, **kwargs: Any)[source]
Represents the output of a training job.
- Variables:
model_label (str) – Represents trained model label. Required.
training_config_version (str) – Represents training config version. Required.
training_mode (str or TrainingMode) – Represents the mode of the training operation. Known values are: “advanced” and “standard”.
training_status (SubTrainingState) – Represents the model training status. Required.
data_generation_status (SubTrainingState) – Represents the model data generation status. Required.
evaluation_status (SubTrainingState) – Represents model evaluation status.
estimated_end_on (datetime) – Represents the estimated end date time for training and evaluation.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- data_generation_status: _models.SubTrainingState
Represents the model data generation status. Required.
- estimated_end_on: datetime | None
Represents the estimated end date time for training and evaluation.
- evaluation_status: _models.SubTrainingState | None
Represents model evaluation status.
- training_mode: str | _models.TrainingMode | None
“advanced” and “standard”.
- Type:
Represents the mode of the training operation. Known values are
- training_status: _models.SubTrainingState
Represents the model training status. Required.
- class azure.ai.language.conversations.authoring.models.TrainingMode(*values)[source]
Type of TrainingMode.
- 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.
- 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()
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()
Return True if the string ends with the specified suffix, False otherwise.
- suffix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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()
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)
Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping, /)
Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index()
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 all characters in the string are printable, False otherwise.
A character is printable if repr() may use it in its output.
- 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.
- 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()
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()
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()
Return True if the string starts with the specified prefix, False otherwise.
- prefix
A string or a tuple of strings to try.
- start
Optional start position. Default: start of the string.
- end
Optional stop position. Default: end of the string.
- 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.
- ADVANCED = 'advanced'
Trains using fine-tuned neural network transformer models. Can train multilingual projects.
- STANDARD = 'standard'
Faster training times for quicker iterations.
- class azure.ai.language.conversations.authoring.models.TrainingState(*args: Any, **kwargs: Any)[source]
Represents the state of a training job.
- Variables:
job_id (str) – The job ID. Required.
created_on (datetime) – The creation date time of the job. Required.
last_updated_on (datetime) – The last date time the job was updated. Required.
expires_on (datetime) – The expiration date time of the job.
status (str or OperationStatus) – The job status. Required. Known values are: “notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
warnings (list[ODataV4Format]) – The warnings that were encountered while executing the job.
errors (list[ODataV4Format]) – The errors encountered while executing the job.
result (TrainingJobResult) – Represents training tasks detailed result. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- errors: list[ODataV4Format] | None
The errors encountered while executing the job.
- result: _models.TrainingJobResult
Represents training tasks detailed result. Required.
- status: str | _models.OperationStatus
“notStarted”, “running”, “succeeded”, “failed”, “cancelled”, “cancelling”, and “partiallyCompleted”.
- Type:
The job status. Required. Known values are
- warnings: list[ODataV4Format] | None
The warnings that were encountered while executing the job.
- class azure.ai.language.conversations.authoring.models.UtteranceEntitiesEvaluationResult(*args: Any, **kwargs: Any)[source]
Represents the comparison between the expected and predicted entities for an utterance.
- Variables:
expected_entities (list[UtteranceEntityEvaluationResult]) – Represents the expected entity labels. Required.
predicted_entities (list[UtteranceEntityEvaluationResult]) – Represents the predicted entity labels. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- expected_entities: list[_models.UtteranceEntityEvaluationResult]
Represents the expected entity labels. Required.
- predicted_entities: list[_models.UtteranceEntityEvaluationResult]
Represents the predicted entity labels. Required.
- class azure.ai.language.conversations.authoring.models.UtteranceEntityEvaluationResult(*args: Any, **kwargs: Any)[source]
Represents the evaluation output of an entity label or prediction.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- class azure.ai.language.conversations.authoring.models.UtteranceEvaluationResult(*args: Any, **kwargs: Any)[source]
Represents the evaluation result for an utterance.
- Variables:
text (str) – Represents the utterance text. Required.
language (str) – Represents the utterance language. This is BCP-47 representation of a language. For example, use “en” for English, “en-gb” for English (UK), “es” for Spanish etc. Required.
entities_result (UtteranceEntitiesEvaluationResult) – Represents the entities results for the utterance. Required.
intents_result (UtteranceIntentsEvaluationResult) – Represents the intents results for the utterance. Required.
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type:
- entities_result: _models.UtteranceEntitiesEvaluationResult
Represents the entities results for the utterance. Required.
- intents_result: _models.UtteranceIntentsEvaluationResult
Represents the intents results for the utterance. Required.
- class azure.ai.language.conversations.authoring.models.UtteranceIntentsEvaluationResult(*args: Any, **kwargs: Any)[source]
Represents the comparison between the expected and the predicted intent for an utterance.
- Variables:
- as_dict(*, exclude_readonly: bool = False) → dict[str, Any]
Return a dict that can be turned into json using json.dump.
- copy() → Model
- get(key: str, default: Any = None) → Any
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
- pop(key: str, default: ~typing.Any = <object object>) → Any
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
- popitem() → tuple[str, Any]
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
- setdefault(key: str, default: ~typing.Any = <object object>) → Any
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
- update(*args: Any, **kwargs: Any) → None
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
- values() → ValuesView[Any]
- Returns:
an object providing a view on D’s values
- Return type: