Share via

DocumentTranslationFileFormat Class

File Format.

Constructor

DocumentTranslationFileFormat(*args: Any, **kwargs: Any)

Variables

Name Description
file_format
str

Name of the format. Required.
file_extensions
list[str]

Supported file extension for this format. Required.
content_types
list[str]

Supported Content-Types for this format. Required.
default_format_version
str

Default version if none is specified.
format_versions
list[str]

Supported Version.
type
str or FileFormatType

Supported Type for this format. Known values are: "document" and "glossary".

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be turned into json using json.dump.

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

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear 

clear() -> None

copy 

copy() -> Model

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

keys 

keys() -> KeysView[str]

pop 

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem 

popitem() -> Tuple[str, Any]

setdefault 

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Attributes

content_types

Supported Content-Types for this format. Required.

content_types: List[str]

default_format_version

Default version if none is specified.

default_format_version: str | None

file_extensions

Supported file extension for this format. Required.

file_extensions: List[str]

file_format

Name of the format. Required.

file_format: str

format_versions

Supported Version.

format_versions: List[str] | None

type

"document" and "glossary".

type: str | _models.FileFormatType | None