annofabapi.pydantic_models package#

Submodules#

annofabapi.pydantic_models.accept_organization_invitation_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.accept_organization_invitation_request.AcceptOrganizationInvitationRequest(*, token: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AcceptOrganizationInvitationRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AcceptOrganizationInvitationRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

token: StrictStr#

annofabapi.pydantic_models.account module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.account.Account(*, account_id: Annotated[str, Strict(strict=True)], user_id: Annotated[str, Strict(strict=True)], username: Annotated[str, Strict(strict=True)], email: Annotated[str, Strict(strict=True)], lang: Lang, biography: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=0), MaxLen(max_length=100)])] | None = None, keylayout: KeyLayout, authority: Annotated[str, Strict(strict=True)], account_type: Annotated[str, Strict(strict=True)], updated_datetime: str)[source]#

Bases: BaseModel

account_id: StrictStr#

account_type: StrictStr#

classmethod account_type_validate_enum(value)[source]#: Validates the enum

authority: StrictStr#

biography: Annotated[str, Field(min_length=0, strict=True, max_length=100)] | None#

email: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Account from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Account from a JSON string

keylayout: KeyLayout#

lang: Lang#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

user_id: StrictStr#

username: StrictStr#

annofabapi.pydantic_models.account_worktime_statistics module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.account_worktime_statistics.AccountWorktimeStatistics(*, account_id: Annotated[str, Strict(strict=True)], by_tasks: List[WorktimeStatisticsItem], by_inputs: List[WorktimeStatisticsItem], by_minutes: List[WorktimeStatisticsItem])[source]#

Bases: BaseModel

account_id: StrictStr#

by_inputs: List[WorktimeStatisticsItem]#

by_minutes: List[WorktimeStatisticsItem]#

by_tasks: List[WorktimeStatisticsItem]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AccountWorktimeStatistics from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AccountWorktimeStatistics from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.action_required module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.action_required.ActionRequired(*, inspection: Inspection, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

対応が必要な検査コメントが残っている時のエラー

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ActionRequired from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ActionRequired from a JSON string

inspection: Inspection#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.additional_data_default_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_default_type.AdditionalDataDefaultType(*args, oneof_schema_1_validator: Annotated[bool, Strict(strict=True)] | None = None, oneof_schema_2_validator: Annotated[int, Strict(strict=True)] | None = None, oneof_schema_3_validator: Annotated[str, Strict(strict=True)] | None = None, actual_instance: bool | int | str | None = None, one_of_schemas: Set[str] = {'bool', 'int', 'str'})[source]#

Bases: BaseModel

属性の初期値です。初期値を設定する場合、属性の種類に応じて次の値を指定してください。属性の種類に対して有効でない初期値を指定した場合、その初期値は無視されます。 |属性の種類（`type`） | 指定できる初期値| |-----------------|———-| | flag | 真偽値(true or false)| | integer | 整数値 | | text | 文字列 | | comment | 文字列| | choice | 選択肢(choices)の choice_id | | select | 選択肢(choices)の`choice_id`| 属性の種類が`tracking`または`link`の場合、初期値を設定できません。初期値を設定しない場合は、nullまたは空文字を指定してください。

actual_instance: bool | int | str | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: StrictBool | None#

oneof_schema_2_validator: StrictInt | None#

oneof_schema_3_validator: StrictStr | None#

to_dict() → Dict[str, Any] | bool | int | str | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.additional_data_definition_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_definition_type.AdditionalDataDefinitionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

属性の種類 * flag - 真偽値 * integer - 整数値 * text - 自由記述（1行） * comment - 自由記述（複数行） * choice - 選択肢（ラジオボタン式） * select - 選択肢（ドロップダウン式） * tracking - トラッキングID * link - アノテーションリンク

CHOICE = 'choice'#

COMMENT = 'comment'#

FLAG = 'flag'#

INTEGER = 'integer'#

LINK = 'link'#

SELECT = 'select'#

TEXT = 'text'#

TRACKING = 'tracking'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of AdditionalDataDefinitionType from a JSON string

annofabapi.pydantic_models.additional_data_definition_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_definition_v1.AdditionalDataDefinitionV1(*, additional_data_definition_id: Annotated[str, Strict(strict=True)], read_only: Annotated[bool, Strict(strict=True)] | None = False, name: InternationalizationMessage | None = None, default: AdditionalDataDefaultType | None = None, keybind: List[Keybind] | None = None, type: AdditionalDataDefinitionType, choices: List[AdditionalDataDefinitionV1ChoicesInner] | None = None, regex: Annotated[str, Strict(strict=True)] | None = None, label_ids: List[Annotated[str, Strict(strict=True)]] | None = None, required: Annotated[bool, Strict(strict=True)] | None = None, metadata: Dict[str, Annotated[str, Strict(strict=True)]] | None = None)[source]#

Bases: BaseModel

additional_data_definition_id: StrictStr#

choices: List[AdditionalDataDefinitionV1ChoicesInner] | None#

default: AdditionalDataDefaultType | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataDefinitionV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataDefinitionV1 from a JSON string

keybind: List[Keybind] | None#

label_ids: List[StrictStr] | None#

metadata: Dict[str, StrictStr] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: InternationalizationMessage | None#

read_only: StrictBool | None#

regex: StrictStr | None#

required: StrictBool | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: AdditionalDataDefinitionType#

annofabapi.pydantic_models.additional_data_definition_v1_choices_inner module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_definition_v1_choices_inner.AdditionalDataDefinitionV1ChoicesInner(*, choice_id: Annotated[str, Strict(strict=True)], name: InternationalizationMessage, keybind: List[Keybind] | None = None)[source]#

Bases: BaseModel

choice_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataDefinitionV1ChoicesInner from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataDefinitionV1ChoicesInner from a JSON string

keybind: List[Keybind] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: InternationalizationMessage#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.additional_data_definition_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_definition_v2.AdditionalDataDefinitionV2(*, additional_data_definition_id: Annotated[str, Strict(strict=True)], read_only: Annotated[bool, Strict(strict=True)] | None = False, name: InternationalizationMessage, default: AdditionalDataDefaultType | None = None, keybind: List[Keybind] | None = None, type: AdditionalDataDefinitionType, choices: List[AdditionalDataDefinitionV1ChoicesInner] | None = None, metadata: Dict[str, Annotated[str, Strict(strict=True)]] | None = None)[source]#

Bases: BaseModel

additional_data_definition_id: StrictStr#

choices: List[AdditionalDataDefinitionV1ChoicesInner] | None#

default: AdditionalDataDefaultType | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataDefinitionV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataDefinitionV2 from a JSON string

keybind: List[Keybind] | None#

metadata: Dict[str, StrictStr] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: InternationalizationMessage#

read_only: StrictBool | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: AdditionalDataDefinitionType#

annofabapi.pydantic_models.additional_data_restriction module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_restriction.AdditionalDataRestriction(*, additional_data_definition_id: Annotated[str, Strict(strict=True)], condition: AdditionalDataRestrictionCondition)[source]#

Bases: BaseModel

additional_data_definition_id: StrictStr#

condition: AdditionalDataRestrictionCondition#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataRestriction from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataRestriction from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.additional_data_restriction_condition module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_restriction_condition.AdditionalDataRestrictionCondition(*args, oneof_schema_1_validator: AdditionalDataRestrictionConditionCanInput | None = None, oneof_schema_2_validator: AdditionalDataRestrictionConditionEquals | None = None, oneof_schema_3_validator: AdditionalDataRestrictionConditionNotEquals | None = None, oneof_schema_4_validator: AdditionalDataRestrictionConditionMatches | None = None, oneof_schema_5_validator: AdditionalDataRestrictionConditionNotMatches | None = None, oneof_schema_6_validator: AdditionalDataRestrictionConditionHasLabel | None = None, oneof_schema_7_validator: AdditionalDataRestrictionConditionImply | None = None, actual_instance: AdditionalDataRestrictionConditionCanInput | AdditionalDataRestrictionConditionEquals | AdditionalDataRestrictionConditionHasLabel | AdditionalDataRestrictionConditionImply | AdditionalDataRestrictionConditionMatches | AdditionalDataRestrictionConditionNotEquals | AdditionalDataRestrictionConditionNotMatches | None = None, one_of_schemas: Set[str] = {'AdditionalDataRestrictionConditionCanInput', 'AdditionalDataRestrictionConditionEquals', 'AdditionalDataRestrictionConditionHasLabel', 'AdditionalDataRestrictionConditionImply', 'AdditionalDataRestrictionConditionMatches', 'AdditionalDataRestrictionConditionNotEquals', 'AdditionalDataRestrictionConditionNotMatches'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

属性の制約 * AdditionalDataRestrictionConditionCanInput: 属性値の入力を許可するかどうか * AdditionalDataRestrictionConditionEquals: 指定した値に等しい * AdditionalDataRestrictionConditionNotEquals: 指定した値に等しくない * AdditionalDataRestrictionConditionMatches: 指定した正規表現に一致する * AdditionalDataDefinitionType`が`text`か`comment`のときのみ利用可能 * `AdditionalDataRestrictionConditionNotMatches: 指定した正規表現に一致しない * AdditionalDataDefinitionType`が`text`か`comment`のときのみ利用可能 * `AdditionalDataRestrictionConditionHasLabel: 指定したラベルIDに一致する（アノテーションリンク属性限定） * AdditionalDataDefinitionType`が`link`のときのみ利用可能 * `AdditionalDataRestrictionConditionImply: 指定した前提条件を満たすときのみ、制約を満たすかどうか以下のJSONは、「属性IDが`attr2`の属性値が`true`ならば、属性IDが`attr1`の属性値は`choice1`である」という制約を表しています。 ` { "additional_data_definition_id": "attr1", "condition": { "_type": "Imply", "premise": { "additional_data_definition_id": "attr2", "condition": { "_type": "Equals", "value": "true" } }, "condition": { "_type": "Equals", "value": "choice1" } } } `

actual_instance: AdditionalDataRestrictionConditionCanInput | AdditionalDataRestrictionConditionEquals | AdditionalDataRestrictionConditionHasLabel | AdditionalDataRestrictionConditionImply | AdditionalDataRestrictionConditionMatches | AdditionalDataRestrictionConditionNotEquals | AdditionalDataRestrictionConditionNotMatches | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AdditionalDataRestrictionConditionCanInput | None#

oneof_schema_2_validator: AdditionalDataRestrictionConditionEquals | None#

oneof_schema_3_validator: AdditionalDataRestrictionConditionNotEquals | None#

oneof_schema_4_validator: AdditionalDataRestrictionConditionMatches | None#

oneof_schema_5_validator: AdditionalDataRestrictionConditionNotMatches | None#

oneof_schema_6_validator: AdditionalDataRestrictionConditionHasLabel | None#

oneof_schema_7_validator: AdditionalDataRestrictionConditionImply | None#

to_dict() → Dict[str, Any] | AdditionalDataRestrictionConditionCanInput | AdditionalDataRestrictionConditionEquals | AdditionalDataRestrictionConditionHasLabel | AdditionalDataRestrictionConditionImply | AdditionalDataRestrictionConditionMatches | AdditionalDataRestrictionConditionNotEquals | AdditionalDataRestrictionConditionNotMatches | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.additional_data_restriction_condition_can_input module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_restriction_condition_can_input.AdditionalDataRestrictionConditionCanInput(*, _type: Annotated[str, Strict(strict=True)], enable: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

enable: StrictBool#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionCanInput from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionCanInput from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.additional_data_restriction_condition_equals module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_restriction_condition_equals.AdditionalDataRestrictionConditionEquals(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionEquals from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionEquals from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

value: StrictStr#

annofabapi.pydantic_models.additional_data_restriction_condition_has_label module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_restriction_condition_has_label.AdditionalDataRestrictionConditionHasLabel(*, _type: Annotated[str, Strict(strict=True)], labels: List[Annotated[str, Strict(strict=True)]])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionHasLabel from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionHasLabel from a JSON string

labels: List[StrictStr]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.additional_data_restriction_condition_imply module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_restriction_condition_imply.AdditionalDataRestrictionConditionImply(*, _type: Annotated[str, Strict(strict=True)], premise: AdditionalDataRestriction, condition: AdditionalDataRestrictionCondition)[source]#

Bases: BaseModel

condition: AdditionalDataRestrictionCondition#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionImply from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionImply from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

premise: AdditionalDataRestriction#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.additional_data_restriction_condition_matches module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_restriction_condition_matches.AdditionalDataRestrictionConditionMatches(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionMatches from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionMatches from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

value: StrictStr#

annofabapi.pydantic_models.additional_data_restriction_condition_not_equals module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_restriction_condition_not_equals.AdditionalDataRestrictionConditionNotEquals(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionNotEquals from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionNotEquals from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

value: StrictStr#

annofabapi.pydantic_models.additional_data_restriction_condition_not_matches module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_restriction_condition_not_matches.AdditionalDataRestrictionConditionNotMatches(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionNotMatches from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataRestrictionConditionNotMatches from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

value: StrictStr#

annofabapi.pydantic_models.additional_data_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_v1.AdditionalDataV1(*, additional_data_definition_id: Annotated[str, Strict(strict=True)], flag: Annotated[bool, Strict(strict=True)] | None = None, integer: Annotated[int, Strict(strict=True)] | None = None, comment: Annotated[str, Strict(strict=True)] | None = None, choice: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

additional_data_definition_id: StrictStr#

choice: StrictStr | None#

comment: StrictStr | None#

flag: StrictBool | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataV1 from a JSON string

integer: StrictInt | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.additional_data_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_v2.AdditionalDataV2(*, definition_id: Annotated[str, Strict(strict=True)], value: AdditionalDataValue | None = None)[source]#

Bases: BaseModel

definition_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataV2 from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

value: AdditionalDataValue | None#

annofabapi.pydantic_models.additional_data_value module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_value.AdditionalDataValue(*args, oneof_schema_1_validator: AdditionalDataValueFlag | None = None, oneof_schema_2_validator: AdditionalDataValueInteger | None = None, oneof_schema_3_validator: AdditionalDataValueComment | None = None, oneof_schema_4_validator: AdditionalDataValueText | None = None, oneof_schema_5_validator: AdditionalDataValueChoice | None = None, oneof_schema_6_validator: AdditionalDataValueSelect | None = None, oneof_schema_7_validator: AdditionalDataValueTracking | None = None, oneof_schema_8_validator: AdditionalDataValueLink | None = None, actual_instance: AdditionalDataValueChoice | AdditionalDataValueComment | AdditionalDataValueFlag | AdditionalDataValueInteger | AdditionalDataValueLink | AdditionalDataValueSelect | AdditionalDataValueText | AdditionalDataValueTracking | None = None, one_of_schemas: Set[str] = {'AdditionalDataValueChoice', 'AdditionalDataValueComment', 'AdditionalDataValueFlag', 'AdditionalDataValueInteger', 'AdditionalDataValueLink', 'AdditionalDataValueSelect', 'AdditionalDataValueText', 'AdditionalDataValueTracking'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

属性値

actual_instance: AdditionalDataValueChoice | AdditionalDataValueComment | AdditionalDataValueFlag | AdditionalDataValueInteger | AdditionalDataValueLink | AdditionalDataValueSelect | AdditionalDataValueText | AdditionalDataValueTracking | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AdditionalDataValueFlag | None#

oneof_schema_2_validator: AdditionalDataValueInteger | None#

oneof_schema_3_validator: AdditionalDataValueComment | None#

oneof_schema_4_validator: AdditionalDataValueText | None#

oneof_schema_5_validator: AdditionalDataValueChoice | None#

oneof_schema_6_validator: AdditionalDataValueSelect | None#

oneof_schema_7_validator: AdditionalDataValueTracking | None#

oneof_schema_8_validator: AdditionalDataValueLink | None#

to_dict() → Dict[str, Any] | AdditionalDataValueChoice | AdditionalDataValueComment | AdditionalDataValueFlag | AdditionalDataValueInteger | AdditionalDataValueLink | AdditionalDataValueSelect | AdditionalDataValueText | AdditionalDataValueTracking | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.additional_data_value_choice module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_value_choice.AdditionalDataValueChoice(*, _type: Annotated[str, Strict(strict=True)], choice_id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

choice_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataValueChoice from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataValueChoice from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.additional_data_value_comment module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_value_comment.AdditionalDataValueComment(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataValueComment from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataValueComment from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

value: StrictStr#

annofabapi.pydantic_models.additional_data_value_flag module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_value_flag.AdditionalDataValueFlag(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataValueFlag from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataValueFlag from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

value: StrictBool#

annofabapi.pydantic_models.additional_data_value_integer module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_value_integer.AdditionalDataValueInteger(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataValueInteger from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataValueInteger from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

value: StrictInt#

annofabapi.pydantic_models.additional_data_value_link module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_value_link.AdditionalDataValueLink(*, _type: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataValueLink from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataValueLink from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.additional_data_value_select module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_value_select.AdditionalDataValueSelect(*, _type: Annotated[str, Strict(strict=True)], choice_id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

choice_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataValueSelect from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataValueSelect from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.additional_data_value_text module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_value_text.AdditionalDataValueText(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataValueText from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataValueText from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

value: StrictStr#

annofabapi.pydantic_models.additional_data_value_tracking module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.additional_data_value_tracking.AdditionalDataValueTracking(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AdditionalDataValueTracking from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AdditionalDataValueTracking from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

value: StrictStr#

annofabapi.pydantic_models.aggregation_result module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.aggregation_result.AggregationResult(*args, oneof_schema_1_validator: CountResult | None = None, actual_instance: CountResult | None = None, one_of_schemas: Set[str] = {'CountResult'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: CountResult | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: CountResult | None#

to_dict() → Dict[str, Any] | CountResult | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.all_oidc_endpoints module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.all_oidc_endpoints.AllOidcEndpoints(*, _type: Annotated[str, Strict(strict=True)], issuer: Annotated[str, Strict(strict=True)], authorize_url: Annotated[str, Strict(strict=True)], token_url: Annotated[str, Strict(strict=True)], userinfo_url: Annotated[str, Strict(strict=True)], jwks_url: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

OIDCエンドポイント

authorize_url: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AllOidcEndpoints from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AllOidcEndpoints from a JSON string

issuer: StrictStr#

jwks_url: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

token_url: StrictStr#

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

userinfo_url: StrictStr#

annofabapi.pydantic_models.annotation_data_holding_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_data_holding_type.AnnotationDataHoldingType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

アノテーションのデータがどこに保持されるか * inner - アノテーションのデータ部をJSON内部に保持します。 * outer - アノテーションのデータ部を外部ファイルの形式（画像など）で保持します

INNER = 'inner'#

OUTER = 'outer'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of AnnotationDataHoldingType from a JSON string

annofabapi.pydantic_models.annotation_data_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_data_v1.AnnotationDataV1(*args, oneof_schema_1_validator: Annotated[str, Strict(strict=True)] | None = None, oneof_schema_2_validator: FullAnnotationData | None = None, actual_instance: FullAnnotationData | str | None = None, one_of_schemas: Set[str] = {'FullAnnotationData', 'str'})[source]#

Bases: BaseModel

アノテーションの座標値や区間などのデータ。 APIのレスポンスから参照される場合は、`FullAnnotationDataString`形式です。 [putAnnotation](#operation/putAnnotation) APIのリクエストボディは、`FullAnnotationDataString`形式または`FullAnnotationData`形式に対応しています。

actual_instance: FullAnnotationData | str | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: StrictStr | None#

oneof_schema_2_validator: FullAnnotationData | None#

to_dict() → Dict[str, Any] | FullAnnotationData | str | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_detail_content_input module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_content_input.AnnotationDetailContentInput(*args, oneof_schema_1_validator: AnnotationDetailContentInputInner | None = None, oneof_schema_2_validator: AnnotationDetailContentInputOuter | None = None, actual_instance: AnnotationDetailContentInputInner | AnnotationDetailContentInputOuter | None = None, one_of_schemas: Set[str] = {'AnnotationDetailContentInputInner', 'AnnotationDetailContentInputOuter'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

AnnotationDetailContentInputInner - アノテーションのデータ部をJSON内部に保持する場合、この型を利用します - AnnotationDetailContentInputOuter - アノテーションのデータ部を外部ファイルの形式（画像など）で保持する場合、この型を利用します

actual_instance: AnnotationDetailContentInputInner | AnnotationDetailContentInputOuter | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AnnotationDetailContentInputInner | None#

oneof_schema_2_validator: AnnotationDetailContentInputOuter | None#

to_dict() → Dict[str, Any] | AnnotationDetailContentInputInner | AnnotationDetailContentInputOuter | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_detail_content_input_inner module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_content_input_inner.AnnotationDetailContentInputInner(*, _type: Annotated[str, Strict(strict=True)], data: FullAnnotationData)[source]#

Bases: BaseModel

アノテーションのデータ部をJSON内部に保持します

data: FullAnnotationData#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailContentInputInner from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailContentInputInner from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_detail_content_input_outer module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_content_input_outer.AnnotationDetailContentInputOuter(*, _type: Annotated[str, Strict(strict=True)], path: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

アノテーションのデータ部を外部ファイルの形式（画像など）で保持します

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailContentInputOuter from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailContentInputOuter from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

path: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_detail_content_output module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_content_output.AnnotationDetailContentOutput(*args, oneof_schema_1_validator: AnnotationDetailContentOutputInner | None = None, oneof_schema_2_validator: AnnotationDetailContentOutputInnerUnknown | None = None, oneof_schema_3_validator: AnnotationDetailContentOutputOuter | None = None, oneof_schema_4_validator: AnnotationDetailContentOutputOuterUnresolved | None = None, actual_instance: AnnotationDetailContentOutputInner | AnnotationDetailContentOutputInnerUnknown | AnnotationDetailContentOutputOuter | AnnotationDetailContentOutputOuterUnresolved | None = None, one_of_schemas: Set[str] = {'AnnotationDetailContentOutputInner', 'AnnotationDetailContentOutputInnerUnknown', 'AnnotationDetailContentOutputOuter', 'AnnotationDetailContentOutputOuterUnresolved'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

AnnotationDetailContentOutputInner - アノテーションのデータ部をJSON内部に保持している場合、通常はこの型の値となります - AnnotationDetailContentOutputInnerUnknown - アノテーションのデータ部をJSON内部に保持しており、且つ、AnnotationDetailV1の形式で保存されていたデータのAnnotationTypeが特定できない場合にこの値となります - 典型的な例では、アノテーションの保存後にアノテーション仕様が書き換わっていた場合が該当します - AnnotationDetailContentOutputOuter - アノテーションのデータ部を外部ファイルの形式（画像など）で保持している場合、通常はこの型の値となります - AnnotationDetailContentOutputOuterUnresolved - アノテーションのデータ部を外部ファイルの形式（画像など）で保持しており、且つ、Outerのurl / etagを解決しなかった場合（過去のアノテーションを取得した場合等）にこの値となります

actual_instance: AnnotationDetailContentOutputInner | AnnotationDetailContentOutputInnerUnknown | AnnotationDetailContentOutputOuter | AnnotationDetailContentOutputOuterUnresolved | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AnnotationDetailContentOutputInner | None#

oneof_schema_2_validator: AnnotationDetailContentOutputInnerUnknown | None#

oneof_schema_3_validator: AnnotationDetailContentOutputOuter | None#

oneof_schema_4_validator: AnnotationDetailContentOutputOuterUnresolved | None#

to_dict() → Dict[str, Any] | AnnotationDetailContentOutputInner | AnnotationDetailContentOutputInnerUnknown | AnnotationDetailContentOutputOuter | AnnotationDetailContentOutputOuterUnresolved | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_detail_content_output_inner module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_content_output_inner.AnnotationDetailContentOutputInner(*, _type: Annotated[str, Strict(strict=True)], data: FullAnnotationData)[source]#

Bases: BaseModel

アノテーションのデータ部をJSON内部に保持します

data: FullAnnotationData#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailContentOutputInner from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailContentOutputInner from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_detail_content_output_inner_unknown module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_content_output_inner_unknown.AnnotationDetailContentOutputInnerUnknown(*, _type: Annotated[str, Strict(strict=True)], data: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

アノテーションのデータ部をJSON内部に保持します。 AnnotationDetailV1の形式で保存されていたデータのAnnotationTypeが特定できない場合にこの値となります。典型的な例では、アノテーションの保存後にアノテーション仕様が書き換わっていた場合が該当します。

data: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailContentOutputInnerUnknown from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailContentOutputInnerUnknown from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_detail_content_output_outer module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_content_output_outer.AnnotationDetailContentOutputOuter(*, _type: Annotated[str, Strict(strict=True)], url: Annotated[str, Strict(strict=True)], etag: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

アノテーションのデータ部を外部ファイルの形式（画像など）で保持します

etag: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailContentOutputOuter from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailContentOutputOuter from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

url: StrictStr#

annofabapi.pydantic_models.annotation_detail_content_output_outer_unresolved module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_content_output_outer_unresolved.AnnotationDetailContentOutputOuterUnresolved(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

アノテーションのデータ部を外部ファイルの形式（画像など）で保持します。 Outerのurl / etagを解決しなかった場合（過去のアノテーションを取得した場合等）にこの値となります。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailContentOutputOuterUnresolved from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailContentOutputOuterUnresolved from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_detail_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_v1.AnnotationDetailV1(*, annotation_id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], label_id: Annotated[str, Strict(strict=True)], is_protected: Annotated[bool, Strict(strict=True)], data_holding_type: AnnotationDataHoldingType, data: AnnotationDataV1 | None = None, path: Annotated[str, Strict(strict=True)] | None = None, etag: Annotated[str, Strict(strict=True)] | None = None, url: Annotated[str, Strict(strict=True)] | None = None, additional_data_list: List[AdditionalDataV1], created_datetime: str | None = None, updated_datetime: str | None = None)[source]#

Bases: BaseModel

account_id: StrictStr#

additional_data_list: List[AdditionalDataV1]#

annotation_id: StrictStr#

created_datetime: str | None#

data: AnnotationDataV1 | None#

data_holding_type: AnnotationDataHoldingType#

etag: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailV1 from a JSON string

is_protected: StrictBool#

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

path: StrictStr | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

url: StrictStr | None#

annofabapi.pydantic_models.annotation_detail_v2_create module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_v2_create.AnnotationDetailV2Create(*, _type: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], label_id: Annotated[str, Strict(strict=True)], body: AnnotationDetailContentInput, additional_data_list: List[AdditionalDataV2], editor_props: AnnotationPropsForEditor)[source]#

Bases: BaseModel

新規にアノテーションを作成する場合にこの型を利用します。

additional_data_list: List[AdditionalDataV2]#

annotation_id: StrictStr#

body: AnnotationDetailContentInput#

editor_props: AnnotationPropsForEditor#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailV2Create from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailV2Create from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_detail_v2_get module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_v2_get.AnnotationDetailV2Get(*, _type: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], label_id: Annotated[str, Strict(strict=True)], body: AnnotationDetailContentOutput, additional_data_list: List[AdditionalDataV2], editor_props: AnnotationPropsForEditor, created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

account_id: StrictStr#

additional_data_list: List[AdditionalDataV2]#

annotation_id: StrictStr#

body: AnnotationDetailContentOutput#

created_datetime: str#

editor_props: AnnotationPropsForEditor#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailV2Get from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailV2Get from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

updated_datetime: str#

annofabapi.pydantic_models.annotation_detail_v2_import module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_v2_import.AnnotationDetailV2Import(*, _type: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], label_id: Annotated[str, Strict(strict=True)], body: AnnotationDetailContentInput, additional_data_list: List[AdditionalDataV2], editor_props: AnnotationPropsForEditor, created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

過去にAnnofab内外で作成したアノテーションをそのままインポートする場合にこの型を利用します。

account_id: StrictStr#

additional_data_list: List[AdditionalDataV2]#

annotation_id: StrictStr#

body: AnnotationDetailContentInput#

created_datetime: str#

editor_props: AnnotationPropsForEditor#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailV2Import from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailV2Import from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

updated_datetime: str#

annofabapi.pydantic_models.annotation_detail_v2_input module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_v2_input.AnnotationDetailV2Input(*args, oneof_schema_1_validator: AnnotationDetailV2Create | None = None, oneof_schema_2_validator: AnnotationDetailV2Import | None = None, oneof_schema_3_validator: AnnotationDetailV2Update | None = None, actual_instance: AnnotationDetailV2Create | AnnotationDetailV2Import | AnnotationDetailV2Update | None = None, one_of_schemas: Set[str] = {'AnnotationDetailV2Create', 'AnnotationDetailV2Import', 'AnnotationDetailV2Update'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

AnnotationDetailV2Create - 新規にアノテーションを作成する場合にこの型を利用します。 - AnnotationDetailV2Import - 過去にAnnofab内外で作成したアノテーションをそのままインポートする場合にこの型を利用します。 - AnnotationDetailV2Update - 既に存在するアノテーションを更新する場合にこの型を利用します

actual_instance: AnnotationDetailV2Create | AnnotationDetailV2Import | AnnotationDetailV2Update | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AnnotationDetailV2Create | None#

oneof_schema_2_validator: AnnotationDetailV2Import | None#

oneof_schema_3_validator: AnnotationDetailV2Update | None#

to_dict() → Dict[str, Any] | AnnotationDetailV2Create | AnnotationDetailV2Import | AnnotationDetailV2Update | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_detail_v2_output module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_v2_output.AnnotationDetailV2Output(*args, oneof_schema_1_validator: AnnotationDetailV2Get | None = None, actual_instance: AnnotationDetailV2Get | None = None, one_of_schemas: Set[str] = {'AnnotationDetailV2Get'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: AnnotationDetailV2Get | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AnnotationDetailV2Get | None#

to_dict() → Dict[str, Any] | AnnotationDetailV2Get | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_detail_v2_update module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_detail_v2_update.AnnotationDetailV2Update(*, _type: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], label_id: Annotated[str, Strict(strict=True)], body: AnnotationDetailContentInput | None = None, additional_data_list: List[AdditionalDataV2], editor_props: AnnotationPropsForEditor)[source]#

Bases: BaseModel

既に存在するアノテーションを更新する場合にこの型を利用します

additional_data_list: List[AdditionalDataV2]#

annotation_id: StrictStr#

body: AnnotationDetailContentInput | None#

editor_props: AnnotationPropsForEditor#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationDetailV2Update from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationDetailV2Update from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_editor_feature module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_editor_feature.AnnotationEditorFeature(*, append: Annotated[bool, Strict(strict=True)], erase: Annotated[bool, Strict(strict=True)], freehand: Annotated[bool, Strict(strict=True)], rectangle_fill: Annotated[bool, Strict(strict=True)], polygon_fill: Annotated[bool, Strict(strict=True)], fill_near: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

塗りつぶしの作図機能に関する情報

append: StrictBool#

erase: StrictBool#

fill_near: StrictBool#

freehand: StrictBool#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationEditorFeature from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationEditorFeature from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

polygon_fill: StrictBool#

rectangle_fill: StrictBool#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.annotation_input module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_input.AnnotationInput(*args, oneof_schema_1_validator: AnnotationV1 | None = None, oneof_schema_2_validator: AnnotationV2Input | None = None, actual_instance: AnnotationV1 | AnnotationV2Input | None = None, one_of_schemas: Set[str] = {'AnnotationV1', 'AnnotationV2Input'})[source]#

Bases: BaseModel

actual_instance: AnnotationV1 | AnnotationV2Input | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AnnotationV1 | None#

oneof_schema_2_validator: AnnotationV2Input | None#

to_dict() → Dict[str, Any] | AnnotationV1 | AnnotationV2Input | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_list module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_list.AnnotationList(*, list: List[SingleAnnotation], page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_count: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], over_limit: Annotated[bool, Strict(strict=True)], aggregations: List[AggregationResult])[source]#

Bases: BaseModel

aggregations: List[AggregationResult]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationList from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationList from a JSON string

list: List[SingleAnnotation]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

over_limit: StrictBool#

page_no: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

total_count: StrictFloat | StrictInt#

total_page_no: StrictFloat | StrictInt#

annofabapi.pydantic_models.annotation_output module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_output.AnnotationOutput(*args, oneof_schema_1_validator: AnnotationV1 | None = None, oneof_schema_2_validator: AnnotationV2Output | None = None, actual_instance: AnnotationV1 | AnnotationV2Output | None = None, one_of_schemas: Set[str] = {'AnnotationV1', 'AnnotationV2Output'})[source]#

Bases: BaseModel

actual_instance: AnnotationV1 | AnnotationV2Output | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AnnotationV1 | None#

oneof_schema_2_validator: AnnotationV2Output | None#

to_dict() → Dict[str, Any] | AnnotationV1 | AnnotationV2Output | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_props_for_editor module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_props_for_editor.AnnotationPropsForEditor(*, can_delete: Annotated[bool, Strict(strict=True)] | None = None, can_edit_data: Annotated[bool, Strict(strict=True)] | None = None, can_edit_additional: Annotated[bool, Strict(strict=True)] | None = None, description: Annotated[str, Strict(strict=True)] | None = None, tags: List[Annotated[str, Strict(strict=True)]] | None = None, etc: Any | None = None)[source]#

Bases: BaseModel

アノテーションエディタ用のアノテーション毎のプロパティです。 ここに含まれているデータはアノテーション結果に反映されず、エディタが利用するために存在します。エディタ用のデータであるため、たとえば`can_delete`や`can_edit_data`が`false`でも、APIによる編集は妨げません。 ここで定義されているデータを利用して動作を変えるかどうかは、エディタによって異なります。

can_delete: StrictBool | None#

can_edit_additional: StrictBool | None#

can_edit_data: StrictBool | None#

description: StrictStr | None#

etc: Any | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationPropsForEditor from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationPropsForEditor from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tags: List[StrictStr] | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.annotation_query module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_query.AnnotationQuery(*, task_id: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MaxLen(max_length=300)])] | None = None, exact_match_task_id: Annotated[bool, Strict(strict=True)] | None = True, input_data_id: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MaxLen(max_length=300)])] | None = None, exact_match_input_data_id: Annotated[bool, Strict(strict=True)] | None = True, label_id: Annotated[str, Strict(strict=True)] | None = None, attributes: List[AdditionalDataV1] | None = None, updated_from: str | None = None, updated_to: str | None = None)[source]#

Bases: BaseModel

アノテーションの絞り込み条件

attributes: List[AdditionalDataV1] | None#

exact_match_input_data_id: StrictBool | None#

exact_match_task_id: StrictBool | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationQuery from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationQuery from a JSON string

input_data_id: Annotated[str, Field(strict=True, max_length=300)] | None#

label_id: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

task_id: Annotated[str, Field(strict=True, max_length=300)] | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_from: str | None#

updated_to: str | None#

annofabapi.pydantic_models.annotation_specs module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs.AnnotationSpecs(*args, oneof_schema_1_validator: AnnotationSpecsV1 | None = None, oneof_schema_2_validator: AnnotationSpecsV2 | None = None, oneof_schema_3_validator: AnnotationSpecsV3 | None = None, actual_instance: AnnotationSpecsV1 | AnnotationSpecsV2 | AnnotationSpecsV3 | None = None, one_of_schemas: Set[str] = {'AnnotationSpecsV1', 'AnnotationSpecsV2', 'AnnotationSpecsV3'})[source]#

Bases: BaseModel

actual_instance: AnnotationSpecsV1 | AnnotationSpecsV2 | AnnotationSpecsV3 | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AnnotationSpecsV1 | None#

oneof_schema_2_validator: AnnotationSpecsV2 | None#

oneof_schema_3_validator: AnnotationSpecsV3 | None#

to_dict() → Dict[str, Any] | AnnotationSpecsV1 | AnnotationSpecsV2 | AnnotationSpecsV3 | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_specs_history module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs_history.AnnotationSpecsHistory(*, history_id: Annotated[str, Strict(strict=True)], project_id: Annotated[str, Strict(strict=True)], updated_datetime: str, url: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)] | None = None, comment: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

account_id: StrictStr | None#

comment: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationSpecsHistory from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationSpecsHistory from a JSON string

history_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

url: StrictStr#

annofabapi.pydantic_models.annotation_specs_movie_option module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs_movie_option.AnnotationSpecsMovieOption(*, can_overwrap: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

can_overwrap: StrictBool#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationSpecsMovieOption from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationSpecsMovieOption from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.annotation_specs_option module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs_option.AnnotationSpecsOption(*args, oneof_schema_1_validator: AnnotationSpecsMovieOption | None = None, actual_instance: AnnotationSpecsMovieOption | None = None, one_of_schemas: Set[str] = {'AnnotationSpecsMovieOption'})[source]#

Bases: BaseModel

アノテーション仕様のオプション設定。現時点では動画プロジェクトでのみ利用・指定可能。動画以外のプロジェクトでは値なし。動画プロジェクトで値が未指定の場合、AnnotationSpecsOption内の値はすべてデフォルト値が指定されたものとして扱われる。

actual_instance: AnnotationSpecsMovieOption | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AnnotationSpecsMovieOption | None#

to_dict() → Dict[str, Any] | AnnotationSpecsMovieOption | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_specs_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs_request.AnnotationSpecsRequest(*args, oneof_schema_1_validator: AnnotationSpecsRequestV1 | None = None, oneof_schema_2_validator: AnnotationSpecsRequestV2 | None = None, oneof_schema_3_validator: AnnotationSpecsRequestV3 | None = None, actual_instance: AnnotationSpecsRequestV1 | AnnotationSpecsRequestV2 | AnnotationSpecsRequestV3 | None = None, one_of_schemas: Set[str] = {'AnnotationSpecsRequestV1', 'AnnotationSpecsRequestV2', 'AnnotationSpecsRequestV3'})[source]#

Bases: BaseModel

actual_instance: AnnotationSpecsRequestV1 | AnnotationSpecsRequestV2 | AnnotationSpecsRequestV3 | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AnnotationSpecsRequestV1 | None#

oneof_schema_2_validator: AnnotationSpecsRequestV2 | None#

oneof_schema_3_validator: AnnotationSpecsRequestV3 | None#

to_dict() → Dict[str, Any] | AnnotationSpecsRequestV1 | AnnotationSpecsRequestV2 | AnnotationSpecsRequestV3 | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_specs_request_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs_request_v1.AnnotationSpecsRequestV1(*, labels: List[LabelV1], inspection_phrases: List[InspectionPhrase], comment: Annotated[str, Strict(strict=True)] | None = None, auto_marking: Annotated[bool, Strict(strict=True)] | None = False, last_updated_datetime: str | None = None, option: AnnotationSpecsOption | None = None, metadata: Dict[str, Annotated[str, Strict(strict=True)]] | None = None)[source]#

Bases: BaseModel

auto_marking: StrictBool | None#

comment: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationSpecsRequestV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationSpecsRequestV1 from a JSON string

inspection_phrases: List[InspectionPhrase]#

labels: List[LabelV1]#

last_updated_datetime: str | None#

metadata: Dict[str, StrictStr] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

option: AnnotationSpecsOption | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.annotation_specs_request_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs_request_v2.AnnotationSpecsRequestV2(*, labels: List[LabelV2], additionals: List[AdditionalDataDefinitionV2], restrictions: List[AdditionalDataRestriction], inspection_phrases: List[InspectionPhrase], comment: Annotated[str, Strict(strict=True)] | None = None, auto_marking: Annotated[bool, Strict(strict=True)] | None = False, format_version: Annotated[str, Strict(strict=True)], last_updated_datetime: str | None = None, option: AnnotationSpecsOption | None = None, metadata: Dict[str, Annotated[str, Strict(strict=True)]] | None = None)[source]#

Bases: BaseModel

additionals: List[AdditionalDataDefinitionV2]#

auto_marking: StrictBool | None#

comment: StrictStr | None#

format_version: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationSpecsRequestV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationSpecsRequestV2 from a JSON string

inspection_phrases: List[InspectionPhrase]#

labels: List[LabelV2]#

last_updated_datetime: str | None#

metadata: Dict[str, StrictStr] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

option: AnnotationSpecsOption | None#

restrictions: List[AdditionalDataRestriction]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.annotation_specs_request_v3 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs_request_v3.AnnotationSpecsRequestV3(*, labels: List[LabelV3], additionals: List[AdditionalDataDefinitionV2], restrictions: List[AdditionalDataRestriction], inspection_phrases: List[InspectionPhrase], comment: Annotated[str, Strict(strict=True)] | None = None, auto_marking: Annotated[bool, Strict(strict=True)] | None = False, annotation_type_version: Annotated[str, Strict(strict=True)] | None = None, format_version: Annotated[str, Strict(strict=True)], last_updated_datetime: str | None = None, option: AnnotationSpecsOption | None = None, metadata: Dict[str, Annotated[str, Strict(strict=True)]] | None = None)[source]#

Bases: BaseModel

additionals: List[AdditionalDataDefinitionV2]#

annotation_type_version: StrictStr | None#

auto_marking: StrictBool | None#

comment: StrictStr | None#

format_version: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationSpecsRequestV3 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationSpecsRequestV3 from a JSON string

inspection_phrases: List[InspectionPhrase]#

labels: List[LabelV3]#

last_updated_datetime: str | None#

metadata: Dict[str, StrictStr] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

option: AnnotationSpecsOption | None#

restrictions: List[AdditionalDataRestriction]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.annotation_specs_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs_v1.AnnotationSpecsV1(*, project_id: Annotated[str, Strict(strict=True)], labels: List[LabelV1], inspection_phrases: List[InspectionPhrase], updated_datetime: str | None = None, option: AnnotationSpecsOption | None = None, metadata: Dict[str, Annotated[str, Strict(strict=True)]])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationSpecsV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationSpecsV1 from a JSON string

inspection_phrases: List[InspectionPhrase]#

labels: List[LabelV1]#

metadata: Dict[str, StrictStr]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

option: AnnotationSpecsOption | None#

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.annotation_specs_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs_v2.AnnotationSpecsV2(*, project_id: Annotated[str, Strict(strict=True)], labels: List[LabelV2], additionals: List[AdditionalDataDefinitionV2], restrictions: List[AdditionalDataRestriction], inspection_phrases: List[InspectionPhrase], format_version: Annotated[str, Strict(strict=True)], updated_datetime: str | None = None, option: AnnotationSpecsOption | None = None, metadata: Dict[str, Annotated[str, Strict(strict=True)]])[source]#

Bases: BaseModel

additionals: List[AdditionalDataDefinitionV2]#

format_version: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationSpecsV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationSpecsV2 from a JSON string

inspection_phrases: List[InspectionPhrase]#

labels: List[LabelV2]#

metadata: Dict[str, StrictStr]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

option: AnnotationSpecsOption | None#

project_id: StrictStr#

restrictions: List[AdditionalDataRestriction]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.annotation_specs_v3 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_specs_v3.AnnotationSpecsV3(*, project_id: Annotated[str, Strict(strict=True)], labels: List[LabelV3], additionals: List[AdditionalDataDefinitionV2], restrictions: List[AdditionalDataRestriction], inspection_phrases: List[InspectionPhrase], annotation_type_version: Annotated[str, Strict(strict=True)] | None = None, format_version: Annotated[str, Strict(strict=True)], updated_datetime: str | None = None, option: AnnotationSpecsOption | None = None, metadata: Dict[str, Annotated[str, Strict(strict=True)]])[source]#

Bases: BaseModel

additionals: List[AdditionalDataDefinitionV2]#

annotation_type_version: StrictStr | None#

format_version: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationSpecsV3 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationSpecsV3 from a JSON string

inspection_phrases: List[InspectionPhrase]#

labels: List[LabelV3]#

metadata: Dict[str, StrictStr]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

option: AnnotationSpecsOption | None#

project_id: StrictStr#

restrictions: List[AdditionalDataRestriction]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.annotation_thumbnail module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_thumbnail.AnnotationThumbnail(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], images: List[AnnotationThumbnailImage], annotations: Dict[str, AnnotationThumbnailDetail], annotation_updated_datetime: str | None = None, created_datetime: str | None = None)[source]#

Bases: BaseModel

アノテーションのサムネイル情報

annotation_updated_datetime: str | None#

annotations: Dict[str, AnnotationThumbnailDetail]#

created_datetime: str | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationThumbnail from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationThumbnail from a JSON string

images: List[AnnotationThumbnailImage]#

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.annotation_thumbnail_detail module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_thumbnail_detail.AnnotationThumbnailDetail(*args, oneof_schema_1_validator: AnnotationThumbnailDetailImageSlice | None = None, oneof_schema_2_validator: AnnotationThumbnailDetailUnsupported | None = None, oneof_schema_3_validator: AnnotationThumbnailDetailFailed | None = None, actual_instance: AnnotationThumbnailDetailFailed | AnnotationThumbnailDetailImageSlice | AnnotationThumbnailDetailUnsupported | None = None, one_of_schemas: Set[str] = {'AnnotationThumbnailDetailFailed', 'AnnotationThumbnailDetailImageSlice', 'AnnotationThumbnailDetailUnsupported'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

AnnotationThumbnailDetailImageSlice: 画像の一部をサムネイルとして使用する - AnnotationThumbnailDetailUnsupported: サムネイル生成に対応していない - AnnotationThumbnailDetailFailed: サムネイル生成に失敗した

actual_instance: AnnotationThumbnailDetailFailed | AnnotationThumbnailDetailImageSlice | AnnotationThumbnailDetailUnsupported | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: AnnotationThumbnailDetailImageSlice | None#

oneof_schema_2_validator: AnnotationThumbnailDetailUnsupported | None#

oneof_schema_3_validator: AnnotationThumbnailDetailFailed | None#

to_dict() → Dict[str, Any] | AnnotationThumbnailDetailFailed | AnnotationThumbnailDetailImageSlice | AnnotationThumbnailDetailUnsupported | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_thumbnail_detail_failed module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_thumbnail_detail_failed.AnnotationThumbnailDetailFailed(*, _type: Annotated[str, Strict(strict=True)], reason: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

サムネイル生成に失敗した

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationThumbnailDetailFailed from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationThumbnailDetailFailed from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

reason: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_thumbnail_detail_image_slice module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_thumbnail_detail_image_slice.AnnotationThumbnailDetailImageSlice(*, _type: Annotated[str, Strict(strict=True)], image: Annotated[int, Strict(strict=True)], x: Annotated[int, Strict(strict=True)], y: Annotated[int, Strict(strict=True)], width: Annotated[int, Strict(strict=True)], height: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

画像の一部をサムネイルとして使用する

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationThumbnailDetailImageSlice from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationThumbnailDetailImageSlice from a JSON string

height: StrictInt#

image: StrictInt#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

width: StrictInt#

x: StrictInt#

y: StrictInt#

annofabapi.pydantic_models.annotation_thumbnail_detail_unsupported module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_thumbnail_detail_unsupported.AnnotationThumbnailDetailUnsupported(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

サムネイル生成に対応していない

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationThumbnailDetailUnsupported from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationThumbnailDetailUnsupported from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_thumbnail_image module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_thumbnail_image.AnnotationThumbnailImage(*, _type: Annotated[str, Strict(strict=True)] | None = None, url: Annotated[str, Strict(strict=True)], width: Annotated[int, Strict(strict=True)], height: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationThumbnailImage from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationThumbnailImage from a JSON string

height: StrictInt#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

classmethod type_validate_enum(value)[source]#: Validates the enum

url: StrictStr#

width: StrictInt#

annofabapi.pydantic_models.annotation_thumbnail_image_source module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_thumbnail_image_source.AnnotationThumbnailImageSource(*, _type: Annotated[str, Strict(strict=True)] | None = None, temporary_path: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationThumbnailImageSource from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationThumbnailImageSource from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

temporary_path: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type.AnnotationType(*args, oneof_schema_1_validator: DefaultAnnotationType | None = None, oneof_schema_2_validator: Annotated[str, Strict(strict=True)] | None = None, actual_instance: DefaultAnnotationType | str | None = None, one_of_schemas: Set[str] = {'DefaultAnnotationType', 'str'})[source]#

Bases: BaseModel

actual_instance: DefaultAnnotationType | str | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: DefaultAnnotationType | None#

oneof_schema_2_validator: StrictStr | None#

to_dict() → Dict[str, Any] | DefaultAnnotationType | str | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_type_field_definition_annotation_editor_feature module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_definition_annotation_editor_feature.AnnotationTypeFieldDefinitionAnnotationEditorFeature(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

作図ツール・作図モードのフィールドの定義

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionAnnotationEditorFeature from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionAnnotationEditorFeature from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_definition_display_line_direction module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_definition_display_line_direction.AnnotationTypeFieldDefinitionDisplayLineDirection(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

線の向き表示/非表示の設定のフィールド定義

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionDisplayLineDirection from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionDisplayLineDirection from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_definition_margin_of_error_tolerance module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_definition_margin_of_error_tolerance.AnnotationTypeFieldDefinitionMarginOfErrorTolerance(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

誤差許容範囲のフィールド定義

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionMarginOfErrorTolerance from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionMarginOfErrorTolerance from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_definition_minimum_area2d module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_definition_minimum_area2d.AnnotationTypeFieldDefinitionMinimumArea2d(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

最小の面積のフィールド定義

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionMinimumArea2d from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionMinimumArea2d from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_definition_minimum_size2d module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_definition_minimum_size2d.AnnotationTypeFieldDefinitionMinimumSize2d(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

アノテーションの最小サイズに関する設定のフィールド定義

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionMinimumSize2d from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionMinimumSize2d from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_definition_minimum_size2d_with_default_insert_position module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_definition_minimum_size2d_with_default_insert_position.AnnotationTypeFieldDefinitionMinimumSize2dWithDefaultInsertPosition(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

アノテーションの最小サイズに関する設定、および最小矩形の挿入位置のフィールド定義

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionMinimumSize2dWithDefaultInsertPosition from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionMinimumSize2dWithDefaultInsertPosition from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_definition_one_boolean_field module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_definition_one_boolean_field.AnnotationTypeFieldDefinitionOneBooleanField(*, _type: Annotated[str, Strict(strict=True)], title: InternationalizationMessage | None = None, description: InternationalizationMessage | None = None, initial_value: Annotated[bool, Strict(strict=True)] | None = None, label: InternationalizationMessage)[source]#

Bases: BaseModel

真偽値の値をひとつだけ持つフィールドの定義

description: InternationalizationMessage | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionOneBooleanField from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionOneBooleanField from a JSON string

initial_value: StrictBool | None#

label: InternationalizationMessage#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

title: InternationalizationMessage | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_definition_one_integer_field module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_definition_one_integer_field.AnnotationTypeFieldDefinitionOneIntegerField(*, _type: Annotated[str, Strict(strict=True)], title: InternationalizationMessage | None = None, prefix: Annotated[str, Strict(strict=True)] | None = None, postfix: Annotated[str, Strict(strict=True)] | None = None, description: InternationalizationMessage | None = None, initial_value: Annotated[int, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

数値の値をひとつだけ持つフィールドの定義

description: InternationalizationMessage | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionOneIntegerField from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionOneIntegerField from a JSON string

initial_value: StrictInt | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

postfix: StrictStr | None#

prefix: StrictStr | None#

title: InternationalizationMessage | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_definition_one_string_field module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_definition_one_string_field.AnnotationTypeFieldDefinitionOneStringField(*, _type: Annotated[str, Strict(strict=True)], title: InternationalizationMessage | None = None, prefix: Annotated[str, Strict(strict=True)] | None = None, postfix: Annotated[str, Strict(strict=True)] | None = None, description: InternationalizationMessage | None = None, initial_value: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

文字列の値をひとつだけ持つフィールドの定義

description: InternationalizationMessage | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionOneStringField from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionOneStringField from a JSON string

initial_value: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

postfix: StrictStr | None#

prefix: StrictStr | None#

title: InternationalizationMessage | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_definition_vertex_count_min_max module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_definition_vertex_count_min_max.AnnotationTypeFieldDefinitionVertexCountMinMax(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

頂点数の最大・最小のフィールド定義

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionVertexCountMinMax from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldDefinitionVertexCountMinMax from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_min_warn_rule module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_min_warn_rule.AnnotationTypeFieldMinWarnRule(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

最小の幅(min_width)と最小の高さ(min_height)がどのような状態になったときにエラーとするかを指定します。 * and - min_width、min_heightの両方が最小値未満の場合にエラーとなります。 * or - min_width、min_heightのいずれかが最小値未満の場合にエラーとなります。

AND = 'and'#

OR = 'or'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of AnnotationTypeFieldMinWarnRule from a JSON string

annofabapi.pydantic_models.annotation_type_field_value module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value.AnnotationTypeFieldValue(*args, oneof_schema_1_validator: AnnotationTypeFieldValueMinimumSize | None = None, oneof_schema_2_validator: AnnotationTypeFieldValueMinimumSize2dWithDefaultInsertPosition | None = None, oneof_schema_3_validator: AnnotationTypeFieldValueMarginOfErrorTolerance | None = None, oneof_schema_4_validator: AnnotationTypeFieldValueVertexCountMinMax | None = None, oneof_schema_5_validator: AnnotationTypeFieldValueMinimumArea2d | None = None, oneof_schema_6_validator: AnnotationTypeFieldValueDisplayLineDirection | None = None, oneof_schema_7_validator: AnnotationTypeFieldValueAnnotationEditorFeature | None = None, oneof_schema_8_validator: AnnotationTypeFieldValueOneIntegerFieldValue | None = None, oneof_schema_9_validator: AnnotationTypeFieldValueOneStringFieldValue | None = None, oneof_schema_10_validator: AnnotationTypeFieldValueOneBooleanFieldValue | None = None, oneof_schema_11_validator: AnnotationTypeFieldValueEmptyFieldValue | None = None, actual_instance: AnnotationTypeFieldValueAnnotationEditorFeature | AnnotationTypeFieldValueDisplayLineDirection | AnnotationTypeFieldValueEmptyFieldValue | AnnotationTypeFieldValueMarginOfErrorTolerance | AnnotationTypeFieldValueMinimumArea2d | AnnotationTypeFieldValueMinimumSize | AnnotationTypeFieldValueMinimumSize2dWithDefaultInsertPosition | AnnotationTypeFieldValueOneBooleanFieldValue | AnnotationTypeFieldValueOneIntegerFieldValue | AnnotationTypeFieldValueOneStringFieldValue | AnnotationTypeFieldValueVertexCountMinMax | None = None, one_of_schemas: Set[str] = {'AnnotationTypeFieldValueAnnotationEditorFeature', 'AnnotationTypeFieldValueDisplayLineDirection', 'AnnotationTypeFieldValueEmptyFieldValue', 'AnnotationTypeFieldValueMarginOfErrorTolerance', 'AnnotationTypeFieldValueMinimumArea2d', 'AnnotationTypeFieldValueMinimumSize', 'AnnotationTypeFieldValueMinimumSize2dWithDefaultInsertPosition', 'AnnotationTypeFieldValueOneBooleanFieldValue', 'AnnotationTypeFieldValueOneIntegerFieldValue', 'AnnotationTypeFieldValueOneStringFieldValue', 'AnnotationTypeFieldValueVertexCountMinMax'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

ユーザー定義アノテーション種別のフィールドに設定される値です。アノテーション種別のフィールド定義と対応するフィールド値のみ登録を許可されます。

actual_instance: AnnotationTypeFieldValueAnnotationEditorFeature | AnnotationTypeFieldValueDisplayLineDirection | AnnotationTypeFieldValueEmptyFieldValue | AnnotationTypeFieldValueMarginOfErrorTolerance | AnnotationTypeFieldValueMinimumArea2d | AnnotationTypeFieldValueMinimumSize | AnnotationTypeFieldValueMinimumSize2dWithDefaultInsertPosition | AnnotationTypeFieldValueOneBooleanFieldValue | AnnotationTypeFieldValueOneIntegerFieldValue | AnnotationTypeFieldValueOneStringFieldValue | AnnotationTypeFieldValueVertexCountMinMax | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_10_validator: AnnotationTypeFieldValueOneBooleanFieldValue | None#

oneof_schema_11_validator: AnnotationTypeFieldValueEmptyFieldValue | None#

oneof_schema_1_validator: AnnotationTypeFieldValueMinimumSize | None#

oneof_schema_2_validator: AnnotationTypeFieldValueMinimumSize2dWithDefaultInsertPosition | None#

oneof_schema_3_validator: AnnotationTypeFieldValueMarginOfErrorTolerance | None#

oneof_schema_4_validator: AnnotationTypeFieldValueVertexCountMinMax | None#

oneof_schema_5_validator: AnnotationTypeFieldValueMinimumArea2d | None#

oneof_schema_6_validator: AnnotationTypeFieldValueDisplayLineDirection | None#

oneof_schema_7_validator: AnnotationTypeFieldValueAnnotationEditorFeature | None#

oneof_schema_8_validator: AnnotationTypeFieldValueOneIntegerFieldValue | None#

oneof_schema_9_validator: AnnotationTypeFieldValueOneStringFieldValue | None#

to_dict() → Dict[str, Any] | AnnotationTypeFieldValueAnnotationEditorFeature | AnnotationTypeFieldValueDisplayLineDirection | AnnotationTypeFieldValueEmptyFieldValue | AnnotationTypeFieldValueMarginOfErrorTolerance | AnnotationTypeFieldValueMinimumArea2d | AnnotationTypeFieldValueMinimumSize | AnnotationTypeFieldValueMinimumSize2dWithDefaultInsertPosition | AnnotationTypeFieldValueOneBooleanFieldValue | AnnotationTypeFieldValueOneIntegerFieldValue | AnnotationTypeFieldValueOneStringFieldValue | AnnotationTypeFieldValueVertexCountMinMax | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.annotation_type_field_value_annotation_editor_feature module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_annotation_editor_feature.AnnotationTypeFieldValueAnnotationEditorFeature(*, _type: Annotated[str, Strict(strict=True)], append: Annotated[bool, Strict(strict=True)], erase: Annotated[bool, Strict(strict=True)], freehand: Annotated[bool, Strict(strict=True)], rectangle_fill: Annotated[bool, Strict(strict=True)], polygon_fill: Annotated[bool, Strict(strict=True)], fill_near: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

作図ツール・作図モード

append: StrictBool#

erase: StrictBool#

fill_near: StrictBool#

freehand: StrictBool#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueAnnotationEditorFeature from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueAnnotationEditorFeature from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

polygon_fill: StrictBool#

rectangle_fill: StrictBool#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_value_display_line_direction module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_display_line_direction.AnnotationTypeFieldValueDisplayLineDirection(*, _type: Annotated[str, Strict(strict=True)], has_direction: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

線の向き表示/非表示の設定

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueDisplayLineDirection from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueDisplayLineDirection from a JSON string

has_direction: StrictBool#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_value_empty_field_value module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_empty_field_value.AnnotationTypeFieldValueEmptyFieldValue(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

値を持たないフィールド。　アノテーション仕様上に定義が存在すること自体に意味がある場合のフィールド値に利用します。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueEmptyFieldValue from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueEmptyFieldValue from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_value_margin_of_error_tolerance module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_margin_of_error_tolerance.AnnotationTypeFieldValueMarginOfErrorTolerance(*, _type: Annotated[str, Strict(strict=True)], max_pixel: Annotated[int, Strict(strict=True), Ge(ge=1)])[source]#

Bases: BaseModel

誤差許容範囲

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueMarginOfErrorTolerance from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueMarginOfErrorTolerance from a JSON string

max_pixel: Annotated[int, Field(strict=True, ge=1)]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_value_minimum_area2d module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_minimum_area2d.AnnotationTypeFieldValueMinimumArea2d(*, _type: Annotated[str, Strict(strict=True)], min_area: Annotated[int, Strict(strict=True), Ge(ge=1)])[source]#

Bases: BaseModel

最小の面積

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueMinimumArea2d from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueMinimumArea2d from a JSON string

min_area: Annotated[int, Field(strict=True, ge=1)]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_value_minimum_size module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_minimum_size.AnnotationTypeFieldValueMinimumSize(*, _type: Annotated[str, Strict(strict=True)], min_warn_rule: AnnotationTypeFieldMinWarnRule, min_width: Annotated[int, Strict(strict=True), Ge(ge=1)], min_height: Annotated[int, Strict(strict=True), Ge(ge=1)])[source]#

Bases: BaseModel

アノテーションの最小サイズに関する設定

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueMinimumSize from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueMinimumSize from a JSON string

min_height: Annotated[int, Field(strict=True, ge=1)]#

min_warn_rule: AnnotationTypeFieldMinWarnRule#

min_width: Annotated[int, Field(strict=True, ge=1)]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_value_minimum_size2d_with_default_insert_position module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_minimum_size2d_with_default_insert_position.AnnotationTypeFieldValueMinimumSize2dWithDefaultInsertPosition(*, _type: Annotated[str, Strict(strict=True)], min_warn_rule: AnnotationTypeFieldMinWarnRule, min_width: Annotated[int, Strict(strict=True), Ge(ge=1)], min_height: Annotated[int, Strict(strict=True), Ge(ge=1)], position_for_minimum_bounding_box_insertion: List[Annotated[int, Strict(strict=True)]] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueMinimumSize2dWithDefaultInsertPosition from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueMinimumSize2dWithDefaultInsertPosition from a JSON string

min_height: Annotated[int, Field(strict=True, ge=1)]#

min_warn_rule: AnnotationTypeFieldMinWarnRule#

min_width: Annotated[int, Field(strict=True, ge=1)]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

position_for_minimum_bounding_box_insertion: List[StrictInt] | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_type_field_value_one_boolean_field_value module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_one_boolean_field_value.AnnotationTypeFieldValueOneBooleanFieldValue(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

真偽値をひとつだけ持つフィールド

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueOneBooleanFieldValue from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueOneBooleanFieldValue from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

value: StrictBool#

annofabapi.pydantic_models.annotation_type_field_value_one_integer_field_value module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_one_integer_field_value.AnnotationTypeFieldValueOneIntegerFieldValue(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

数値をひとつだけ持つフィールド

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueOneIntegerFieldValue from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueOneIntegerFieldValue from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

value: StrictInt#

annofabapi.pydantic_models.annotation_type_field_value_one_string_field_value module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_one_string_field_value.AnnotationTypeFieldValueOneStringFieldValue(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

文字列を一つだけ持つフィールド

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueOneStringFieldValue from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueOneStringFieldValue from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

value: StrictStr#

annofabapi.pydantic_models.annotation_type_field_value_vertex_count_min_max module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_type_field_value_vertex_count_min_max.AnnotationTypeFieldValueVertexCountMinMax(*, _type: Annotated[str, Strict(strict=True)], min: Annotated[int, Strict(strict=True), Ge(ge=1)], max: Annotated[int, Strict(strict=True), Ge(ge=1)])[source]#

Bases: BaseModel

頂点数の最大・最小

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueVertexCountMinMax from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationTypeFieldValueVertexCountMinMax from a JSON string

max: Annotated[int, Field(strict=True, ge=1)]#

min: Annotated[int, Field(strict=True, ge=1)]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.annotation_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_v1.AnnotationV1(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], details: List[AnnotationDetailV1], updated_datetime: str | None = None)[source]#

Bases: BaseModel

details: List[AnnotationDetailV1]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationV1 from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.annotation_v2_input module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_v2_input.AnnotationV2Input(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], details: List[AnnotationDetailV2Input], updated_datetime: str | None = None, format_version: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

details: List[AnnotationDetailV2Input]#

format_version: StrictStr#

classmethod format_version_validate_enum(value)[source]#: Validates the enum

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationV2Input from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationV2Input from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.annotation_v2_output module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotation_v2_output.AnnotationV2Output(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], details: List[AnnotationDetailV2Output], updated_datetime: str | None = None, format_version: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

details: List[AnnotationDetailV2Output]#

format_version: StrictStr#

classmethod format_version_validate_enum(value)[source]#: Validates the enum

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationV2Output from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationV2Output from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.annotations_by_input_data_id_identifier module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.annotations_by_input_data_id_identifier.AnnotationsByInputDataIdIdentifier(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

アノテーションの所属先

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of AnnotationsByInputDataIdIdentifier from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of AnnotationsByInputDataIdIdentifier from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.assignee_rule_of_resubmitted_task module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.assignee_rule_of_resubmitted_task.AssigneeRuleOfResubmittedTask(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

再提出されたタスクの検査/受入担当者の割当方法 * no_assignee - 以前の担当者で固定せず、未割当てにします。 * fixed - 以前の担当者が再度担当します。以前の担当者がいない(1回目の検査/受入)場合は未割当てになります。

FIXED = 'fixed'#

NO_ASSIGNEE = 'no_assignee'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of AssigneeRuleOfResubmittedTask from a JSON string

annofabapi.pydantic_models.batch_annotation_request_item module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_annotation_request_item.BatchAnnotationRequestItem(*args, oneof_schema_1_validator: BatchAnnotationRequestItemPutV1 | None = None, oneof_schema_2_validator: BatchAnnotationRequestItemPutV2 | None = None, oneof_schema_3_validator: BatchAnnotationRequestItemDelete | None = None, actual_instance: BatchAnnotationRequestItemDelete | BatchAnnotationRequestItemPutV1 | BatchAnnotationRequestItemPutV2 | None = None, one_of_schemas: Set[str] = {'BatchAnnotationRequestItemDelete', 'BatchAnnotationRequestItemPutV1', 'BatchAnnotationRequestItemPutV2'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: BatchAnnotationRequestItemDelete | BatchAnnotationRequestItemPutV1 | BatchAnnotationRequestItemPutV2 | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: BatchAnnotationRequestItemPutV1 | None#

oneof_schema_2_validator: BatchAnnotationRequestItemPutV2 | None#

oneof_schema_3_validator: BatchAnnotationRequestItemDelete | None#

to_dict() → Dict[str, Any] | BatchAnnotationRequestItemDelete | BatchAnnotationRequestItemPutV1 | BatchAnnotationRequestItemPutV2 | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.batch_annotation_request_item_delete module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_annotation_request_item_delete.BatchAnnotationRequestItemDelete(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], updated_datetime: str, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

アノテーション削除

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchAnnotationRequestItemDelete from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchAnnotationRequestItemDelete from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

classmethod type_validate_enum(value)[source]#: Validates the enum

updated_datetime: str#

annofabapi.pydantic_models.batch_annotation_request_item_put_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_annotation_request_item_put_v1.BatchAnnotationRequestItemPutV1(*, data: BatchAnnotationV1, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

アノテーション更新

data: BatchAnnotationV1#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchAnnotationRequestItemPutV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchAnnotationRequestItemPutV1 from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.batch_annotation_request_item_put_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_annotation_request_item_put_v2.BatchAnnotationRequestItemPutV2(*, data: BatchAnnotationV2, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

アノテーション更新

data: BatchAnnotationV2#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchAnnotationRequestItemPutV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchAnnotationRequestItemPutV2 from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.batch_annotation_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_annotation_v1.BatchAnnotationV1(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], label_id: Annotated[str, Strict(strict=True)], additional_data_list: List[AdditionalDataV1], updated_datetime: str)[source]#

Bases: BaseModel

additional_data_list: List[AdditionalDataV1]#

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchAnnotationV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchAnnotationV1 from a JSON string

input_data_id: StrictStr#

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.batch_annotation_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_annotation_v2.BatchAnnotationV2(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], label_id: Annotated[str, Strict(strict=True)], additional_data_list: List[AdditionalDataV2], updated_datetime: str)[source]#

Bases: BaseModel

additional_data_list: List[AdditionalDataV2]#

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchAnnotationV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchAnnotationV2 from a JSON string

input_data_id: StrictStr#

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.batch_comment_request_item module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_comment_request_item.BatchCommentRequestItem(*args, oneof_schema_1_validator: BatchCommentRequestItemPut | None = None, oneof_schema_2_validator: BatchCommentRequestItemDelete | None = None, actual_instance: BatchCommentRequestItemDelete | BatchCommentRequestItemPut | None = None, one_of_schemas: Set[str] = {'BatchCommentRequestItemDelete', 'BatchCommentRequestItemPut'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: BatchCommentRequestItemDelete | BatchCommentRequestItemPut | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: BatchCommentRequestItemPut | None#

oneof_schema_2_validator: BatchCommentRequestItemDelete | None#

to_dict() → Dict[str, Any] | BatchCommentRequestItemDelete | BatchCommentRequestItemPut | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.batch_comment_request_item_delete module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_comment_request_item_delete.BatchCommentRequestItemDelete(*, comment_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

コメント削除

comment_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchCommentRequestItemDelete from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchCommentRequestItemDelete from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.batch_comment_request_item_put module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_comment_request_item_put.BatchCommentRequestItemPut(*, comment_id: Annotated[str, Strict(strict=True)], phase: TaskPhase, phase_stage: Annotated[int, Strict(strict=True), Ge(ge=1)], account_id: Annotated[str, Strict(strict=True)], comment_type: Annotated[str, Strict(strict=True)], phrases: List[Annotated[str, Strict(strict=True)]] | None = None, comment: Annotated[str, Strict(strict=True)], comment_node: CommentNode, datetime_for_sorting: str | None = None, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

コメント更新

account_id: StrictStr#

comment: StrictStr#

comment_id: StrictStr#

comment_node: CommentNode#

comment_type: StrictStr#

classmethod comment_type_validate_enum(value)[source]#: Validates the enum

datetime_for_sorting: str | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchCommentRequestItemPut from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchCommentRequestItemPut from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

phase_stage: Annotated[int, Field(strict=True, ge=1)]#

phrases: List[StrictStr] | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.batch_input_data_request_item module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_input_data_request_item.BatchInputDataRequestItem(*args, oneof_schema_1_validator: BatchInputDataRequestItemDelete | None = None, actual_instance: BatchInputDataRequestItemDelete | None = None, one_of_schemas: Set[str] = {'BatchInputDataRequestItemDelete'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: BatchInputDataRequestItemDelete | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: BatchInputDataRequestItemDelete | None#

to_dict() → Dict[str, Any] | BatchInputDataRequestItemDelete | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.batch_input_data_request_item_delete module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_input_data_request_item_delete.BatchInputDataRequestItemDelete(*, project_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

入力データ削除

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchInputDataRequestItemDelete from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchInputDataRequestItemDelete from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.batch_inspection_request_item module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_inspection_request_item.BatchInspectionRequestItem(*args, oneof_schema_1_validator: BatchInspectionRequestItemPut | None = None, oneof_schema_2_validator: BatchInspectionRequestItemDelete | None = None, actual_instance: BatchInspectionRequestItemDelete | BatchInspectionRequestItemPut | None = None, one_of_schemas: Set[str] = {'BatchInspectionRequestItemDelete', 'BatchInspectionRequestItemPut'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: BatchInspectionRequestItemDelete | BatchInspectionRequestItemPut | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: BatchInspectionRequestItemPut | None#

oneof_schema_2_validator: BatchInspectionRequestItemDelete | None#

to_dict() → Dict[str, Any] | BatchInspectionRequestItemDelete | BatchInspectionRequestItemPut | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.batch_inspection_request_item_delete module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_inspection_request_item_delete.BatchInspectionRequestItemDelete(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], inspection_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

検査コメント削除

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchInspectionRequestItemDelete from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchInspectionRequestItemDelete from a JSON string

input_data_id: StrictStr#

inspection_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.batch_inspection_request_item_put module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_inspection_request_item_put.BatchInspectionRequestItemPut(*, data: Inspection, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

検査コメント更新

data: Inspection#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchInspectionRequestItemPut from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchInspectionRequestItemPut from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.batch_task_request_item module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_task_request_item.BatchTaskRequestItem(*args, oneof_schema_1_validator: BatchTaskRequestItemDelete | None = None, actual_instance: BatchTaskRequestItemDelete | None = None, one_of_schemas: Set[str] = {'BatchTaskRequestItemDelete'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: BatchTaskRequestItemDelete | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: BatchTaskRequestItemDelete | None#

to_dict() → Dict[str, Any] | BatchTaskRequestItemDelete | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.batch_task_request_item_delete module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.batch_task_request_item_delete.BatchTaskRequestItemDelete(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

タスク削除

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BatchTaskRequestItemDelete from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BatchTaskRequestItemDelete from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.bounding_box_metadata module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.bounding_box_metadata.BoundingBoxMetadata(*, min_width: Annotated[int, Strict(strict=True)], min_height: Annotated[int, Strict(strict=True)], min_warn_rule: Annotated[str, Strict(strict=True)], min_area: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1)])] | None = None, max_vertices: Annotated[int, Strict(strict=True)] | None = None, min_vertices: Annotated[int, Strict(strict=True)] | None = None, position_for_minimum_bounding_box_insertion: PositionForMinimumBoundingBoxInsertion | None = None, tolerance: Annotated[int, Strict(strict=True)] | None = None, has_direction: Annotated[bool, Strict(strict=True)] | None = False)[source]#

Bases: BaseModel

ベクター形式のアノテーション（矩形、ポリゴン、ポリライン、点）のメタデータ

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of BoundingBoxMetadata from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of BoundingBoxMetadata from a JSON string

has_direction: StrictBool | None#

max_vertices: StrictInt | None#

min_area: Annotated[int, Field(strict=True, ge=1)] | None#

min_height: StrictInt#

min_vertices: StrictInt | None#

min_warn_rule: StrictStr#

classmethod min_warn_rule_validate_enum(value)[source]#: Validates the enum

min_width: StrictInt#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

position_for_minimum_bounding_box_insertion: PositionForMinimumBoundingBoxInsertion | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

tolerance: StrictInt | None#

annofabapi.pydantic_models.change_password_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.change_password_request.ChangePasswordRequest(*, user_id: Annotated[str, Strict(strict=True)], old_password: Annotated[str, Strict(strict=True)], new_password: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ChangePasswordRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ChangePasswordRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

new_password: StrictStr#

old_password: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

user_id: StrictStr#

annofabapi.pydantic_models.color module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.color.Color(*, red: Annotated[int, Strict(strict=True), Ge(ge=0), Le(le=255)], green: Annotated[int, Strict(strict=True), Ge(ge=0), Le(le=255)], blue: Annotated[int, Strict(strict=True), Ge(ge=0), Le(le=255)])[source]#

Bases: BaseModel

RGBで表現される色情報

blue: Annotated[int, Field(le=255, strict=True, ge=0)]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Color from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Color from a JSON string

green: Annotated[int, Field(le=255, strict=True, ge=0)]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

red: Annotated[int, Field(le=255, strict=True, ge=0)]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.comment module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.comment.Comment(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], comment_id: Annotated[str, Strict(strict=True)], phase: TaskPhase, phase_stage: Annotated[int, Strict(strict=True), Ge(ge=1)], account_id: Annotated[str, Strict(strict=True)], comment_type: CommentType, phrases: List[Annotated[str, Strict(strict=True)]] | None = None, comment: Annotated[str, Strict(strict=True)], comment_node: CommentNode, datetime_for_sorting: str, created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

account_id: StrictStr#

comment: StrictStr#

comment_id: StrictStr#

comment_node: CommentNode#

comment_type: CommentType#

created_datetime: str#

datetime_for_sorting: str#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Comment from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Comment from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

phase_stage: Annotated[int, Field(strict=True, ge=1)]#

phrases: List[StrictStr] | None#

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.comment_node module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.comment_node.CommentNode(*args, oneof_schema_1_validator: RootComment | None = None, oneof_schema_2_validator: ReplyComment | None = None, actual_instance: ReplyComment | RootComment | None = None, one_of_schemas: Set[str] = {'ReplyComment', 'RootComment'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

コメントのノード固有のデータ。 * RootComment - スレッドの先頭のコメント（ルートコメント）。 * ReplyComment - あるコメントへの返信コメント。

actual_instance: ReplyComment | RootComment | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: RootComment | None#

oneof_schema_2_validator: ReplyComment | None#

to_dict() → Dict[str, Any] | ReplyComment | RootComment | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.comment_status module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.comment_status.CommentStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

comment_type の値によってコメントのステータスに格納される値とステータスの意味が変わります。 * onhold の場合 * open`（未対応）、`resolved`（対応完了）を指定可能 * `inspection の場合 * `open`（未対応）、`resolved`（対応完了）、`closed`（対応不要）を指定可能

CLOSED = 'closed'#

OPEN = 'open'#

RESOLVED = 'resolved'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of CommentStatus from a JSON string

annofabapi.pydantic_models.comment_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.comment_type.CommentType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

コメントの種別。 * onhold - 保留コメント * inspection - 検査コメント

INSPECTION = 'inspection'#

ONHOLD = 'onhold'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of CommentType from a JSON string

annofabapi.pydantic_models.comment_validation_error module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.comment_validation_error.CommentValidationError(*args, oneof_schema_1_validator: NoComment | None = None, oneof_schema_2_validator: UpdateStatusRequired | None = None, actual_instance: NoComment | UpdateStatusRequired | None = None, one_of_schemas: Set[str] = {'NoComment', 'UpdateStatusRequired'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: NoComment | UpdateStatusRequired | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: NoComment | None#

oneof_schema_2_validator: UpdateStatusRequired | None#

to_dict() → Dict[str, Any] | NoComment | UpdateStatusRequired | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.confirm_account_delete_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.confirm_account_delete_request.ConfirmAccountDeleteRequest(*, token: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ConfirmAccountDeleteRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ConfirmAccountDeleteRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

token: StrictStr#

annofabapi.pydantic_models.confirm_reset_email_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.confirm_reset_email_request.ConfirmResetEmailRequest(*, token: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ConfirmResetEmailRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ConfirmResetEmailRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

token: StrictStr#

annofabapi.pydantic_models.confirm_reset_password_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.confirm_reset_password_request.ConfirmResetPasswordRequest(*, user_id: Annotated[str, Strict(strict=True)], confirmation_code: Annotated[str, Strict(strict=True)], new_password: Annotated[str, Strict(strict=True)], is_reset_mfa: Annotated[bool, Strict(strict=True)] | None = False)[source]#

Bases: BaseModel

confirmation_code: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ConfirmResetPasswordRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ConfirmResetPasswordRequest from a JSON string

is_reset_mfa: StrictBool | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

new_password: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

user_id: StrictStr#

annofabapi.pydantic_models.confirm_sign_up_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.confirm_sign_up_request.ConfirmSignUpRequest(*, account_id: Annotated[str, Strict(strict=True)], user_id: Annotated[str, Strict(strict=True)], password: Annotated[str, Strict(strict=True)], username: Annotated[str, Strict(strict=True)], lang: Lang, keylayout: KeyLayout, confirmation_code: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

account_id: StrictStr#

confirmation_code: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ConfirmSignUpRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ConfirmSignUpRequest from a JSON string

keylayout: KeyLayout#

lang: Lang#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

password: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

user_id: StrictStr#

username: StrictStr#

annofabapi.pydantic_models.confirm_verify_email_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.confirm_verify_email_request.ConfirmVerifyEmailRequest(*, token: Token, confirmation_code: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

confirmation_code: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ConfirmVerifyEmailRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ConfirmVerifyEmailRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

token: Token#

annofabapi.pydantic_models.count module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.count.Count(**data: Any)[source]#

Bases: BaseModel

aggregations: List[AggregationResult] | None#

count: StrictInt | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Count from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Count from a JSON string

key: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.count_result module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.count_result.CountResult(*, _type: Annotated[str, Strict(strict=True)], name: Annotated[str, Strict(strict=True)], field: Annotated[str, Strict(strict=True)], doc_count: Annotated[int, Strict(strict=True)] | None = None, items: List[Count])[source]#

Bases: BaseModel

doc_count: StrictInt | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of CountResult from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of CountResult from a JSON string

items: List[Count]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

var_field: StrictStr#

annofabapi.pydantic_models.data_path module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.data_path.DataPath(*, url: Annotated[str, Strict(strict=True)], path: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of DataPath from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of DataPath from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

path: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

url: StrictStr#

annofabapi.pydantic_models.date_range module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.date_range.DateRange(*, var_from: str, to: str)[source]#

Bases: BaseModel

日付の期間

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of DateRange from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of DateRange from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to: str#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

var_from: str#

annofabapi.pydantic_models.default_annotation_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.default_annotation_type.DefaultAnnotationType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

アノテーションの種類 * bounding_box - 矩形 * segmentation - 塗りつぶし（インスタンスセグメンテーション用） * segmentation_v2 - 塗りつぶしv2（セマンティックセグメンテーション用） * polygon - ポリゴン（閉じた頂点集合） * polyline - ポリライン（開いた頂点集合） * point - 点 * classification - 全体 * range - 動画の区間 * custom - カスタムプロジェクトの種類によって、使用できるアノテーションの種類は決まっています。アノテーションの種類が使用できるかどうかを、以下の表に記載しました。 * ○：使用できる * ×：使用できない |アノテーションの種類 | 画像プロジェクト | 動画プロジェクト | カスタムプロジェクト | |-----------------|:———-:|:----:|:——:| | bounding_box | 〇 | × | × | | segmentation | 〇 | × | × | | segmentation_v2 | 〇 | × | × | | polygon | 〇 | × | × | | polyline | 〇 | × | × | | point | 〇 | × | × | | classification | 〇 | 〇 | × | | range | × | 〇 | × | | custom | × | × | 〇 |

BOUNDING_BOX = 'bounding_box'#

CLASSIFICATION = 'classification'#

CUSTOM = 'custom'#

POINT = 'point'#

POLYGON = 'polygon'#

POLYLINE = 'polyline'#

RANGE = 'range'#

SEGMENTATION = 'segmentation'#

SEGMENTATION_V2 = 'segmentation_v2'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of DefaultAnnotationType from a JSON string

annofabapi.pydantic_models.delete_project_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.delete_project_response.DeleteProjectResponse(*, job: ProjectJobInfo, project: Project)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of DeleteProjectResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of DeleteProjectResponse from a JSON string

job: ProjectJobInfo#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project: Project#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.duplicated_segmentation_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.duplicated_segmentation_v2.DuplicatedSegmentationV2(*, label_id: Annotated[str, Strict(strict=True)], annotation_ids: List[Annotated[str, Strict(strict=True)]], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

塗りつぶしv2のラベルに対する1ラベルにつき1アノテーションまでの制約違反エラー

annotation_ids: List[StrictStr]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of DuplicatedSegmentationV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of DuplicatedSegmentationV2 from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.duplicated_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.duplicated_v1.DuplicatedV1(*, label_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], additional_data: AdditionalDataV1, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

値の重複が許可されていない属性の重複エラー

additional_data: AdditionalDataV1#

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of DuplicatedV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of DuplicatedV1 from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.duplicated_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.duplicated_v2.DuplicatedV2(*, label_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], additional_data_definition_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

値の重複が許可されていない属性の重複エラー

additional_data_definition_id: StrictStr#

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of DuplicatedV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of DuplicatedV2 from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.editor_usage_timespan module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.editor_usage_timespan.EditorUsageTimespan(*, editor_name: Annotated[str, Strict(strict=True)], value: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

エディタごとの利用時間

editor_name: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of EditorUsageTimespan from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of EditorUsageTimespan from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

value: StrictFloat | StrictInt#

annofabapi.pydantic_models.error_item module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.error_item.ErrorItem(*, error_code: Annotated[str, Strict(strict=True)] | None = None, message: Annotated[str, Strict(strict=True)] | None = None, ext: Dict[str, Any] | None = None)[source]#

Bases: BaseModel

error_code: StrictStr | None#

ext: Dict[str, Any] | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ErrorItem from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ErrorItem from a JSON string

message: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.errors module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.errors.Errors(*, errors: List[ErrorItem], context: Dict[str, Any])[source]#

Bases: BaseModel

context: Dict[str, Any]#

errors: List[ErrorItem]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Errors from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Errors from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.external_idp_determinant module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.external_idp_determinant.ExternalIdpDeterminant(*args, oneof_schema_1_validator: GlobalIdpNameDeterminant | None = None, oneof_schema_2_validator: OrganizationIdpIdDeterminant | None = None, oneof_schema_3_validator: UserIdDeterminant | None = None, actual_instance: GlobalIdpNameDeterminant | OrganizationIdpIdDeterminant | UserIdDeterminant | None = None, one_of_schemas: Set[str] = {'GlobalIdpNameDeterminant', 'OrganizationIdpIdDeterminant', 'UserIdDeterminant'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: GlobalIdpNameDeterminant | OrganizationIdpIdDeterminant | UserIdDeterminant | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: GlobalIdpNameDeterminant | None#

oneof_schema_2_validator: OrganizationIdpIdDeterminant | None#

oneof_schema_3_validator: UserIdDeterminant | None#

to_dict() → Dict[str, Any] | GlobalIdpNameDeterminant | OrganizationIdpIdDeterminant | UserIdDeterminant | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.full_annotation module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation.FullAnnotation(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], task_phase: TaskPhase, task_phase_stage: Annotated[int, Strict(strict=True), Ge(ge=1)], task_status: TaskStatus, input_data_id: Annotated[str, Strict(strict=True)], input_data_name: Annotated[str, Strict(strict=True)], details: List[FullAnnotationDetail], updated_datetime: str | None = None, annotation_format_version: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

annotation_format_version: StrictStr#

details: List[FullAnnotationDetail]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotation from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotation from a JSON string

input_data_id: StrictStr#

input_data_name: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

task_phase: TaskPhase#

task_phase_stage: Annotated[int, Field(strict=True, ge=1)]#

task_status: TaskStatus#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.full_annotation_additional_data module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_additional_data.FullAnnotationAdditionalData(*, additional_data_definition_id: Annotated[str, Strict(strict=True)], additional_data_definition_name: InternationalizationMessage, type: AdditionalDataDefinitionType, value: FullAnnotationAdditionalDataValue)[source]#

Bases: BaseModel

属性情報

additional_data_definition_id: StrictStr#

additional_data_definition_name: InternationalizationMessage#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationAdditionalData from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationAdditionalData from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: AdditionalDataDefinitionType#

value: FullAnnotationAdditionalDataValue#

annofabapi.pydantic_models.full_annotation_additional_data_choice_value module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_additional_data_choice_value.FullAnnotationAdditionalDataChoiceValue(*, id: Annotated[str, Strict(strict=True)], name: InternationalizationMessage)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataChoiceValue from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataChoiceValue from a JSON string

id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: InternationalizationMessage#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.full_annotation_additional_data_value module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_additional_data_value.FullAnnotationAdditionalDataValue(*args, oneof_schema_1_validator: FullAnnotationAdditionalDataValueFlag | None = None, oneof_schema_2_validator: FullAnnotationAdditionalDataValueInteger | None = None, oneof_schema_3_validator: FullAnnotationAdditionalDataValueComment | None = None, oneof_schema_4_validator: FullAnnotationAdditionalDataValueChoice | None = None, oneof_schema_5_validator: FullAnnotationAdditionalDataValueTracking | None = None, oneof_schema_6_validator: FullAnnotationAdditionalDataValueLink | None = None, actual_instance: FullAnnotationAdditionalDataValueChoice | FullAnnotationAdditionalDataValueComment | FullAnnotationAdditionalDataValueFlag | FullAnnotationAdditionalDataValueInteger | FullAnnotationAdditionalDataValueLink | FullAnnotationAdditionalDataValueTracking | None = None, one_of_schemas: Set[str] = {'FullAnnotationAdditionalDataValueChoice', 'FullAnnotationAdditionalDataValueComment', 'FullAnnotationAdditionalDataValueFlag', 'FullAnnotationAdditionalDataValueInteger', 'FullAnnotationAdditionalDataValueLink', 'FullAnnotationAdditionalDataValueTracking'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

属性値

actual_instance: FullAnnotationAdditionalDataValueChoice | FullAnnotationAdditionalDataValueComment | FullAnnotationAdditionalDataValueFlag | FullAnnotationAdditionalDataValueInteger | FullAnnotationAdditionalDataValueLink | FullAnnotationAdditionalDataValueTracking | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: FullAnnotationAdditionalDataValueFlag | None#

oneof_schema_2_validator: FullAnnotationAdditionalDataValueInteger | None#

oneof_schema_3_validator: FullAnnotationAdditionalDataValueComment | None#

oneof_schema_4_validator: FullAnnotationAdditionalDataValueChoice | None#

oneof_schema_5_validator: FullAnnotationAdditionalDataValueTracking | None#

oneof_schema_6_validator: FullAnnotationAdditionalDataValueLink | None#

to_dict() → Dict[str, Any] | FullAnnotationAdditionalDataValueChoice | FullAnnotationAdditionalDataValueComment | FullAnnotationAdditionalDataValueFlag | FullAnnotationAdditionalDataValueInteger | FullAnnotationAdditionalDataValueLink | FullAnnotationAdditionalDataValueTracking | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.full_annotation_additional_data_value_choice module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_additional_data_value_choice.FullAnnotationAdditionalDataValueChoice(*, _type: Annotated[str, Strict(strict=True)], value: FullAnnotationAdditionalDataChoiceValue | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueChoice from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueChoice from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

value: FullAnnotationAdditionalDataChoiceValue | None#

annofabapi.pydantic_models.full_annotation_additional_data_value_comment module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_additional_data_value_comment.FullAnnotationAdditionalDataValueComment(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueComment from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueComment from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

value: StrictStr | None#

annofabapi.pydantic_models.full_annotation_additional_data_value_flag module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_additional_data_value_flag.FullAnnotationAdditionalDataValueFlag(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueFlag from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueFlag from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

value: StrictBool#

annofabapi.pydantic_models.full_annotation_additional_data_value_integer module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_additional_data_value_integer.FullAnnotationAdditionalDataValueInteger(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[int, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueInteger from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueInteger from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

value: StrictInt | None#

annofabapi.pydantic_models.full_annotation_additional_data_value_link module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_additional_data_value_link.FullAnnotationAdditionalDataValueLink(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueLink from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueLink from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

value: StrictStr | None#

annofabapi.pydantic_models.full_annotation_additional_data_value_tracking module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_additional_data_value_tracking.FullAnnotationAdditionalDataValueTracking(*, _type: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueTracking from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationAdditionalDataValueTracking from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

value: StrictStr | None#

annofabapi.pydantic_models.full_annotation_data module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_data.FullAnnotationData(*args, oneof_schema_1_validator: FullAnnotationDataClassification | None = None, oneof_schema_2_validator: FullAnnotationDataSegmentation | None = None, oneof_schema_3_validator: FullAnnotationDataSegmentationV2 | None = None, oneof_schema_4_validator: FullAnnotationDataBoundingBox | None = None, oneof_schema_5_validator: FullAnnotationDataPoints | None = None, oneof_schema_6_validator: FullAnnotationDataSinglePoint | None = None, oneof_schema_7_validator: FullAnnotationDataRange | None = None, oneof_schema_8_validator: FullAnnotationDataUnknown | None = None, actual_instance: FullAnnotationDataBoundingBox | FullAnnotationDataClassification | FullAnnotationDataPoints | FullAnnotationDataRange | FullAnnotationDataSegmentation | FullAnnotationDataSegmentationV2 | FullAnnotationDataSinglePoint | FullAnnotationDataUnknown | None = None, one_of_schemas: Set[str] = {'FullAnnotationDataBoundingBox', 'FullAnnotationDataClassification', 'FullAnnotationDataPoints', 'FullAnnotationDataRange', 'FullAnnotationDataSegmentation', 'FullAnnotationDataSegmentationV2', 'FullAnnotationDataSinglePoint', 'FullAnnotationDataUnknown'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

アノテーションのデータが格納されます。 * FullAnnotationDataClassification: 入力データ全体アノテーション * FullAnnotationDataSegmentation: 塗りつぶしアノテーション * FullAnnotationDataSegmentationV2: 塗りつぶしv2アノテーション * FullAnnotationDataBoundingBox: 矩形アノテーション * FullAnnotationDataPoints: ポリゴンまたはポリラインアノテーション * FullAnnotationDataSinglePoint: 点アノテーション * FullAnnotationDataRange: 動画区間アノテーション * FullAnnotationDataUnknown: カスタムアノテーション

actual_instance: FullAnnotationDataBoundingBox | FullAnnotationDataClassification | FullAnnotationDataPoints | FullAnnotationDataRange | FullAnnotationDataSegmentation | FullAnnotationDataSegmentationV2 | FullAnnotationDataSinglePoint | FullAnnotationDataUnknown | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: FullAnnotationDataClassification | None#

oneof_schema_2_validator: FullAnnotationDataSegmentation | None#

oneof_schema_3_validator: FullAnnotationDataSegmentationV2 | None#

oneof_schema_4_validator: FullAnnotationDataBoundingBox | None#

oneof_schema_5_validator: FullAnnotationDataPoints | None#

oneof_schema_6_validator: FullAnnotationDataSinglePoint | None#

oneof_schema_7_validator: FullAnnotationDataRange | None#

oneof_schema_8_validator: FullAnnotationDataUnknown | None#

to_dict() → Dict[str, Any] | FullAnnotationDataBoundingBox | FullAnnotationDataClassification | FullAnnotationDataPoints | FullAnnotationDataRange | FullAnnotationDataSegmentation | FullAnnotationDataSegmentationV2 | FullAnnotationDataSinglePoint | FullAnnotationDataUnknown | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.full_annotation_data_bounding_box module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_data_bounding_box.FullAnnotationDataBoundingBox(*, left_top: Point, right_bottom: Point, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationDataBoundingBox from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationDataBoundingBox from a JSON string

left_top: Point#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

right_bottom: Point#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.full_annotation_data_classification module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_data_classification.FullAnnotationDataClassification(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationDataClassification from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationDataClassification from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.full_annotation_data_points module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_data_points.FullAnnotationDataPoints(*, points: List[Point], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationDataPoints from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationDataPoints from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

points: List[Point]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.full_annotation_data_range module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_data_range.FullAnnotationDataRange(*, begin: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], end: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

begin: StrictFloat | StrictInt#

end: StrictFloat | StrictInt#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationDataRange from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationDataRange from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.full_annotation_data_segmentation module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_data_segmentation.FullAnnotationDataSegmentation(*, data_uri: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

data_uri: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationDataSegmentation from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationDataSegmentation from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.full_annotation_data_segmentation_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_data_segmentation_v2.FullAnnotationDataSegmentationV2(*, data_uri: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

data_uri: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationDataSegmentationV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationDataSegmentationV2 from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.full_annotation_data_single_point module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_data_single_point.FullAnnotationDataSinglePoint(*, point: Point, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationDataSinglePoint from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationDataSinglePoint from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

point: Point#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.full_annotation_data_unknown module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_data_unknown.FullAnnotationDataUnknown(*, data: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

data: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationDataUnknown from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationDataUnknown from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.full_annotation_detail module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.full_annotation_detail.FullAnnotationDetail(*, annotation_id: Annotated[str, Strict(strict=True)], user_id: Annotated[str, Strict(strict=True)], label_id: Annotated[str, Strict(strict=True)], label_name: InternationalizationMessage, annotation_type: AnnotationType, data_holding_type: AnnotationDataHoldingType, data: FullAnnotationData, additional_data_list: List[FullAnnotationAdditionalData])[source]#

Bases: BaseModel

additional_data_list: List[FullAnnotationAdditionalData]#

annotation_id: StrictStr#

annotation_type: AnnotationType#

data: FullAnnotationData#

data_holding_type: AnnotationDataHoldingType#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of FullAnnotationDetail from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of FullAnnotationDetail from a JSON string

label_id: StrictStr#

label_name: InternationalizationMessage#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

user_id: StrictStr#

annofabapi.pydantic_models.get_editor_annotations_in_bulk_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.get_editor_annotations_in_bulk_response.GetEditorAnnotationsInBulkResponse(*, success: List[AnnotationV2Output], failure: List[AnnotationsByInputDataIdIdentifier])[source]#

Bases: BaseModel

複数の入力データにわたるアノテーション取得時のレスポンス

failure: List[AnnotationsByInputDataIdIdentifier]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of GetEditorAnnotationsInBulkResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of GetEditorAnnotationsInBulkResponse from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

success: List[AnnotationV2Output]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.get_input_data_in_bulk_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.get_input_data_in_bulk_response.GetInputDataInBulkResponse(*, success: List[InputData], failure: List[InputDataIdentifier])[source]#

Bases: BaseModel

複数の入力データ取得時のレスポンス

failure: List[InputDataIdentifier]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of GetInputDataInBulkResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of GetInputDataInBulkResponse from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

success: List[InputData]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.get_supplementary_data_in_bulk_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.get_supplementary_data_in_bulk_response.GetSupplementaryDataInBulkResponse(*, success: List[SupplementaryData], failure: List[SupplementaryDataByInputDataIdIdentifier])[source]#

Bases: BaseModel

複数の入力データにわたる補助情報取得時のレスポンス

failure: List[SupplementaryDataByInputDataIdIdentifier]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of GetSupplementaryDataInBulkResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of GetSupplementaryDataInBulkResponse from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

success: List[SupplementaryData]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.get_tasks_in_bulk_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.get_tasks_in_bulk_response.GetTasksInBulkResponse(*, success: List[Task], failure: List[TaskIdentifier])[source]#

Bases: BaseModel

複数のタスク取得時のレスポンス

failure: List[TaskIdentifier]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of GetTasksInBulkResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of GetTasksInBulkResponse from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

success: List[Task]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.global_idp_name_determinant module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.global_idp_name_determinant.GlobalIdpNameDeterminant(*, _type: Annotated[str, Strict(strict=True)], name: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

Annofab全体で利用するIDプロバイダー名を元に外部IDプロバイダーを特定する決定因子

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of GlobalIdpNameDeterminant from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of GlobalIdpNameDeterminant from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr#

classmethod name_validate_enum(value)[source]#: Validates the enum

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.graph_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.graph_type.GraphType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

グラフの種類 * task_progress - タスク進捗状況 * cumulative_labor_time_by_task_phase - タスクフェーズ別累積作業時間 * number_of_inspections_per_inspection_phrase - 検査コメント内容別指摘回数 * number_of_task_rejections_by_member - メンバー別タスクが差戻された回数 * labor_time_per_member - メンバー別作業時間 * mean_labor_time_per_image - 画像一枚当たりの作業時間平均 * mean_labor_time_per_minute_of_movie - 動画一分当たりの作業時間平均 * mean_labor_time_per_image_by_member - メンバー別画像一枚当たりの作業時間平均 * mean_labor_time_per_minute_of_movie_by_member - メンバー別動画一分当たりの作業時間平均

CUMULATIVE_LABOR_TIME_BY_TASK_PHASE = 'cumulative_labor_time_By_task_phase'#

LABOR_TIME_PER_MEMBER = 'labor_time_per_member'#

MEAN_LABOR_TIME_PER_IMAGE = 'mean_labor_time_per_image'#

MEAN_LABOR_TIME_PER_IMAGE_BY_MEMBER = 'mean_labor_time_per_image_by_member'#

MEAN_LABOR_TIME_PER_MINUTE_OF_MOVIE = 'mean_labor_time_per_minute_of_movie'#

MEAN_LABOR_TIME_PER_MINUTE_OF_MOVIE_BY_MEMBER = 'mean_labor_time_per_minute_of_movie_by_member'#

NUMBER_OF_INSPECTIONS_PER_INSPECTION_PHRASE = 'number_of_inspections_per_inspection_phrase'#

NUMBER_OF_TASK_REJECTIONS_BY_MEMBER = 'number_of_task_rejections_by_member'#

TASK_PROGRESS = 'task_progress'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of GraphType from a JSON string

annofabapi.pydantic_models.histogram_item module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.histogram_item.HistogramItem(*, begin: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], end: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], count: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

begin: StrictFloat | StrictInt#

count: StrictInt#

end: StrictFloat | StrictInt#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of HistogramItem from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of HistogramItem from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.illegal_state module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.illegal_state.IllegalState(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

作業が開始されていない、担当が割り当たっていない等のエラー

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of IllegalState from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of IllegalState from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.initiate_mfa_setup_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.initiate_mfa_setup_request.InitiateMfaSetupRequest(*, access_token: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

access_token: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InitiateMfaSetupRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InitiateMfaSetupRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.initiate_mfa_setup_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.initiate_mfa_setup_response.InitiateMfaSetupResponse(*, secret_code: Annotated[str, Strict(strict=True)], qr_code_data: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InitiateMfaSetupResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InitiateMfaSetupResponse from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

qr_code_data: StrictStr#

secret_code: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.input_data module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.input_data.InputData(*, input_data_id: Annotated[str, Strict(strict=True)], project_id: Annotated[str, Strict(strict=True)], organization_id: Annotated[str, Strict(strict=True)], input_data_set_id: Annotated[str, Strict(strict=True)], input_data_name: Annotated[str, Strict(strict=True)], input_data_path: Annotated[str, Strict(strict=True)], url: Annotated[str, Strict(strict=True)] | None = None, etag: Annotated[str, Strict(strict=True)] | None = None, original_input_data_path: Annotated[str, Strict(strict=True)] | None = None, updated_datetime: str, sign_required: Annotated[bool, Strict(strict=True)], metadata: Dict[str, Annotated[str, Strict(strict=True)]], system_metadata: SystemMetadata)[source]#

Bases: BaseModel

入力データの情報を表すデータ構造です。

etag: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InputData from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InputData from a JSON string

input_data_id: StrictStr#

input_data_name: StrictStr#

input_data_path: StrictStr#

input_data_set_id: StrictStr#

metadata: Dict[str, StrictStr]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr#

original_input_data_path: StrictStr | None#

project_id: StrictStr#

sign_required: StrictBool#

system_metadata: SystemMetadata#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

url: StrictStr | None#

annofabapi.pydantic_models.input_data_identifier module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.input_data_identifier.InputDataIdentifier(*, project_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

入力データを指定するための情報

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InputDataIdentifier from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InputDataIdentifier from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.input_data_list module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.input_data_list.InputDataList(*, list: List[InputData], page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_count: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], over_limit: Annotated[bool, Strict(strict=True)], aggregations: List[AggregationResult])[source]#

Bases: BaseModel

aggregations: List[AggregationResult]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InputDataList from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InputDataList from a JSON string

list: List[InputData]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

over_limit: StrictBool#

page_no: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

total_count: StrictFloat | StrictInt#

total_page_no: StrictFloat | StrictInt#

annofabapi.pydantic_models.input_data_order module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.input_data_order.InputDataOrder(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

タスクに割り当てる入力データの順序 * name_asc - 入力データ名の昇順 * name_desc - 入力データ名の降順 * random - ランダム

NAME_ASC = 'name_asc'#

NAME_DESC = 'name_desc'#

RANDOM = 'random'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of InputDataOrder from a JSON string

annofabapi.pydantic_models.input_data_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.input_data_request.InputDataRequest(*, input_data_name: Annotated[str, Strict(strict=True)], input_data_path: Annotated[str, Strict(strict=True)], last_updated_datetime: str | None = None, sign_required: Annotated[bool, Strict(strict=True)] | None = None, metadata: Dict[str, Annotated[str, Strict(strict=True)]] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InputDataRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InputDataRequest from a JSON string

input_data_name: StrictStr#

input_data_path: StrictStr#

last_updated_datetime: str | None#

metadata: Dict[str, StrictStr] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sign_required: StrictBool | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.input_data_set module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.input_data_set.InputDataSet(*, input_data_set_id: Annotated[str, Strict(strict=True)], input_data_set_name: Annotated[str, Strict(strict=True)], organization_id: Annotated[str, Strict(strict=True)], input_data_type: InputDataType, private_storage_arn: Annotated[str, Strict(strict=True)] | None = None, updated_datetime: str)[source]#

Bases: BaseModel

入力データセットの情報を表すデータ構造です。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InputDataSet from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InputDataSet from a JSON string

input_data_set_id: StrictStr#

input_data_set_name: StrictStr#

input_data_type: InputDataType#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr#

private_storage_arn: StrictStr | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.input_data_summary module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.input_data_summary.InputDataSummary(*, input_data_id: Annotated[str, Strict(strict=True)], inspection_summary: InspectionSummary, annotation_summaries: List[ValidationError])[source]#

Bases: BaseModel

ある入力データのバリデーション結果です。入力データIDをキーに引けるようにMap[入力データID, バリデーション結果]となっています

annotation_summaries: List[ValidationError]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InputDataSummary from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InputDataSummary from a JSON string

input_data_id: StrictStr#

inspection_summary: InspectionSummary#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.input_data_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.input_data_type.InputDataType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

アノテーションする入力データの種類。 * image - 画像 * movie - 動画 * custom - カスタム

CUSTOM = 'custom'#

IMAGE = 'image'#

MOVIE = 'movie'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of InputDataType from a JSON string

annofabapi.pydantic_models.inspection module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection.Inspection(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], inspection_id: Annotated[str, Strict(strict=True)], phase: TaskPhase, phase_stage: Annotated[int, Strict(strict=True), Ge(ge=1)], commenter_account_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)] | None = None, label_id: Annotated[str, Strict(strict=True)] | None = None, data: InspectionData, parent_inspection_id: Annotated[str, Strict(strict=True)] | None = None, phrases: List[Annotated[str, Strict(strict=True)]] | None = None, comment: Annotated[str, Strict(strict=True)], status: InspectionStatus, created_datetime: str, updated_datetime: str | None = None)[source]#

Bases: BaseModel

検査コメント

annotation_id: StrictStr | None#

comment: StrictStr#

commenter_account_id: StrictStr#

created_datetime: str#

data: InspectionData#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Inspection from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Inspection from a JSON string

input_data_id: StrictStr#

inspection_id: StrictStr#

label_id: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

parent_inspection_id: StrictStr | None#

phase: TaskPhase#

phase_stage: Annotated[int, Field(strict=True, ge=1)]#

phrases: List[StrictStr] | None#

project_id: StrictStr#

status: InspectionStatus#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.inspection_data module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_data.InspectionData(*args, oneof_schema_1_validator: InspectionDataPoint | None = None, oneof_schema_2_validator: InspectionDataPolyline | None = None, oneof_schema_3_validator: InspectionDataTime | None = None, oneof_schema_4_validator: InspectionDataCustom | None = None, actual_instance: InspectionDataCustom | InspectionDataPoint | InspectionDataPolyline | InspectionDataTime | None = None, one_of_schemas: Set[str] = {'InspectionDataCustom', 'InspectionDataPoint', 'InspectionDataPolyline', 'InspectionDataTime'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

##### スレッドの先頭のコメントである（parent_inspection_id に値がない）場合検査コメントの座標値や区間。 * InspectionDataPoint：点で検査コメントを付与したときの座標値 * InspectionDataPolyline：ポリラインで検査コメントを付与したときの座標値 * InspectionDataTime：検査コメントを付与した区間（動画プロジェクトの場合） * InspectionDataCustom：カスタム ##### 返信コメントである（parent_inspection_id に値がある）場合現在は使用しておらず、レスポンスに含まれる値は不定です。APIのレスポンスにこの値を含む場合でも、「スレッドの先頭のコメント」の値を利用してください。リクエストボディに指定する場合は、スレッドの先頭のコメントと同じ値を指定します。

actual_instance: InspectionDataCustom | InspectionDataPoint | InspectionDataPolyline | InspectionDataTime | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: InspectionDataPoint | None#

oneof_schema_2_validator: InspectionDataPolyline | None#

oneof_schema_3_validator: InspectionDataTime | None#

oneof_schema_4_validator: InspectionDataCustom | None#

to_dict() → Dict[str, Any] | InspectionDataCustom | InspectionDataPoint | InspectionDataPolyline | InspectionDataTime | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.inspection_data_custom module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_data_custom.InspectionDataCustom(*, data: Annotated[str, Strict(strict=True)] | None = None, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

data: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InspectionDataCustom from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InspectionDataCustom from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.inspection_data_point module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_data_point.InspectionDataPoint(*, x: Annotated[int, Strict(strict=True)], y: Annotated[int, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

問題のある部分を示す座標

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InspectionDataPoint from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InspectionDataPoint from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

x: StrictInt#

y: StrictInt#

annofabapi.pydantic_models.inspection_data_polyline module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_data_polyline.InspectionDataPolyline(*, coordinates: List[InspectionDataPolylineCoordinatesInner], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

問題のある部分を示すポリライン

coordinates: List[InspectionDataPolylineCoordinatesInner]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InspectionDataPolyline from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InspectionDataPolyline from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.inspection_data_polyline_coordinates_inner module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_data_polyline_coordinates_inner.InspectionDataPolylineCoordinatesInner(*, x: Annotated[int, Strict(strict=True)] | None = None, y: Annotated[int, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InspectionDataPolylineCoordinatesInner from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InspectionDataPolylineCoordinatesInner from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

x: StrictInt | None#

y: StrictInt | None#

annofabapi.pydantic_models.inspection_data_time module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_data_time.InspectionDataTime(*, start: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], end: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

問題のある時間帯を表す区間

end: StrictFloat | StrictInt#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InspectionDataTime from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InspectionDataTime from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

start: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.inspection_or_reply_required module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_or_reply_required.InspectionOrReplyRequired(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

新規検査コメントまたは未対応検査コメントへの返信が必要である時のエラー

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InspectionOrReplyRequired from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InspectionOrReplyRequired from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.inspection_phrase module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_phrase.InspectionPhrase(*, id: Annotated[str, Strict(strict=True)], text: InternationalizationMessage)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InspectionPhrase from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InspectionPhrase from a JSON string

id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

text: InternationalizationMessage#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.inspection_statistics module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_statistics.InspectionStatistics(*, project_id: Annotated[str, Strict(strict=True)], date: str, breakdown: InspectionStatisticsBreakdown)[source]#

Bases: BaseModel

breakdown: InspectionStatisticsBreakdown#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InspectionStatistics from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InspectionStatistics from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

var_date: str#

annofabapi.pydantic_models.inspection_statistics_breakdown module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_statistics_breakdown.InspectionStatisticsBreakdown(*, labels: Dict[str, InspectionStatisticsPhrases], no_label: InspectionStatisticsPhrases)[source]#

Bases: BaseModel

検査コメント数の集計結果

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InspectionStatisticsBreakdown from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InspectionStatisticsBreakdown from a JSON string

labels: Dict[str, InspectionStatisticsPhrases]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

no_label: InspectionStatisticsPhrases#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.inspection_statistics_phrases module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_statistics_phrases.InspectionStatisticsPhrases(*, phrases: Dict[str, Annotated[int, Strict(strict=True)]], no_phrase: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InspectionStatisticsPhrases from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InspectionStatisticsPhrases from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

no_phrase: StrictInt#

phrases: Dict[str, StrictInt]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.inspection_status module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_status.InspectionStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

##### スレッドの先頭のコメントである（parent_inspection_id に値がない）場合 * annotator_action_required - 未処置。annotation`フェーズ担当者が何らかの回答をする必要あり * `no_correction_required - 処置不要。annotation`フェーズ担当者が、検査コメントによる修正は不要、と回答した * `error_corrected - 修正済み。annotation`フェーズ担当者が、検査コメントの指示どおり修正した ##### 返信コメントである（`parent_inspection_id に値がある）場合現在は使用しておらず、レスポンスに含まれる値は不定です。APIのレスポンスにこの値を含む場合でも、「スレッドの先頭のコメント」の値を利用してください。リクエストボディに指定する場合は、スレッドの先頭のコメントと同じ値を指定します。

ANNOTATOR_ACTION_REQUIRED = 'annotator_action_required'#

ERROR_CORRECTED = 'error_corrected'#

NO_CORRECTION_REQUIRED = 'no_correction_required'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of InspectionStatus from a JSON string

annofabapi.pydantic_models.inspection_summary module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_summary.InspectionSummary(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

no_inspection - 入力データに検査コメントが付けられていない。 - no_comment_inspection - 入力データに空の検査コメントが付けられている。 - new_reply_to_unprocessed - 現在進行中の検査・受入フェーズで未処理の検査コメントに対して新たに返信が付けられている。 - new_unprocessed_inspection - 現在進行中の検査・受入フェーズでつけられた検査コメントのうち、未処理のものが1つ以上ある。 - unprocessed - 過去の検査・受入フェーズでつけられた検査コメントのうち、未処理のものが1つ以上ある。 - complete - 入力データにつけられた検査コメントで未処理のものがない。

COMPLETE = 'complete'#

NEW_REPLY_TO_UNPROCESSED = 'new_reply_to_unprocessed'#

NEW_UNPROCESSED_INSPECTION = 'new_unprocessed_inspection'#

NO_COMMENT_INSPECTION = 'no_comment_inspection'#

NO_INSPECTION = 'no_inspection'#

UNPROCESSED = 'unprocessed'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of InspectionSummary from a JSON string

annofabapi.pydantic_models.inspection_validation_error module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.inspection_validation_error.InspectionValidationError(*args, oneof_schema_1_validator: NoCommentInspection | None = None, oneof_schema_2_validator: ReplyRequired | None = None, oneof_schema_3_validator: ActionRequired | None = None, oneof_schema_4_validator: InspectionOrReplyRequired | None = None, oneof_schema_5_validator: IllegalState | None = None, actual_instance: ActionRequired | IllegalState | InspectionOrReplyRequired | NoCommentInspection | ReplyRequired | None = None, one_of_schemas: Set[str] = {'ActionRequired', 'IllegalState', 'InspectionOrReplyRequired', 'NoCommentInspection', 'ReplyRequired'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: ActionRequired | IllegalState | InspectionOrReplyRequired | NoCommentInspection | ReplyRequired | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: NoCommentInspection | None#

oneof_schema_2_validator: ReplyRequired | None#

oneof_schema_3_validator: ActionRequired | None#

oneof_schema_4_validator: InspectionOrReplyRequired | None#

oneof_schema_5_validator: IllegalState | None#

to_dict() → Dict[str, Any] | ActionRequired | IllegalState | InspectionOrReplyRequired | NoCommentInspection | ReplyRequired | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.instruction module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.instruction.Instruction(*, html: Annotated[str, Strict(strict=True)], last_updated_datetime: str)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Instruction from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Instruction from a JSON string

html: StrictStr#

last_updated_datetime: str#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.instruction_history module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.instruction_history.InstructionHistory(*, history_id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], updated_datetime: str)[source]#

Bases: BaseModel

account_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InstructionHistory from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InstructionHistory from a JSON string

history_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.instruction_image module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.instruction_image.InstructionImage(*, image_id: Annotated[str, Strict(strict=True)], path: Annotated[str, Strict(strict=True)], url: Annotated[str, Strict(strict=True)], etag: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

etag: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InstructionImage from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InstructionImage from a JSON string

image_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

path: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

url: StrictStr#

annofabapi.pydantic_models.instruction_image_path module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.instruction_image_path.InstructionImagePath(*, url: Annotated[str, Strict(strict=True)], path: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InstructionImagePath from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InstructionImagePath from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

path: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

url: StrictStr#

annofabapi.pydantic_models.internationalization_message module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.internationalization_message.InternationalizationMessage(*, messages: List[InternationalizationMessageMessagesInner], default_lang: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

default_lang: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InternationalizationMessage from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InternationalizationMessage from a JSON string

messages: List[InternationalizationMessageMessagesInner]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.internationalization_message_messages_inner module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.internationalization_message_messages_inner.InternationalizationMessageMessagesInner(*, lang: Annotated[str, Strict(strict=True)], message: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InternationalizationMessageMessagesInner from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InternationalizationMessageMessagesInner from a JSON string

lang: StrictStr#

message: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.invalid_annotation_data module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.invalid_annotation_data.InvalidAnnotationData(*, label_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], message: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

アノテーションデータ不正エラー

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InvalidAnnotationData from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InvalidAnnotationData from a JSON string

label_id: StrictStr#

message: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.invalid_choice module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.invalid_choice.InvalidChoice(*, label_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], additional_data_definition_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

選択肢不正エラー

additional_data_definition_id: StrictStr#

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InvalidChoice from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InvalidChoice from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.invalid_link_target module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.invalid_link_target.InvalidLinkTarget(*, label_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], additional_data_definition_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

リンク先アノテーションが許可されているラベルでないエラー

additional_data_definition_id: StrictStr#

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InvalidLinkTarget from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InvalidLinkTarget from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.invalid_value module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.invalid_value.InvalidValue(*, label_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], additional_data_definition_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

値制約に合致しないエラー

additional_data_definition_id: StrictStr#

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InvalidValue from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InvalidValue from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.invite_organization_member_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.invite_organization_member_request.InviteOrganizationMemberRequest(*, role: OrganizationMemberRole)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of InviteOrganizationMemberRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of InviteOrganizationMemberRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

role: OrganizationMemberRole#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.issue_personal_access_token_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.issue_personal_access_token_request.IssuePersonalAccessTokenRequest(*, id: Annotated[str, Strict(strict=True)], note: Annotated[str, Strict(strict=True)], expiration: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)] | None = None, permissions: List[PersonalAccessTokenPermission])[source]#

Bases: BaseModel

expiration: StrictFloat | StrictInt | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of IssuePersonalAccessTokenRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of IssuePersonalAccessTokenRequest from a JSON string

id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

note: StrictStr#

permissions: List[PersonalAccessTokenPermission]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.issue_project_guest_user_token_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.issue_project_guest_user_token_request.IssueProjectGuestUserTokenRequest(*, project_id: Annotated[str, Strict(strict=True)], app_token: Annotated[str, Strict(strict=True)], project_token: Annotated[str, Strict(strict=True)], role: Annotated[str, Strict(strict=True)], profile: ProjectGuestUserProfile)[source]#

Bases: BaseModel

app_token: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of IssueProjectGuestUserTokenRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of IssueProjectGuestUserTokenRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

profile: ProjectGuestUserProfile#

project_id: StrictStr#

project_token: StrictStr#

role: StrictStr#

classmethod role_validate_enum(value)[source]#: Validates the enum

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.issue_project_token_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.issue_project_token_request.IssueProjectTokenRequest(*, project_id: Annotated[str, Strict(strict=True)], description: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

description: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of IssueProjectTokenRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of IssueProjectTokenRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.issuer_only_oidc_endpoints module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.issuer_only_oidc_endpoints.IssuerOnlyOidcEndpoints(*, _type: Annotated[str, Strict(strict=True)], issuer: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

OIDCエンドポイント

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of IssuerOnlyOidcEndpoints from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of IssuerOnlyOidcEndpoints from a JSON string

issuer: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.job_detail module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.job_detail.JobDetail(*args, oneof_schema_1_validator: JobDetailGenInputs | None = None, oneof_schema_2_validator: JobDetailGenTasks | None = None, oneof_schema_3_validator: JobDetailCopyProject | None = None, oneof_schema_4_validator: JobDetailMoveProject | None = None, oneof_schema_5_validator: JobDetailInvokeHook | None = None, actual_instance: JobDetailCopyProject | JobDetailGenInputs | JobDetailGenTasks | JobDetailInvokeHook | JobDetailMoveProject | None = None, one_of_schemas: Set[str] = {'JobDetailCopyProject', 'JobDetailGenInputs', 'JobDetailGenTasks', 'JobDetailInvokeHook', 'JobDetailMoveProject'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

ジョブ結果の内部情報

actual_instance: JobDetailCopyProject | JobDetailGenInputs | JobDetailGenTasks | JobDetailInvokeHook | JobDetailMoveProject | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: JobDetailGenInputs | None#

oneof_schema_2_validator: JobDetailGenTasks | None#

oneof_schema_3_validator: JobDetailCopyProject | None#

oneof_schema_4_validator: JobDetailMoveProject | None#

oneof_schema_5_validator: JobDetailInvokeHook | None#

to_dict() → Dict[str, Any] | JobDetailCopyProject | JobDetailGenInputs | JobDetailGenTasks | JobDetailInvokeHook | JobDetailMoveProject | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.job_detail_copy_project module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.job_detail_copy_project.JobDetailCopyProject(*, request: ProjectCopyRequest)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of JobDetailCopyProject from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of JobDetailCopyProject from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

request: ProjectCopyRequest#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.job_detail_gen_inputs module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.job_detail_gen_inputs.JobDetailGenInputs(*, request: InputDataRequest)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of JobDetailGenInputs from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of JobDetailGenInputs from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

request: InputDataRequest#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.job_detail_gen_tasks module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.job_detail_gen_tasks.JobDetailGenTasks(*, request: TaskGenerateRequest, generated_task_count: Annotated[int, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of JobDetailGenTasks from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of JobDetailGenTasks from a JSON string

generated_task_count: StrictInt | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

request: TaskGenerateRequest#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.job_detail_invoke_hook module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.job_detail_invoke_hook.JobDetailInvokeHook(*, webhook: Webhook, message: Annotated[str, Strict(strict=True)] | None = None, replaced_body: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of JobDetailInvokeHook from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of JobDetailInvokeHook from a JSON string

message: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

replaced_body: StrictStr | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

webhook: Webhook#

annofabapi.pydantic_models.job_detail_move_project module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.job_detail_move_project.JobDetailMoveProject(*, src_organization_id: Annotated[str, Strict(strict=True)], dest_organization_id: Annotated[str, Strict(strict=True)], src_input_data_set_id: Annotated[str, Strict(strict=True)], dest_input_data_set_id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

dest_input_data_set_id: StrictStr#

dest_organization_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of JobDetailMoveProject from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of JobDetailMoveProject from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

src_input_data_set_id: StrictStr#

src_organization_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.job_status module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.job_status.JobStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

ジョブのステータス

FAILED = 'failed'#

PROGRESS = 'progress'#

SUCCEEDED = 'succeeded'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of JobStatus from a JSON string

annofabapi.pydantic_models.key_layout module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.key_layout.KeyLayout(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

キーボードレイアウト * ja-JP - 日本語(106/109)配列 * en-US - 英語(101/104)配列 * other - その他

EN_MINUS_US = 'en-US'#

JA_MINUS_JP = 'ja-JP'#

OTHER = 'other'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of KeyLayout from a JSON string

annofabapi.pydantic_models.keybind module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.keybind.Keybind(*, code: Annotated[str, Strict(strict=True)], shift: Annotated[bool, Strict(strict=True)], ctrl: Annotated[bool, Strict(strict=True)], alt: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

alt: StrictBool#

code: StrictStr#

ctrl: StrictBool#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Keybind from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Keybind from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

shift: StrictBool#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.label_statistics module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.label_statistics.LabelStatistics(*, label_id: Annotated[str, Strict(strict=True)], completed: Annotated[int, Strict(strict=True), Ge(ge=0)], wip: Annotated[int, Strict(strict=True), Ge(ge=0)])[source]#

Bases: BaseModel

completed: Annotated[int, Field(strict=True, ge=0)]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of LabelStatistics from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of LabelStatistics from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

wip: Annotated[int, Field(strict=True, ge=0)]#

annofabapi.pydantic_models.label_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.label_v1.LabelV1(*, label_id: Annotated[str, Strict(strict=True)], label_name: InternationalizationMessage, keybind: List[Keybind], annotation_type: AnnotationType, bounding_box_metadata: BoundingBoxMetadata | None = None, segmentation_metadata: SegmentationMetadata | None = None, additional_data_definitions: List[AdditionalDataDefinitionV1], color: Color, annotation_editor_feature: AnnotationEditorFeature, metadata: Dict[str, Annotated[str, Strict(strict=True)]] | None = None)[source]#

Bases: BaseModel

additional_data_definitions: List[AdditionalDataDefinitionV1]#

annotation_editor_feature: AnnotationEditorFeature#

annotation_type: AnnotationType#

bounding_box_metadata: BoundingBoxMetadata | None#

color: Color#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of LabelV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of LabelV1 from a JSON string

keybind: List[Keybind]#

label_id: StrictStr#

label_name: InternationalizationMessage#

metadata: Dict[str, StrictStr] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

segmentation_metadata: SegmentationMetadata | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.label_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.label_v2.LabelV2(*, label_id: Annotated[str, Strict(strict=True)], label_name: InternationalizationMessage, keybind: List[Keybind], annotation_type: AnnotationType, bounding_box_metadata: BoundingBoxMetadata | None = None, segmentation_metadata: SegmentationMetadata | None = None, additional_data_definitions: List[Annotated[str, Strict(strict=True)]], color: Color, annotation_editor_feature: AnnotationEditorFeature, metadata: Dict[str, Annotated[str, Strict(strict=True)]] | None = None)[source]#

Bases: BaseModel

additional_data_definitions: List[StrictStr]#

annotation_editor_feature: AnnotationEditorFeature#

annotation_type: AnnotationType#

bounding_box_metadata: BoundingBoxMetadata | None#

color: Color#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of LabelV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of LabelV2 from a JSON string

keybind: List[Keybind]#

label_id: StrictStr#

label_name: InternationalizationMessage#

metadata: Dict[str, StrictStr] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

segmentation_metadata: SegmentationMetadata | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.label_v3 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.label_v3.LabelV3(*, label_id: Annotated[str, Strict(strict=True)], label_name: InternationalizationMessage, keybind: List[Keybind], annotation_type: AnnotationType, field_values: Dict[str, AnnotationTypeFieldValue], additional_data_definitions: List[Annotated[str, Strict(strict=True)]], color: Color, metadata: Dict[str, Annotated[str, Strict(strict=True)]] | None = None)[source]#

Bases: BaseModel

additional_data_definitions: List[StrictStr]#

annotation_type: AnnotationType#

color: Color#

field_values: Dict[str, AnnotationTypeFieldValue]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of LabelV3 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of LabelV3 from a JSON string

keybind: List[Keybind]#

label_id: StrictStr#

label_name: InternationalizationMessage#

metadata: Dict[str, StrictStr] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.lang module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.lang.Lang(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

表示言語 * ja-JP - 日本語 * en-US - 英語 * vi-VN - ベトナム語

EN_MINUS_US = 'en-US'#

JA_MINUS_JP = 'ja-JP'#

VI_MINUS_VN = 'vi-VN'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of Lang from a JSON string

annofabapi.pydantic_models.login_need_challenge_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.login_need_challenge_response.LoginNeedChallengeResponse(*, session: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of LoginNeedChallengeResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of LoginNeedChallengeResponse from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

session: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.login_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.login_request.LoginRequest(*, user_id: Annotated[str, Strict(strict=True)], password: SecretStr)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of LoginRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of LoginRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

password: SecretStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

user_id: StrictStr#

annofabapi.pydantic_models.login_respond_to_auth_challenge_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.login_respond_to_auth_challenge_request.LoginRespondToAuthChallengeRequest(*, user_id: Annotated[str, Strict(strict=True)], mfa_code: Annotated[str, Strict(strict=True)], session: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of LoginRespondToAuthChallengeRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of LoginRespondToAuthChallengeRequest from a JSON string

mfa_code: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

session: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

user_id: StrictStr#

annofabapi.pydantic_models.login_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.login_response.LoginResponse(*args, oneof_schema_1_validator: LoginSucceedResponse | None = None, oneof_schema_2_validator: LoginNeedChallengeResponse | None = None, actual_instance: LoginNeedChallengeResponse | LoginSucceedResponse | None = None, one_of_schemas: Set[str] = {'LoginNeedChallengeResponse', 'LoginSucceedResponse'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: LoginNeedChallengeResponse | LoginSucceedResponse | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: LoginSucceedResponse | None#

oneof_schema_2_validator: LoginNeedChallengeResponse | None#

to_dict() → Dict[str, Any] | LoginNeedChallengeResponse | LoginSucceedResponse | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.login_succeed_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.login_succeed_response.LoginSucceedResponse(*, token: Token)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of LoginSucceedResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of LoginSucceedResponse from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

token: Token#

annofabapi.pydantic_models.marker module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.marker.Marker(*, marker_id: Annotated[str, Strict(strict=True)], title: Annotated[str, Strict(strict=True)], graph_type: GraphType, marked_at: str)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Marker from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Marker from a JSON string

graph_type: GraphType#

marked_at: str#

marker_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

title: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.markers module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.markers.Markers(*, project_id: Annotated[str, Strict(strict=True)], markers: List[Marker], updated_datetime: str | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Markers from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Markers from a JSON string

markers: List[Marker]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.message module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.message.Message(*, message: Annotated[str, Strict(strict=True)], message_id: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Message from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Message from a JSON string

message: StrictStr#

message_id: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.message_or_job_info module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.message_or_job_info.MessageOrJobInfo(*args, oneof_schema_1_validator: Message | None = None, oneof_schema_2_validator: ProjectJobInfo | None = None, actual_instance: Message | ProjectJobInfo | None = None, one_of_schemas: Set[str] = {'Message', 'ProjectJobInfo'})[source]#

Bases: BaseModel

actual_instance: Message | ProjectJobInfo | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: Message | None#

oneof_schema_2_validator: ProjectJobInfo | None#

to_dict() → Dict[str, Any] | Message | ProjectJobInfo | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.mfa_setting module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.mfa_setting.MfaSetting(*, enabled: Annotated[bool, Strict(strict=True)], is_updatable: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

enabled: StrictBool#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of MfaSetting from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of MfaSetting from a JSON string

is_updatable: StrictBool#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.my_account module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.my_account.MyAccount(*, account_id: Annotated[str, Strict(strict=True)], user_id: Annotated[str, Strict(strict=True)], username: Annotated[str, Strict(strict=True)], email: Annotated[str, Strict(strict=True)], lang: Lang, biography: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=0), MaxLen(max_length=100)])] | None = None, keylayout: KeyLayout, authority: Annotated[str, Strict(strict=True)], account_type: Annotated[str, Strict(strict=True)], updated_datetime: str, reset_requested_email: Annotated[str, Strict(strict=True)] | None = None, errors: List[Annotated[str, Strict(strict=True)]])[source]#

Bases: BaseModel

account_id: StrictStr#

account_type: StrictStr#

classmethod account_type_validate_enum(value)[source]#: Validates the enum

authority: StrictStr#

biography: Annotated[str, Field(min_length=0, strict=True, max_length=100)] | None#

email: StrictStr#

errors: List[StrictStr]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of MyAccount from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of MyAccount from a JSON string

keylayout: KeyLayout#

lang: Lang#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

reset_requested_email: StrictStr | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

user_id: StrictStr#

username: StrictStr#

annofabapi.pydantic_models.my_notification_list module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.my_notification_list.MyNotificationList(*, messages: List[MyNotificationMessage], opened: Annotated[int, Strict(strict=True)], total: Annotated[int, Strict(strict=True)], page: Annotated[int, Strict(strict=True)], page_total: Annotated[int, Strict(strict=True)], over_limit: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

自分に届いているユーザー通知の取得結果です。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of MyNotificationList from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of MyNotificationList from a JSON string

messages: List[MyNotificationMessage]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

opened: StrictInt#

over_limit: StrictBool#

page: StrictInt#

page_total: StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

total: StrictInt#

annofabapi.pydantic_models.my_notification_message module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.my_notification_message.MyNotificationMessage(*, message_id: Annotated[str, Strict(strict=True)], title: Annotated[str, Strict(strict=True)], body: Annotated[str, Strict(strict=True)], content_type: Annotated[str, Strict(strict=True)] | None = None, opened: Annotated[bool, Strict(strict=True)], timestamp: str, created_datetime: str)[source]#

Bases: BaseModel

自分への通知メッセージの情報です。

body: StrictStr#

content_type: StrictStr | None#

created_datetime: str#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of MyNotificationMessage from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of MyNotificationMessage from a JSON string

message_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

opened: StrictBool#

timestamp: str#

title: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.my_notification_unread_messages_count module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.my_notification_unread_messages_count.MyNotificationUnreadMessagesCount(*, unread: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

通知メッセージの未読件数

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of MyNotificationUnreadMessagesCount from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of MyNotificationUnreadMessagesCount from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

unread: StrictInt#

annofabapi.pydantic_models.my_organization module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.my_organization.MyOrganization(*, organization_id: Annotated[str, Strict(strict=True)], name: Annotated[str, Strict(strict=True)], email: Annotated[str, Strict(strict=True)], price_plan: PricePlan, summary: Dict[str, Any], created_datetime: str, updated_datetime: str, my_role: OrganizationMemberRole, my_status: OrganizationMemberStatus)[source]#

Bases: BaseModel

created_datetime: str#

email: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of MyOrganization from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of MyOrganization from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

my_role: OrganizationMemberRole#

my_status: OrganizationMemberStatus#

name: StrictStr#

organization_id: StrictStr#

price_plan: PricePlan#

summary: Dict[str, Any]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.my_organization_list module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.my_organization_list.MyOrganizationList(*, list: List[MyOrganization], page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_count: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], over_limit: Annotated[bool, Strict(strict=True)], aggregations: List[AggregationResult])[source]#

Bases: BaseModel

aggregations: List[AggregationResult]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of MyOrganizationList from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of MyOrganizationList from a JSON string

list: List[MyOrganization]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

over_limit: StrictBool#

page_no: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

total_count: StrictFloat | StrictInt#

total_page_no: StrictFloat | StrictInt#

annofabapi.pydantic_models.no_comment module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.no_comment.NoComment(*, comment: Comment, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

空のコメントがある時のエラー

comment: Comment#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of NoComment from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of NoComment from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.no_comment_inspection module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.no_comment_inspection.NoCommentInspection(*, inspection: Inspection, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

空の検査コメントがある時のエラー

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of NoCommentInspection from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of NoCommentInspection from a JSON string

inspection: Inspection#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.oidc_attribute_mapping module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.oidc_attribute_mapping.OidcAttributeMapping(*, email: Annotated[str, Strict(strict=True)], name: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

外部IDプロバイダー上の属性と、Annofabが認識する属性のマッピング

email: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OidcAttributeMapping from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OidcAttributeMapping from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.oidc_endpoints module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.oidc_endpoints.OidcEndpoints(*args, oneof_schema_1_validator: IssuerOnlyOidcEndpoints | None = None, oneof_schema_2_validator: AllOidcEndpoints | None = None, actual_instance: AllOidcEndpoints | IssuerOnlyOidcEndpoints | None = None, one_of_schemas: Set[str] = {'AllOidcEndpoints', 'IssuerOnlyOidcEndpoints'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: AllOidcEndpoints | IssuerOnlyOidcEndpoints | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: IssuerOnlyOidcEndpoints | None#

oneof_schema_2_validator: AllOidcEndpoints | None#

to_dict() → Dict[str, Any] | AllOidcEndpoints | IssuerOnlyOidcEndpoints | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.organization module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization.Organization(*, organization_id: Annotated[str, Strict(strict=True)], organization_name: Annotated[str, Strict(strict=True)], email: Annotated[str, Strict(strict=True)], price_plan: PricePlan, summary: Dict[str, Any], created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

created_datetime: str#

email: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Organization from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Organization from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr#

organization_name: StrictStr#

price_plan: PricePlan#

summary: Dict[str, Any]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.organization_activity module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_activity.OrganizationActivity(*, organization_id: Annotated[str, Strict(strict=True)], created_datetime: str, storage_usage_bytes: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

created_datetime: str#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationActivity from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationActivity from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr#

storage_usage_bytes: StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.organization_cache_record module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_cache_record.OrganizationCacheRecord(*, members: Annotated[str, Strict(strict=True)] | None = None, organization: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationCacheRecord from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationCacheRecord from a JSON string

members: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization: StrictStr | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.organization_idp_id_determinant module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_idp_id_determinant.OrganizationIdpIdDeterminant(*, _type: Annotated[str, Strict(strict=True)], organization_name: Annotated[str, Strict(strict=True)], provider_id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

組織名とIDプロバイダーIDを元に外部IDプロバイダーを特定する決定因子

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationIdpIdDeterminant from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationIdpIdDeterminant from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_name: StrictStr#

provider_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.organization_job_info module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_job_info.OrganizationJobInfo(*, organization_id: Annotated[str, Strict(strict=True)] | None = None, job_type: Annotated[str, Strict(strict=True)] | None = None, job_id: Annotated[str, Strict(strict=True)] | None = None, job_status: JobStatus | None = None, job_execution: Dict[str, Any] | None = None, job_detail: JobDetail | None = None, errors: Errors | None = None, created_datetime: str | None = None, updated_datetime: str | None = None)[source]#

Bases: BaseModel

created_datetime: str | None#

errors: Errors | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationJobInfo from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationJobInfo from a JSON string

job_detail: JobDetail | None#

job_execution: Dict[str, Any] | None#

job_id: StrictStr | None#

job_status: JobStatus | None#

job_type: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.organization_job_info_container module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_job_info_container.OrganizationJobInfoContainer(*, list: List[OrganizationJobInfo], has_next: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationJobInfoContainer from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationJobInfoContainer from a JSON string

has_next: StrictBool#

list: List[OrganizationJobInfo]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.organization_member module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_member.OrganizationMember(*, organization_id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], user_id: Annotated[str, Strict(strict=True)], username: Annotated[str, Strict(strict=True)], role: OrganizationMemberRole, status: OrganizationMemberStatus, biography: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=0), MaxLen(max_length=100)])] | None = None, created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

account_id: StrictStr#

biography: Annotated[str, Field(min_length=0, strict=True, max_length=100)] | None#

created_datetime: str#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationMember from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationMember from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr#

role: OrganizationMemberRole#

status: OrganizationMemberStatus#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

user_id: StrictStr#

username: StrictStr#

annofabapi.pydantic_models.organization_member_list module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_member_list.OrganizationMemberList(*, list: List[OrganizationMember], page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_count: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], over_limit: Annotated[bool, Strict(strict=True)], aggregations: List[AggregationResult])[source]#

Bases: BaseModel

aggregations: List[AggregationResult]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationMemberList from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationMemberList from a JSON string

list: List[OrganizationMember]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

over_limit: StrictBool#

page_no: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

total_count: StrictFloat | StrictInt#

total_page_no: StrictFloat | StrictInt#

annofabapi.pydantic_models.organization_member_role module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_member_role.OrganizationMemberRole(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

組織メンバーのロール。 * owner - 組織オーナー * administrator - 組織管理者 * contributor - 組織貢献者

ADMINISTRATOR = 'administrator'#

CONTRIBUTOR = 'contributor'#

OWNER = 'owner'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of OrganizationMemberRole from a JSON string

annofabapi.pydantic_models.organization_member_status module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_member_status.OrganizationMemberStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

組織メンバーのステータス。 * active - 組織メンバーとして有効で、組織を閲覧したり、権限があれば編集できます。 * waiting_response - 組織に招待され、まだ加入/脱退を返答していません。組織の一部を閲覧のみできます。 * inactive - 脱退したメンバーを表します。組織を閲覧できません。

ACTIVE = 'active'#

INACTIVE = 'inactive'#

WAITING_RESPONSE = 'waiting_response'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of OrganizationMemberStatus from a JSON string

annofabapi.pydantic_models.organization_oidc_idp module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_oidc_idp.OrganizationOidcIdp(*, id: Annotated[str, Strict(strict=True)], organization_name: Annotated[str, Strict(strict=True)], client_id: Annotated[str, Strict(strict=True)], client_secret: Annotated[str, Strict(strict=True)], attributes_request_method: Annotated[str, Strict(strict=True)], endpoints: OidcEndpoints, attribute_mapping: OidcAttributeMapping, sign_up_url: Annotated[str, Strict(strict=True)], created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

組織が利用する外部IDプロバイダー設定

attribute_mapping: OidcAttributeMapping#

attributes_request_method: StrictStr#

classmethod attributes_request_method_validate_enum(value)[source]#: Validates the enum

client_id: StrictStr#

client_secret: StrictStr#

created_datetime: str#

endpoints: OidcEndpoints#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationOidcIdp from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationOidcIdp from a JSON string

id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_name: StrictStr#

sign_up_url: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.organization_plugin module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_plugin.OrganizationPlugin(*, organization_id: Annotated[str, Strict(strict=True)], plugin_id: Annotated[str, Strict(strict=True)], plugin_name: Annotated[str, Strict(strict=True)] | None = None, description: Annotated[str, Strict(strict=True)] | None = None, detail: PluginDetail, is_builtin: Annotated[bool, Strict(strict=True)], project_extra_data_kinds: List[Annotated[str, Strict(strict=True)]], created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

created_datetime: str#

description: StrictStr | None#

detail: PluginDetail#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationPlugin from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationPlugin from a JSON string

is_builtin: StrictBool#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr#

plugin_id: StrictStr#

plugin_name: StrictStr | None#

project_extra_data_kinds: List[StrictStr]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.organization_plugin_compatibility module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_plugin_compatibility.OrganizationPluginCompatibility(*, input: OrganizationPluginCompatibilityType, output: OrganizationPluginCompatibilityType)[source]#

Bases: BaseModel

プラグイン間の互換性を表します。未指定の場合はinput、outputともに`Top`の`OrganizationPluginCompatibilityType`が設定されます。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationPluginCompatibility from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationPluginCompatibility from a JSON string

input: OrganizationPluginCompatibilityType#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

output: OrganizationPluginCompatibilityType#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.organization_plugin_compatibility_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_plugin_compatibility_type.OrganizationPluginCompatibilityType(*args, oneof_schema_1_validator: OrganizationPluginCompatibilityTypeTop | None = None, oneof_schema_2_validator: OrganizationPluginCompatibilityTypeBottom | None = None, oneof_schema_3_validator: OrganizationPluginCompatibilityTypeConstant | None = None, actual_instance: OrganizationPluginCompatibilityTypeBottom | OrganizationPluginCompatibilityTypeConstant | OrganizationPluginCompatibilityTypeTop | None = None, one_of_schemas: Set[str] = {'OrganizationPluginCompatibilityTypeBottom', 'OrganizationPluginCompatibilityTypeConstant', 'OrganizationPluginCompatibilityTypeTop'})[source]#

Bases: BaseModel

プラグインの入力/出力を表す型です。

actual_instance: OrganizationPluginCompatibilityTypeBottom | OrganizationPluginCompatibilityTypeConstant | OrganizationPluginCompatibilityTypeTop | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: OrganizationPluginCompatibilityTypeTop | None#

oneof_schema_2_validator: OrganizationPluginCompatibilityTypeBottom | None#

oneof_schema_3_validator: OrganizationPluginCompatibilityTypeConstant | None#

to_dict() → Dict[str, Any] | OrganizationPluginCompatibilityTypeBottom | OrganizationPluginCompatibilityTypeConstant | OrganizationPluginCompatibilityTypeTop | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.organization_plugin_compatibility_type_bottom module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_plugin_compatibility_type_bottom.OrganizationPluginCompatibilityTypeBottom(*, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationPluginCompatibilityTypeBottom from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationPluginCompatibilityTypeBottom from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.organization_plugin_compatibility_type_constant module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_plugin_compatibility_type_constant.OrganizationPluginCompatibilityTypeConstant(*, _type: Annotated[str, Strict(strict=True)] | None = None, id: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationPluginCompatibilityTypeConstant from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationPluginCompatibilityTypeConstant from a JSON string

id: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.organization_plugin_compatibility_type_top module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_plugin_compatibility_type_top.OrganizationPluginCompatibilityTypeTop(*, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationPluginCompatibilityTypeTop from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationPluginCompatibilityTypeTop from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.organization_plugin_list module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_plugin_list.OrganizationPluginList(*, list: List[OrganizationPlugin], page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_count: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], over_limit: Annotated[bool, Strict(strict=True)], aggregations: List[Dict[str, Any]])[source]#

Bases: BaseModel

aggregations: List[Dict[str, Any]]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationPluginList from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationPluginList from a JSON string

list: List[OrganizationPlugin]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

over_limit: StrictBool#

page_no: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

total_count: StrictFloat | StrictInt#

total_page_no: StrictFloat | StrictInt#

annofabapi.pydantic_models.organization_registration_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.organization_registration_request.OrganizationRegistrationRequest(*, organization_name: Annotated[str, Strict(strict=True)], organization_email: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OrganizationRegistrationRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OrganizationRegistrationRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_email: StrictStr#

organization_name: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.overlapped_range_annotation module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.overlapped_range_annotation.OverlappedRangeAnnotation(*, label_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

区間が重複しているアノテーションが存在している場合に発生するエラー

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of OverlappedRangeAnnotation from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of OverlappedRangeAnnotation from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.password_reset_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.password_reset_request.PasswordResetRequest(*, email: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

email: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PasswordResetRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PasswordResetRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.personal_access_token module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.personal_access_token.PersonalAccessToken(*, id: Annotated[str, Strict(strict=True)], token: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], note: Annotated[str, Strict(strict=True)], expired_datetime: str, permissions: List[PersonalAccessTokenPermission], created_datetime: str, last_used_datetime: str | None = None)[source]#

Bases: BaseModel

パーソナルアクセストークン

account_id: StrictStr#

created_datetime: str#

expired_datetime: str#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PersonalAccessToken from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PersonalAccessToken from a JSON string

id: StrictStr#

last_used_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

note: StrictStr#

permissions: List[PersonalAccessTokenPermission]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

token: StrictStr#

annofabapi.pydantic_models.personal_access_token_info module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.personal_access_token_info.PersonalAccessTokenInfo(*, id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], note: Annotated[str, Strict(strict=True)], expired_datetime: str, permissions: List[PersonalAccessTokenPermission], created_datetime: str, last_used_datetime: str | None = None)[source]#

Bases: BaseModel

パーソナルアクセストークンから実際のトークン文字列を取り除いたもの

account_id: StrictStr#

created_datetime: str#

expired_datetime: str#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PersonalAccessTokenInfo from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PersonalAccessTokenInfo from a JSON string

id: StrictStr#

last_used_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

note: StrictStr#

permissions: List[PersonalAccessTokenPermission]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.personal_access_token_permission module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.personal_access_token_permission.PersonalAccessTokenPermission(*args, oneof_schema_1_validator: PersonalAccessTokenPermissionAll | None = None, actual_instance: PersonalAccessTokenPermissionAll | None = None, one_of_schemas: Set[str] = {'PersonalAccessTokenPermissionAll'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: PersonalAccessTokenPermissionAll | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: PersonalAccessTokenPermissionAll | None#

to_dict() → Dict[str, Any] | PersonalAccessTokenPermissionAll | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.personal_access_token_permission_all module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.personal_access_token_permission_all.PersonalAccessTokenPermissionAll(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

トークンにトークン発行者と完全に同等の権限を与える

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PersonalAccessTokenPermissionAll from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PersonalAccessTokenPermissionAll from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.phase_statistics module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.phase_statistics.PhaseStatistics(*, phase: TaskPhase, worktime: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PhaseStatistics from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PhaseStatistics from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

worktime: StrictStr#

annofabapi.pydantic_models.plugin_detail module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.plugin_detail.PluginDetail(*args, oneof_schema_1_validator: PluginDetailAnnotationEditor | None = None, oneof_schema_2_validator: PluginDetailTaskAssignment | None = None, oneof_schema_3_validator: PluginDetailAnnotationSpecs | None = None, oneof_schema_4_validator: PluginDetailExtendedAnnotationSpecs | None = None, actual_instance: PluginDetailAnnotationEditor | PluginDetailAnnotationSpecs | PluginDetailExtendedAnnotationSpecs | PluginDetailTaskAssignment | None = None, one_of_schemas: Set[str] = {'PluginDetailAnnotationEditor', 'PluginDetailAnnotationSpecs', 'PluginDetailExtendedAnnotationSpecs', 'PluginDetailTaskAssignment'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

PluginDetailAnnotationEditor - カスタムアノテーションエディタ用のプラグインを表します。 * PluginDetailTaskAssignment - カスタムタスク割当用のプラグインを表します。 * PluginDetailAnnotationSpecs - カスタムアノテーション仕様用のプラグインを表します。 * PluginDetailExtendedAnnotationSpecs - カスタムのアノテーション種別を作成するプラグインを表します。

actual_instance: PluginDetailAnnotationEditor | PluginDetailAnnotationSpecs | PluginDetailExtendedAnnotationSpecs | PluginDetailTaskAssignment | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: PluginDetailAnnotationEditor | None#

oneof_schema_2_validator: PluginDetailTaskAssignment | None#

oneof_schema_3_validator: PluginDetailAnnotationSpecs | None#

oneof_schema_4_validator: PluginDetailExtendedAnnotationSpecs | None#

to_dict() → Dict[str, Any] | PluginDetailAnnotationEditor | PluginDetailAnnotationSpecs | PluginDetailExtendedAnnotationSpecs | PluginDetailTaskAssignment | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.plugin_detail_annotation_editor module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.plugin_detail_annotation_editor.PluginDetailAnnotationEditor(*, plugin_compatibility: OrganizationPluginCompatibility | None = None, url: Annotated[str, Strict(strict=True)] | None = None, auth_redirect_url: Annotated[str, Strict(strict=True)] | None = None, compatible_input_data_types: List[InputDataType], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

カスタムアノテーションエディタ用のプラグインを表します。

auth_redirect_url: StrictStr | None#

compatible_input_data_types: List[InputDataType]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PluginDetailAnnotationEditor from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PluginDetailAnnotationEditor from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

plugin_compatibility: OrganizationPluginCompatibility | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

url: StrictStr | None#

annofabapi.pydantic_models.plugin_detail_annotation_specs module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.plugin_detail_annotation_specs.PluginDetailAnnotationSpecs(*, plugin_compatibility: OrganizationPluginCompatibility | None = None, url: Annotated[str, Strict(strict=True)] | None = None, auth_redirect_url: Annotated[str, Strict(strict=True)] | None = None, compatible_input_data_types: List[InputDataType], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

カスタムアノテーション仕様用のプラグインを表します。

auth_redirect_url: StrictStr | None#

compatible_input_data_types: List[InputDataType]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PluginDetailAnnotationSpecs from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PluginDetailAnnotationSpecs from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

plugin_compatibility: OrganizationPluginCompatibility | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

url: StrictStr | None#

annofabapi.pydantic_models.plugin_detail_extended_annotation_specs module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.plugin_detail_extended_annotation_specs.PluginDetailExtendedAnnotationSpecs(*, plugin_compatibility: OrganizationPluginCompatibility | None = None, annotation_types: List[AnnotationType], user_defined_annotation_type_definitions: Dict[str, UserDefinedAnnotationTypeDefinition] | None = None, compatible_input_data_types: List[InputDataType], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

カスタムのアノテーション種別を作成するプラグインを表します。なお、このプラグインが設定されているプロジェクトでは、ここで指定したアノテーション種別以外は使用できなくなります。

annotation_types: List[AnnotationType]#

compatible_input_data_types: List[InputDataType]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PluginDetailExtendedAnnotationSpecs from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PluginDetailExtendedAnnotationSpecs from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

plugin_compatibility: OrganizationPluginCompatibility | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

user_defined_annotation_type_definitions: Dict[str, UserDefinedAnnotationTypeDefinition] | None#

annofabapi.pydantic_models.plugin_detail_task_assignment module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.plugin_detail_task_assignment.PluginDetailTaskAssignment(*, plugin_compatibility: OrganizationPluginCompatibility | None = None, url: Annotated[str, Strict(strict=True)] | None = None, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

カスタムタスク割当用のプラグインを表します。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PluginDetailTaskAssignment from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PluginDetailTaskAssignment from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

plugin_compatibility: OrganizationPluginCompatibility | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

url: StrictStr | None#

annofabapi.pydantic_models.plugin_token_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.plugin_token_request.PluginTokenRequest(*args, oneof_schema_1_validator: PluginTokenRequestAuthorizationCode | None = None, oneof_schema_2_validator: PluginTokenRequestRefreshToken | None = None, actual_instance: PluginTokenRequestAuthorizationCode | PluginTokenRequestRefreshToken | None = None, one_of_schemas: Set[str] = {'PluginTokenRequestAuthorizationCode', 'PluginTokenRequestRefreshToken'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: PluginTokenRequestAuthorizationCode | PluginTokenRequestRefreshToken | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: PluginTokenRequestAuthorizationCode | None#

oneof_schema_2_validator: PluginTokenRequestRefreshToken | None#

to_dict() → Dict[str, Any] | PluginTokenRequestAuthorizationCode | PluginTokenRequestRefreshToken | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.plugin_token_request_authorization_code module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.plugin_token_request_authorization_code.PluginTokenRequestAuthorizationCode(*, _type: Annotated[str, Strict(strict=True)], authorization_code: Annotated[str, Strict(strict=True)], code_verifier: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

authorization_code: StrictStr#

code_verifier: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PluginTokenRequestAuthorizationCode from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PluginTokenRequestAuthorizationCode from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.plugin_token_request_refresh_token module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.plugin_token_request_refresh_token.PluginTokenRequestRefreshToken(*, _type: Annotated[str, Strict(strict=True)], refresh_token: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PluginTokenRequestRefreshToken from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PluginTokenRequestRefreshToken from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

refresh_token: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.plugin_token_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.plugin_token_response.PluginTokenResponse(*, access_token: Annotated[str, Strict(strict=True)], refresh_token: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

access_token: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PluginTokenResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PluginTokenResponse from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

refresh_token: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.point module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.point.Point(*, x: Annotated[int, Strict(strict=True)], y: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

点の座標値

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Point from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Point from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

x: StrictInt#

y: StrictInt#

annofabapi.pydantic_models.position_for_minimum_bounding_box_insertion module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.position_for_minimum_bounding_box_insertion.PositionForMinimumBoundingBoxInsertion(*, x: Annotated[int, Strict(strict=True)], y: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

annotation_type が bounding_box かつ min_warn_rule が and または or の場合のみ、挿入する最小矩形アノテーションの原点を指定できます。画像左上の座標が「x=0, y=0」です。未指定、もしくは「画像外に飛び出たアノテーション」を許可していないにも関わらず飛び出してしまう場合は、表示範囲の中央に挿入されます。「スキャンした帳票の記入欄」や「定点カメラで撮影した製品ラベル」など、アノテーションしたい位置やサイズが多くの画像で共通している場合に便利です。 annotation_type が bounding_box 以外の場合は必ず未指定となります。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PositionForMinimumBoundingBoxInsertion from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PositionForMinimumBoundingBoxInsertion from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

x: StrictInt#

y: StrictInt#

annofabapi.pydantic_models.post_annotation_archive_update_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.post_annotation_archive_update_response.PostAnnotationArchiveUpdateResponse(*, job: ProjectJobInfo)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PostAnnotationArchiveUpdateResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PostAnnotationArchiveUpdateResponse from a JSON string

job: ProjectJobInfo#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.post_annotation_archive_update_response_wrapper module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.post_annotation_archive_update_response_wrapper.PostAnnotationArchiveUpdateResponseWrapper(*args, oneof_schema_1_validator: Message | None = None, oneof_schema_2_validator: PostAnnotationArchiveUpdateResponse | None = None, actual_instance: Message | PostAnnotationArchiveUpdateResponse | None = None, one_of_schemas: Set[str] = {'Message', 'PostAnnotationArchiveUpdateResponse'})[source]#

Bases: BaseModel

actual_instance: Message | PostAnnotationArchiveUpdateResponse | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: Message | None#

oneof_schema_2_validator: PostAnnotationArchiveUpdateResponse | None#

to_dict() → Dict[str, Any] | Message | PostAnnotationArchiveUpdateResponse | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.post_exchange_code_login_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.post_exchange_code_login_response.PostExchangeCodeLoginResponse(*, token: Token)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PostExchangeCodeLoginResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PostExchangeCodeLoginResponse from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

token: Token#

annofabapi.pydantic_models.post_exchange_code_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.post_exchange_code_response.PostExchangeCodeResponse(*args, oneof_schema_1_validator: PostExchangeCodeLoginResponse | None = None, oneof_schema_2_validator: UnconfirmedUserResponse | None = None, actual_instance: PostExchangeCodeLoginResponse | UnconfirmedUserResponse | None = None, one_of_schemas: Set[str] = {'PostExchangeCodeLoginResponse', 'UnconfirmedUserResponse'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: PostExchangeCodeLoginResponse | UnconfirmedUserResponse | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: PostExchangeCodeLoginResponse | None#

oneof_schema_2_validator: UnconfirmedUserResponse | None#

to_dict() → Dict[str, Any] | PostExchangeCodeLoginResponse | UnconfirmedUserResponse | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.post_mfa_setting_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.post_mfa_setting_request.PostMfaSettingRequest(*, enabled: Annotated[bool, Strict(strict=True)], mfa_code: Annotated[str, Strict(strict=True)] | None = None, access_token: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

access_token: StrictStr | None#

enabled: StrictBool#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PostMfaSettingRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PostMfaSettingRequest from a JSON string

mfa_code: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.post_project_tasks_update_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.post_project_tasks_update_response.PostProjectTasksUpdateResponse(*, job: ProjectJobInfo)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PostProjectTasksUpdateResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PostProjectTasksUpdateResponse from a JSON string

job: ProjectJobInfo#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.price_plan module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.price_plan.PricePlan(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

料金プラン * free - フリープラン * business - ビジネスプラン

BUSINESS = 'business'#

FREE = 'free'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of PricePlan from a JSON string

annofabapi.pydantic_models.project module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project.Project(*, project_id: Annotated[str, Strict(strict=True)], organization_id: Annotated[str, Strict(strict=True)], title: Annotated[str, Strict(strict=True)], overview: Annotated[str, Strict(strict=True)] | None = None, project_status: ProjectStatus, input_data_type: InputDataType, configuration: ProjectConfigurationGet, created_datetime: str, updated_datetime: str, summary: ProjectSummary)[source]#

Bases: BaseModel

configuration: ProjectConfigurationGet#

created_datetime: str#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Project from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Project from a JSON string

input_data_type: InputDataType#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr#

overview: StrictStr | None#

project_id: StrictStr#

project_status: ProjectStatus#

summary: ProjectSummary#

title: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.project_account_statistics module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_account_statistics.ProjectAccountStatistics(*, account_id: Annotated[str, Strict(strict=True)], histories: List[ProjectAccountStatisticsHistory])[source]#

Bases: BaseModel

account_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectAccountStatistics from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectAccountStatistics from a JSON string

histories: List[ProjectAccountStatisticsHistory]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_account_statistics_history module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_account_statistics_history.ProjectAccountStatisticsHistory(*, date: str, tasks_completed: Annotated[int, Strict(strict=True)], tasks_rejected: Annotated[int, Strict(strict=True)], worktime: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectAccountStatisticsHistory from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectAccountStatisticsHistory from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tasks_completed: StrictInt#

tasks_rejected: StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

var_date: str#

worktime: StrictStr#

annofabapi.pydantic_models.project_cache_record module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_cache_record.ProjectCacheRecord(*, input: Annotated[str, Strict(strict=True)] | None = None, members: Annotated[str, Strict(strict=True)] | None = None, project: Annotated[str, Strict(strict=True)] | None = None, instruction: Annotated[str, Strict(strict=True)] | None = None, specs: Annotated[str, Strict(strict=True)] | None = None, statistics: Annotated[str, Strict(strict=True)] | None = None, organization: Annotated[str, Strict(strict=True)] | None = None, supplementary: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectCacheRecord from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectCacheRecord from a JSON string

input: StrictStr | None#

instruction: StrictStr | None#

members: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization: StrictStr | None#

project: StrictStr | None#

specs: StrictStr | None#

statistics: StrictStr | None#

supplementary: StrictStr | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_configuration_get module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_configuration_get.ProjectConfigurationGet(*, number_of_inspections: Annotated[int, Strict(strict=True), Ge(ge=0)], assignee_rule_of_resubmitted_task: AssigneeRuleOfResubmittedTask, task_assignment_type: TaskAssignmentType, task_assignment_property: TaskAssignmentProperty | None = None, max_tasks_per_member: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None = 10, max_tasks_per_member_including_hold: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None = 20, input_data_set_id_list: List[Annotated[str, Strict(strict=True)]], input_data_max_long_side_length: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None = None, sampling_inspection_rate: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0), Le(le=100)])] | None = None, sampling_acceptance_rate: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0), Le(le=100)])] | None = None, private_storage_aws_iam_role_arn: Annotated[str, Strict(strict=True)] | None = None, use_s3_transfer_acceleration: Annotated[bool, Strict(strict=True)] | None = False, plugin_id: Annotated[str, Strict(strict=True)] | None = None, custom_task_assignment_plugin_id: Annotated[str, Strict(strict=True)] | None = None, custom_specs_plugin_id: Annotated[str, Strict(strict=True)] | None = None, extended_specs_plugin_id: Annotated[str, Strict(strict=True)] | None = None, editor_version: Annotated[str, Strict(strict=True)] | None = None, use_beginner_navigation: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

assignee_rule_of_resubmitted_task: AssigneeRuleOfResubmittedTask#

custom_specs_plugin_id: StrictStr | None#

custom_task_assignment_plugin_id: StrictStr | None#

editor_version: StrictStr | None#

extended_specs_plugin_id: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectConfigurationGet from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectConfigurationGet from a JSON string

input_data_max_long_side_length: Annotated[int, Field(strict=True, ge=0)] | None#

input_data_set_id_list: List[StrictStr]#

max_tasks_per_member: Annotated[int, Field(le=100, strict=True, ge=1)] | None#

max_tasks_per_member_including_hold: Annotated[int, Field(le=100, strict=True, ge=1)] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number_of_inspections: Annotated[int, Field(strict=True, ge=0)]#

plugin_id: StrictStr | None#

private_storage_aws_iam_role_arn: StrictStr | None#

sampling_acceptance_rate: Annotated[int, Field(le=100, strict=True, ge=0)] | None#

sampling_inspection_rate: Annotated[int, Field(le=100, strict=True, ge=0)] | None#

task_assignment_property: TaskAssignmentProperty | None#

task_assignment_type: TaskAssignmentType#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

use_beginner_navigation: StrictBool#

use_s3_transfer_acceleration: StrictBool | None#

annofabapi.pydantic_models.project_configuration_put module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_configuration_put.ProjectConfigurationPut(*, number_of_inspections: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None = 0, assignee_rule_of_resubmitted_task: AssigneeRuleOfResubmittedTask | None = AssigneeRuleOfResubmittedTask.NO_ASSIGNEE, task_assignment_type: TaskAssignmentType | None = TaskAssignmentType.RANDOM, task_assignment_property: TaskAssignmentProperty | None = None, max_tasks_per_member: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None = 10, max_tasks_per_member_including_hold: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1), Le(le=100)])] | None = 20, input_data_set_id_list: List[Annotated[str, Strict(strict=True)]] | None = None, input_data_max_long_side_length: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None = None, sampling_inspection_rate: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0), Le(le=100)])] | None = None, sampling_acceptance_rate: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0), Le(le=100)])] | None = None, private_storage_aws_iam_role_arn: Annotated[str, Strict(strict=True)] | None = None, use_s3_transfer_acceleration: Annotated[bool, Strict(strict=True)] | None = False, plugin_id: Annotated[str, Strict(strict=True)] | None = None, custom_task_assignment_plugin_id: Annotated[str, Strict(strict=True)] | None = None, custom_specs_plugin_id: Annotated[str, Strict(strict=True)] | None = None, extended_specs_plugin_id: Annotated[str, Strict(strict=True)] | None = None, editor_version: Annotated[str, Strict(strict=True)] | None = None, use_beginner_navigation: Annotated[bool, Strict(strict=True)] | None = False)[source]#

Bases: BaseModel

プロジェクトの設定情報

assignee_rule_of_resubmitted_task: AssigneeRuleOfResubmittedTask | None#

custom_specs_plugin_id: StrictStr | None#

custom_task_assignment_plugin_id: StrictStr | None#

editor_version: StrictStr | None#

extended_specs_plugin_id: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectConfigurationPut from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectConfigurationPut from a JSON string

input_data_max_long_side_length: Annotated[int, Field(strict=True, ge=0)] | None#

input_data_set_id_list: List[StrictStr] | None#

max_tasks_per_member: Annotated[int, Field(le=100, strict=True, ge=1)] | None#

max_tasks_per_member_including_hold: Annotated[int, Field(le=100, strict=True, ge=1)] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number_of_inspections: Annotated[int, Field(strict=True, ge=0)] | None#

plugin_id: StrictStr | None#

private_storage_aws_iam_role_arn: StrictStr | None#

sampling_acceptance_rate: Annotated[int, Field(le=100, strict=True, ge=0)] | None#

sampling_inspection_rate: Annotated[int, Field(le=100, strict=True, ge=0)] | None#

task_assignment_property: TaskAssignmentProperty | None#

task_assignment_type: TaskAssignmentType | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

use_beginner_navigation: StrictBool | None#

use_s3_transfer_acceleration: StrictBool | None#

annofabapi.pydantic_models.project_container module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_container.ProjectContainer(*, list: List[Project], has_next: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectContainer from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectContainer from a JSON string

has_next: StrictBool#

list: List[Project]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_copy_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_copy_request.ProjectCopyRequest(*, dest_project_id: Annotated[str, Strict(strict=True)], dest_title: Annotated[str, Strict(strict=True)], dest_overview: Annotated[str, Strict(strict=True)] | None = None, copy_inputs: Annotated[bool, Strict(strict=True)] | None = False, copy_tasks: Annotated[bool, Strict(strict=True)] | None = False, copy_annotations: Annotated[bool, Strict(strict=True)] | None = False, copy_webhooks: Annotated[bool, Strict(strict=True)] | None = False, copy_supplementary_data: Annotated[bool, Strict(strict=True)] | None = False, copy_instructions: Annotated[bool, Strict(strict=True)] | None = False)[source]#

Bases: BaseModel

copy_annotations: StrictBool | None#

copy_inputs: StrictBool | None#

copy_instructions: StrictBool | None#

copy_supplementary_data: StrictBool | None#

copy_tasks: StrictBool | None#

copy_webhooks: StrictBool | None#

dest_overview: StrictStr | None#

dest_project_id: StrictStr#

dest_title: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectCopyRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectCopyRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_copy_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_copy_response.ProjectCopyResponse(*, job: ProjectJobInfo, dest_project: Project)[source]#

Bases: BaseModel

dest_project: Project#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectCopyResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectCopyResponse from a JSON string

job: ProjectJobInfo#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_extra_data module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_extra_data.ProjectExtraData(*, project_id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)] | None = None, kind_id: Annotated[str, Strict(strict=True)], value: ProjectExtraDataValue)[source]#

Bases: BaseModel

プロジェクトの追加データ。追加のプロジェクトの設定や、プロジェクトに対するユーザ毎のデータを表す。 (project_id, account_id, kind_id)の組み合わせで一意になり、account_idが指定指定されていない場合はユーザに割りつかず、プロジェクト自体に割りついている値を表す。

account_id: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectExtraData from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectExtraData from a JSON string

kind_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

value: ProjectExtraDataValue#

annofabapi.pydantic_models.project_extra_data_kind module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_extra_data_kind.ProjectExtraDataKind(*, id: Annotated[str, Strict(strict=True)], display_name: InternationalizationMessage, schema: Dict[str, Any], scope: ProjectExtraDataKindScope, default_value: Any | None = None)[source]#

Bases: BaseModel

プロジェクトの追加データの種別。

default_value: Any | None#

display_name: InternationalizationMessage#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectExtraDataKind from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectExtraDataKind from a JSON string

id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

scope: ProjectExtraDataKindScope#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

var_schema: Dict[str, Any]#

annofabapi.pydantic_models.project_extra_data_kind_scope module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_extra_data_kind_scope.ProjectExtraDataKindScope(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

プロジェクト追加データがユーザーとプロジェクトに割りつくかどうかを表す列挙値。 - project => プロジェクトにのみ割りつき、ユーザには割りつかない - user => ユーザにのみ割りつき、プロジェクトには割りつかない - both => プロジェクトとユーザの両方に割りつく

BOTH = 'both'#

PROJECT = 'project'#

USER = 'user'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of ProjectExtraDataKindScope from a JSON string

annofabapi.pydantic_models.project_extra_data_value module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_extra_data_value.ProjectExtraDataValue(*args, oneof_schema_1_validator: ProjectExtraDataValueEmpty | None = None, oneof_schema_2_validator: ProjectExtraDataValueDefault | None = None, oneof_schema_3_validator: ProjectExtraDataValueSaved | None = None, actual_instance: ProjectExtraDataValueDefault | ProjectExtraDataValueEmpty | ProjectExtraDataValueSaved | None = None, one_of_schemas: Set[str] = {'ProjectExtraDataValueDefault', 'ProjectExtraDataValueEmpty', 'ProjectExtraDataValueSaved'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: ProjectExtraDataValueDefault | ProjectExtraDataValueEmpty | ProjectExtraDataValueSaved | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: ProjectExtraDataValueEmpty | None#

oneof_schema_2_validator: ProjectExtraDataValueDefault | None#

oneof_schema_3_validator: ProjectExtraDataValueSaved | None#

to_dict() → Dict[str, Any] | ProjectExtraDataValueDefault | ProjectExtraDataValueEmpty | ProjectExtraDataValueSaved | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.project_extra_data_value_default module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_extra_data_value_default.ProjectExtraDataValueDefault(*, _type: Annotated[str, Strict(strict=True)], value: Any | None)[source]#

Bases: BaseModel

保存されているデータが無く、デフォルト値が設定されている場合

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectExtraDataValueDefault from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectExtraDataValueDefault from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

value: Any | None#

annofabapi.pydantic_models.project_extra_data_value_empty module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_extra_data_value_empty.ProjectExtraDataValueEmpty(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

保存されているデータが無く、デフォルト値も設定されていない場合

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectExtraDataValueEmpty from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectExtraDataValueEmpty from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.project_extra_data_value_saved module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_extra_data_value_saved.ProjectExtraDataValueSaved(*, _type: Annotated[str, Strict(strict=True)], value: Any | None, updated_datetime: str)[source]#

Bases: BaseModel

保存されているデータがある場合

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectExtraDataValueSaved from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectExtraDataValueSaved from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

updated_datetime: str#

value: Any | None#

annofabapi.pydantic_models.project_guest_user_profile module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_guest_user_profile.ProjectGuestUserProfile(*, user_id: Annotated[str, Strict(strict=True)], user_name: Annotated[str, Strict(strict=True)], lang: Annotated[str, Strict(strict=True)], key_layout: KeyLayout)[source]#

Bases: BaseModel

ゲストユーザーのプロフィール情報

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectGuestUserProfile from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectGuestUserProfile from a JSON string

key_layout: KeyLayout#

lang: StrictStr#

classmethod lang_validate_enum(value)[source]#: Validates the enum

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

user_id: StrictStr#

user_name: StrictStr#

annofabapi.pydantic_models.project_inputs_update_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_inputs_update_response.ProjectInputsUpdateResponse(*, job: ProjectJobInfo)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectInputsUpdateResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectInputsUpdateResponse from a JSON string

job: ProjectJobInfo#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_job_info module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_job_info.ProjectJobInfo(*, project_id: Annotated[str, Strict(strict=True)], job_type: ProjectJobType, job_id: Annotated[str, Strict(strict=True)], job_status: JobStatus, job_execution: Dict[str, Any] | None = None, job_detail: JobDetail | None = None, errors: Errors, created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

created_datetime: str#

errors: Errors#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectJobInfo from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectJobInfo from a JSON string

job_detail: JobDetail | None#

job_execution: Dict[str, Any] | None#

job_id: StrictStr#

job_status: JobStatus#

job_type: ProjectJobType#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.project_job_info_container module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_job_info_container.ProjectJobInfoContainer(*, list: List[ProjectJobInfo], has_next: Annotated[bool, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectJobInfoContainer from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectJobInfoContainer from a JSON string

has_next: StrictBool#

list: List[ProjectJobInfo]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_job_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_job_type.ProjectJobType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

プロジェクトのジョブの種別 * copy-project - プロジェクトのコピー。[initiateProjectCopy](#operation/initiateProjectCopy) APIを実行したときに登録されるジョブ。 * gen-inputs - zipファイルから入力データの作成。[putInputData](#operation/putInputData) APIを実行して、zipファイルから入力データを作成したときに登録されるジョブ。 * gen-tasks - タスクの一括作成。[initiateTasksGeneration](#operation/initiateTasksGeneration) APIを実行したときに登録されるジョブ。 * gen-annotation - アノテーションZIPの更新。[postAnnotationArchiveUpdate](#operation/postAnnotationArchiveUpdate) APIを実行したときに登録されるジョブ。 * gen-tasks-list - タスク全件ファイルの更新。[postProjectTasksUpdate](#operation/postProjectTasksUpdate) APIを実行したときに登録されるジョブ。 * gen-inputs-list - 入力データ情報全件ファイルの更新。[postProjectInputsUpdate](#operation/postProjectInputsUpdate) APIを実行したときに登録されるジョブ。 * delete-project - プロジェクトの削除。[deleteProject](#operation/deleteProject) APIを実行したときに登録されるジョブ。 * invoke-hook - Webhookの起動。 * move-project - プロジェクトの組織移動。[putProject](#operation/putProject) API で組織を変更したときに登録されるジョブ。 ## ジョブの同時実行制限 Annofab上に登録されているデータの整合性を保つため、プロジェクト内で特定のジョブが実行中の間は他のジョブが実行できないよう制限をかけています。ジョブの同時実行可否はジョブの種別によって異なります。なお、ジョブを実行するプロジェクトが初期化中 (project_status = “initializing”) の場合は、どのジョブも実行できません。 ### copy-project 次のジョブが実行されている場合、このジョブを実行することはできません。 * gen-inputs * gen-tasks * delete-project * move-project ### gen-inputs 次のジョブが実行されている場合、このジョブを実行することはできません。 * copy-project * gen-inputs * gen-tasks * gen-inputs-list * delete-project * move-project ### gen-tasks 次のジョブが実行されている場合、このジョブを実行することはできません。 * copy-project * gen-inputs * gen-tasks * gen-annotation * gen-tasks-list * delete-project * move-project ### gen-annotation 次のジョブが実行されている場合、このジョブを実行することはできません。 * gen-tasks * gen-annotation * delete-project * move-project ### gen-tasks-list 次のジョブが実行されている場合、このジョブを実行することはできません。 * gen-tasks * gen-tasks-list * delete-project * move-project ### gen-inputs-list 次のジョブが実行されている場合、このジョブを実行することはできません。 * gen-inputs * gen-inputs-list * delete-project * move-project ### delete-project 他のジョブが実行されていない場合**のみ**実行できます。 ### invoke-hook 次のジョブが実行されている場合、このジョブを実行することはできません。 * delete-project * move-project ### move-project 他のジョブが実行されていない場合**のみ**実行できます。

COPY_MINUS_PROJECT = 'copy-project'#

DELETE_MINUS_PROJECT = 'delete-project'#

GEN_MINUS_ANNOTATION = 'gen-annotation'#

GEN_MINUS_INPUTS = 'gen-inputs'#

GEN_MINUS_INPUTS_MINUS_LIST = 'gen-inputs-list'#

GEN_MINUS_TASKS = 'gen-tasks'#

GEN_MINUS_TASKS_MINUS_LIST = 'gen-tasks-list'#

INVOKE_MINUS_HOOK = 'invoke-hook'#

MOVE_MINUS_PROJECT = 'move-project'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of ProjectJobType from a JSON string

annofabapi.pydantic_models.project_list module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_list.ProjectList(*, list: List[Project], page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_count: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], over_limit: Annotated[bool, Strict(strict=True)], aggregations: List[AggregationResult])[source]#

Bases: BaseModel

aggregations: List[AggregationResult]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectList from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectList from a JSON string

list: List[Project]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

over_limit: StrictBool#

page_no: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

total_count: StrictFloat | StrictInt#

total_page_no: StrictFloat | StrictInt#

annofabapi.pydantic_models.project_member module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_member.ProjectMember(*, project_id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], user_id: Annotated[str, Strict(strict=True)], username: Annotated[str, Strict(strict=True)], member_status: ProjectMemberStatus, member_role: ProjectMemberRole, biography: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=0), MaxLen(max_length=100)])] | None = None, updated_datetime: str, created_datetime: str, sampling_inspection_rate: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0), Le(le=100)])] | None = None, sampling_acceptance_rate: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0), Le(le=100)])] | None = None)[source]#

Bases: BaseModel

account_id: StrictStr#

biography: Annotated[str, Field(min_length=0, strict=True, max_length=100)] | None#

created_datetime: str#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectMember from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectMember from a JSON string

member_role: ProjectMemberRole#

member_status: ProjectMemberStatus#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

sampling_acceptance_rate: Annotated[int, Field(le=100, strict=True, ge=0)] | None#

sampling_inspection_rate: Annotated[int, Field(le=100, strict=True, ge=0)] | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

user_id: StrictStr#

username: StrictStr#

annofabapi.pydantic_models.project_member_list module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_member_list.ProjectMemberList(*, list: List[ProjectMember], page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_count: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], over_limit: Annotated[bool, Strict(strict=True)], aggregations: List[AggregationResult])[source]#

Bases: BaseModel

aggregations: List[AggregationResult]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectMemberList from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectMemberList from a JSON string

list: List[ProjectMember]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

over_limit: StrictBool#

page_no: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

total_count: StrictFloat | StrictInt#

total_page_no: StrictFloat | StrictInt#

annofabapi.pydantic_models.project_member_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_member_request.ProjectMemberRequest(*, member_status: ProjectMemberStatus, member_role: ProjectMemberRole, sampling_inspection_rate: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0), Le(le=100)])] | None = None, sampling_acceptance_rate: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0), Le(le=100)])] | None = None, last_updated_datetime: str | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectMemberRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectMemberRequest from a JSON string

last_updated_datetime: str | None#

member_role: ProjectMemberRole#

member_status: ProjectMemberStatus#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sampling_acceptance_rate: Annotated[int, Field(le=100, strict=True, ge=0)] | None#

sampling_inspection_rate: Annotated[int, Field(le=100, strict=True, ge=0)] | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_member_role module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_member_role.ProjectMemberRole(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

プロジェクトメンバーのロール * owner - オーナー * worker - アノテーター * accepter - チェッカー * training_data_user - アノテーションユーザー

ACCEPTER = 'accepter'#

OWNER = 'owner'#

TRAINING_DATA_USER = 'training_data_user'#

WORKER = 'worker'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of ProjectMemberRole from a JSON string

annofabapi.pydantic_models.project_member_status module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_member_status.ProjectMemberStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

プロジェクトメンバーの状態 * active - プロジェクトメンバーとして有効で、プロジェクトを閲覧したり、権限があれば編集できます。 * inactive - 脱退したプロジェクトメンバーを表します。プロジェクトを閲覧できません。

ACTIVE = 'active'#

INACTIVE = 'inactive'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of ProjectMemberStatus from a JSON string

annofabapi.pydantic_models.project_status module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_status.ProjectStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

プロジェクトの状態 * active - プロジェクトが進行中 * suspended - プロジェクトが停止中 * initializing - プロジェクトが初期化中

ACTIVE = 'active'#

INITIALIZING = 'initializing'#

SUSPENDED = 'suspended'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of ProjectStatus from a JSON string

annofabapi.pydantic_models.project_summary module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_summary.ProjectSummary(*, last_tasks_updated_datetime: str | None = None)[source]#

Bases: BaseModel

プロジェクトのサマリー情報

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectSummary from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectSummary from a JSON string

last_tasks_updated_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_task_counts module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_task_counts.ProjectTaskCounts(*, project_id: Annotated[str, Strict(strict=True)], task_counts: List[ProjectTaskCountsTaskCountsInner])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectTaskCounts from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectTaskCounts from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_counts: List[ProjectTaskCountsTaskCountsInner]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_task_counts_task_counts_inner module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_task_counts_task_counts_inner.ProjectTaskCountsTaskCountsInner(*, phase: TaskPhase, status: TaskStatus, count: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

count: StrictFloat | StrictInt#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectTaskCountsTaskCountsInner from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectTaskCountsTaskCountsInner from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

status: TaskStatus#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.project_task_statistics module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_task_statistics.ProjectTaskStatistics(*, phase: TaskPhase, status: TaskStatus, count: Annotated[int, Strict(strict=True), Ge(ge=0)], work_timespan: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

count: Annotated[int, Field(strict=True, ge=0)]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectTaskStatistics from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectTaskStatistics from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

status: TaskStatus#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

work_timespan: StrictInt#

annofabapi.pydantic_models.project_task_statistics_history module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_task_statistics_history.ProjectTaskStatisticsHistory(*, date: str, tasks: List[ProjectTaskStatistics])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectTaskStatisticsHistory from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectTaskStatisticsHistory from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tasks: List[ProjectTaskStatistics]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

var_date: str#

annofabapi.pydantic_models.project_token module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_token.ProjectToken(*, project_id: Annotated[str, Strict(strict=True)], token: Annotated[str, Strict(strict=True)], info: ProjectTokenInfo)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectToken from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectToken from a JSON string

info: ProjectTokenInfo#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

token: StrictStr#

annofabapi.pydantic_models.project_token_info module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.project_token_info.ProjectTokenInfo(*, created_date_time: str, last_used_date_time: str, description: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

プロジェクトトークンについての付加情報

created_date_time: str#

description: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ProjectTokenInfo from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ProjectTokenInfo from a JSON string

last_used_date_time: str#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_annotation_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_annotation_request.PutAnnotationRequest(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], details: List[AnnotationDetailV1], updated_datetime: str | None = None)[source]#

Bases: BaseModel

details: List[AnnotationDetailV1]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutAnnotationRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutAnnotationRequest from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.put_annotation_thumbnail_body module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_annotation_thumbnail_body.PutAnnotationThumbnailBody(*, images: List[AnnotationThumbnailImageSource], annotations: Dict[str, AnnotationThumbnailDetail], annotation_updated_datetime: str)[source]#

Bases: BaseModel

アノテーションのサムネイル更新リクエスト

annotation_updated_datetime: str#

annotations: Dict[str, AnnotationThumbnailDetail]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutAnnotationThumbnailBody from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutAnnotationThumbnailBody from a JSON string

images: List[AnnotationThumbnailImageSource]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_input_data_set_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_input_data_set_request.PutInputDataSetRequest(*, input_data_set_name: Annotated[str, Strict(strict=True)], input_data_type: InputDataType, private_storage_arn: Annotated[str, Strict(strict=True)] | None = None, last_updated_datetime: str | None = None)[source]#

Bases: BaseModel

入力データセット新規作成/更新

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutInputDataSetRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutInputDataSetRequest from a JSON string

input_data_set_name: StrictStr#

input_data_type: InputDataType#

last_updated_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

private_storage_arn: StrictStr | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_instruction_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_instruction_request.PutInstructionRequest(*, html: Annotated[str, Strict(strict=True)], last_updated_datetime: str | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutInstructionRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutInstructionRequest from a JSON string

html: StrictStr#

last_updated_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_markers_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_markers_request.PutMarkersRequest(*, markers: List[Marker] | None = None, last_updated_datetime: str | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutMarkersRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutMarkersRequest from a JSON string

last_updated_datetime: str | None#

markers: List[Marker] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_my_account_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_my_account_request.PutMyAccountRequest(*, user_id: Annotated[str, Strict(strict=True)], username: Annotated[str, Strict(strict=True)], lang: Lang, keylayout: KeyLayout, biography: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=0), MaxLen(max_length=100)])] | None = None, last_updated_datetime: str | None = None)[source]#

Bases: BaseModel

biography: Annotated[str, Field(min_length=0, strict=True, max_length=100)] | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutMyAccountRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutMyAccountRequest from a JSON string

keylayout: KeyLayout#

lang: Lang#

last_updated_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

user_id: StrictStr#

username: StrictStr#

annofabapi.pydantic_models.put_my_notification_message_opened_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_my_notification_message_opened_request.PutMyNotificationMessageOpenedRequest(*, opened: Annotated[bool, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutMyNotificationMessageOpenedRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutMyNotificationMessageOpenedRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

opened: StrictBool | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_organization_idp_body module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_organization_idp_body.PutOrganizationIdpBody(*, client_id: Annotated[str, Strict(strict=True)], client_secret: Annotated[str, Strict(strict=True)], attributes_request_method: Annotated[str, Strict(strict=True)], endpoints: OidcEndpoints, attribute_mapping: OidcAttributeMapping)[source]#

Bases: BaseModel

組織が利用するIDプロバイダー設定

attribute_mapping: OidcAttributeMapping#

attributes_request_method: StrictStr#

classmethod attributes_request_method_validate_enum(value)[source]#: Validates the enum

client_id: StrictStr#

client_secret: StrictStr#

endpoints: OidcEndpoints#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutOrganizationIdpBody from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutOrganizationIdpBody from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_organization_member_role_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_organization_member_role_request.PutOrganizationMemberRoleRequest(*, role: OrganizationMemberRole, last_updated_datetime: str | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutOrganizationMemberRoleRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutOrganizationMemberRoleRequest from a JSON string

last_updated_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

role: OrganizationMemberRole#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_organization_plugin_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_organization_plugin_request.PutOrganizationPluginRequest(*, plugin_name: Annotated[str, Strict(strict=True)] | None = None, description: Annotated[str, Strict(strict=True)] | None = None, project_extra_data_kinds: List[Annotated[str, Strict(strict=True)]] | None = None, detail: PluginDetail, last_updated_datetime: str | None = None)[source]#

Bases: BaseModel

description: StrictStr | None#

detail: PluginDetail#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutOrganizationPluginRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutOrganizationPluginRequest from a JSON string

last_updated_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

plugin_name: StrictStr | None#

project_extra_data_kinds: List[StrictStr] | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_organization_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_organization_request.PutOrganizationRequest(*, organization_name: Annotated[str, Strict(strict=True)], last_updated_datetime: str)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutOrganizationRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutOrganizationRequest from a JSON string

last_updated_datetime: str#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_name: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_project_extra_data_body module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_project_extra_data_body.PutProjectExtraDataBody(*, value: Any | None, last_updated_datetime: str | None = None)[source]#

Bases: BaseModel

プロジェクトの追加データの更新時のリクエストボディ

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutProjectExtraDataBody from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutProjectExtraDataBody from a JSON string

last_updated_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

value: Any | None#

annofabapi.pydantic_models.put_project_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_project_request.PutProjectRequest(*, title: Annotated[str, Strict(strict=True)], overview: Annotated[str, Strict(strict=True)] | None = None, status: ProjectStatus, input_data_type: InputDataType | None = None, organization_name: Annotated[str, Strict(strict=True)], configuration: ProjectConfigurationPut, last_updated_datetime: str | None = None, force_suspend: Annotated[bool, Strict(strict=True)] | None = False)[source]#

Bases: BaseModel

configuration: ProjectConfigurationPut#

force_suspend: StrictBool | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutProjectRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutProjectRequest from a JSON string

input_data_type: InputDataType | None#

last_updated_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_name: StrictStr#

overview: StrictStr | None#

status: ProjectStatus#

title: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_project_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_project_response.PutProjectResponse(*, job: ProjectJobInfo, project: Project)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutProjectResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutProjectResponse from a JSON string

job: ProjectJobInfo#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project: Project#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.put_webhook_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.put_webhook_request.PutWebhookRequest(*, project_id: Annotated[str, Strict(strict=True)], event_type: WebhookEventType, webhook_id: Annotated[str, Strict(strict=True)], webhook_status: WebhookStatus, method: WebhookHttpMethod, headers: List[WebhookHeader], body: Annotated[str, Strict(strict=True)] | None = None, url: Annotated[str, Strict(strict=True)], created_datetime: str | None = None, updated_datetime: str | None = None)[source]#

Bases: BaseModel

body: StrictStr | None#

created_datetime: str | None#

event_type: WebhookEventType#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of PutWebhookRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of PutWebhookRequest from a JSON string

headers: List[WebhookHeader]#

method: WebhookHttpMethod#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

url: StrictStr#

webhook_id: StrictStr#

webhook_status: WebhookStatus#

annofabapi.pydantic_models.refresh_token_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.refresh_token_request.RefreshTokenRequest(*, refresh_token: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of RefreshTokenRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of RefreshTokenRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

refresh_token: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.reply_comment module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.reply_comment.ReplyComment(*, root_comment_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ReplyComment from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ReplyComment from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root_comment_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.reply_required module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.reply_required.ReplyRequired(*, inspection: Inspection, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

返信が必要な検査コメントが残っている時のエラー

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ReplyRequired from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ReplyRequired from a JSON string

inspection: Inspection#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.reset_email_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.reset_email_request.ResetEmailRequest(*, email: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

email: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of ResetEmailRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of ResetEmailRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.resolution module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.resolution.Resolution(*, width: Annotated[int, Strict(strict=True)], height: Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Resolution from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Resolution from a JSON string

height: StrictInt#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

width: StrictInt#

annofabapi.pydantic_models.revoke_personal_access_token_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.revoke_personal_access_token_request.RevokePersonalAccessTokenRequest(*, id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of RevokePersonalAccessTokenRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of RevokePersonalAccessTokenRequest from a JSON string

id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.revoke_project_token_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.revoke_project_token_request.RevokeProjectTokenRequest(*, project_id: Annotated[str, Strict(strict=True)], project_token: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of RevokeProjectTokenRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of RevokeProjectTokenRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

project_token: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.root_comment module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.root_comment.RootComment(*, data: InspectionData | None = None, annotation_id: Annotated[str, Strict(strict=True)] | None = None, label_id: Annotated[str, Strict(strict=True)] | None = None, status: CommentStatus | None = None, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

annotation_id: StrictStr | None#

data: InspectionData | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of RootComment from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of RootComment from a JSON string

label_id: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: CommentStatus | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.segmentation_metadata module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.segmentation_metadata.SegmentationMetadata(*, min_width: Annotated[int, Strict(strict=True)], min_height: Annotated[int, Strict(strict=True)], min_warn_rule: Annotated[str, Strict(strict=True)], tolerance: Annotated[int, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

塗りつぶしアノテーションのメタデータ

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SegmentationMetadata from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SegmentationMetadata from a JSON string

min_height: StrictInt#

min_warn_rule: StrictStr#

classmethod min_warn_rule_validate_enum(value)[source]#: Validates the enum

min_width: StrictInt#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

tolerance: StrictInt | None#

annofabapi.pydantic_models.sign_up_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.sign_up_request.SignUpRequest(*, email: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

email: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SignUpRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SignUpRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.simple_annotation module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.simple_annotation.SimpleAnnotation(*, annotation_format_version: Annotated[str, Strict(strict=True)], project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], task_phase: TaskPhase, task_phase_stage: Annotated[int, Strict(strict=True), Ge(ge=1)], task_status: TaskStatus, input_data_id: Annotated[str, Strict(strict=True)], input_data_name: Annotated[str, Strict(strict=True)], details: List[SimpleAnnotationDetail], updated_datetime: str | None = None)[source]#

Bases: BaseModel

annotation_format_version: StrictStr#

details: List[SimpleAnnotationDetail]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SimpleAnnotation from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SimpleAnnotation from a JSON string

input_data_id: StrictStr#

input_data_name: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

task_phase: TaskPhase#

task_phase_stage: Annotated[int, Field(strict=True, ge=1)]#

task_status: TaskStatus#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str | None#

annofabapi.pydantic_models.simple_annotation_detail module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.simple_annotation_detail.SimpleAnnotationDetail(*, label: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], data: FullAnnotationData, attributes: Dict[str, Any])[source]#

Bases: BaseModel

annotation_id: StrictStr#

attributes: Dict[str, Any]#

data: FullAnnotationData#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SimpleAnnotationDetail from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SimpleAnnotationDetail from a JSON string

label: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.single_annotation module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.single_annotation.SingleAnnotation(*args, oneof_schema_1_validator: SingleAnnotationV1 | None = None, oneof_schema_2_validator: SingleAnnotationV2 | None = None, actual_instance: SingleAnnotationV1 | SingleAnnotationV2 | None = None, one_of_schemas: Set[str] = {'SingleAnnotationV1', 'SingleAnnotationV2'})[source]#

Bases: BaseModel

actual_instance: SingleAnnotationV1 | SingleAnnotationV2 | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: SingleAnnotationV1 | None#

oneof_schema_2_validator: SingleAnnotationV2 | None#

to_dict() → Dict[str, Any] | SingleAnnotationV1 | SingleAnnotationV2 | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.single_annotation_detail_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.single_annotation_detail_v1.SingleAnnotationDetailV1(*, annotation_id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], label_id: Annotated[str, Strict(strict=True)], data_holding_type: AnnotationDataHoldingType, data: FullAnnotationData | None = None, etag: Annotated[str, Strict(strict=True)] | None = None, url: Annotated[str, Strict(strict=True)] | None = None, additional_data_list: List[AdditionalDataV1], created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

アノテーション情報

account_id: StrictStr#

additional_data_list: List[AdditionalDataV1]#

annotation_id: StrictStr#

created_datetime: str#

data: FullAnnotationData | None#

data_holding_type: AnnotationDataHoldingType#

etag: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SingleAnnotationDetailV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SingleAnnotationDetailV1 from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

url: StrictStr | None#

annofabapi.pydantic_models.single_annotation_detail_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.single_annotation_detail_v2.SingleAnnotationDetailV2(*, annotation_id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], label_id: Annotated[str, Strict(strict=True)], body: AnnotationDetailContentOutput, additional_data_list: List[AdditionalDataV2], created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

アノテーション情報

account_id: StrictStr#

additional_data_list: List[AdditionalDataV2]#

annotation_id: StrictStr#

body: AnnotationDetailContentOutput#

created_datetime: str#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SingleAnnotationDetailV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SingleAnnotationDetailV2 from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.single_annotation_v1 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.single_annotation_v1.SingleAnnotationV1(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], detail: SingleAnnotationDetailV1, updated_datetime: str)[source]#

Bases: BaseModel

detail: SingleAnnotationDetailV1#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SingleAnnotationV1 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SingleAnnotationV1 from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.single_annotation_v2 module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.single_annotation_v2.SingleAnnotationV2(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], detail: SingleAnnotationDetailV2, updated_datetime: str)[source]#

Bases: BaseModel

detail: SingleAnnotationDetailV2#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SingleAnnotationV2 from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SingleAnnotationV2 from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

annofabapi.pydantic_models.supplementary_data module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.supplementary_data.SupplementaryData(*, organization_id: Annotated[str, Strict(strict=True)], input_data_set_id: Annotated[str, Strict(strict=True)], project_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)], supplementary_data_id: Annotated[str, Strict(strict=True)], supplementary_data_name: Annotated[str, Strict(strict=True)], supplementary_data_path: Annotated[str, Strict(strict=True)], url: Annotated[str, Strict(strict=True)], etag: Annotated[str, Strict(strict=True)] | None = None, supplementary_data_type: SupplementaryDataType, supplementary_data_number: Annotated[int, Strict(strict=True), Ge(ge=0)], updated_datetime: str)[source]#

Bases: BaseModel

etag: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SupplementaryData from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SupplementaryData from a JSON string

input_data_id: StrictStr#

input_data_set_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr#

project_id: StrictStr#

supplementary_data_id: StrictStr#

supplementary_data_name: StrictStr#

supplementary_data_number: Annotated[int, Field(strict=True, ge=0)]#

supplementary_data_path: StrictStr#

supplementary_data_type: SupplementaryDataType#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

url: StrictStr#

annofabapi.pydantic_models.supplementary_data_by_input_data_id_identifier module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.supplementary_data_by_input_data_id_identifier.SupplementaryDataByInputDataIdIdentifier(*, project_id: Annotated[str, Strict(strict=True)], input_data_id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

補助情報の所属先

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SupplementaryDataByInputDataIdIdentifier from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SupplementaryDataByInputDataIdIdentifier from a JSON string

input_data_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.supplementary_data_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.supplementary_data_request.SupplementaryDataRequest(*, supplementary_data_name: Annotated[str, Strict(strict=True)], supplementary_data_path: Annotated[str, Strict(strict=True)], supplementary_data_type: SupplementaryDataType, supplementary_data_number: Annotated[int, Strict(strict=True), Ge(ge=0)], last_updated_datetime: str | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SupplementaryDataRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SupplementaryDataRequest from a JSON string

last_updated_datetime: str | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

supplementary_data_name: StrictStr#

supplementary_data_number: Annotated[int, Field(strict=True, ge=0)]#

supplementary_data_path: StrictStr#

supplementary_data_type: SupplementaryDataType#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.supplementary_data_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.supplementary_data_type.SupplementaryDataType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

補助情報の種類 * image - 画像 * text - テキスト * custom - カスタム（カスタムプロジェクトでしか利用できません）

CUSTOM = 'custom'#

IMAGE = 'image'#

TEXT = 'text'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of SupplementaryDataType from a JSON string

annofabapi.pydantic_models.system_metadata module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.system_metadata.SystemMetadata(*args, oneof_schema_1_validator: SystemMetadataImage | None = None, oneof_schema_2_validator: SystemMetadataMovie | None = None, oneof_schema_3_validator: SystemMetadataCustom | None = None, actual_instance: SystemMetadataCustom | SystemMetadataImage | SystemMetadataMovie | None = None, one_of_schemas: Set[str] = {'SystemMetadataCustom', 'SystemMetadataImage', 'SystemMetadataMovie'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

Annofabが設定したメタデータです。 metadata`プロパティとは違い、ユーザー側では値を編集できません。 * `SystemMetadataImage: 画像プロジェクト用のメタデータ * SystemMetadataMovie: 動画プロジェクト用のメタデータ * SystemMetadataCustom: カスタムプロジェクト用のメタデータ

actual_instance: SystemMetadataCustom | SystemMetadataImage | SystemMetadataMovie | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: SystemMetadataImage | None#

oneof_schema_2_validator: SystemMetadataMovie | None#

oneof_schema_3_validator: SystemMetadataCustom | None#

to_dict() → Dict[str, Any] | SystemMetadataCustom | SystemMetadataImage | SystemMetadataMovie | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.system_metadata_custom module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.system_metadata_custom.SystemMetadataCustom(*, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

カスタムデータ用システムメタデータ。現行はプロパティがない形式的なオブジェクトです。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SystemMetadataCustom from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SystemMetadataCustom from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.system_metadata_image module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.system_metadata_image.SystemMetadataImage(*, original_resolution: Resolution | None = None, resized_resolution: Resolution | None = None, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

画像データ用システムメタデータ。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SystemMetadataImage from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SystemMetadataImage from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

original_resolution: Resolution | None#

resized_resolution: Resolution | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.system_metadata_movie module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.system_metadata_movie.SystemMetadataMovie(*, input_duration: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)] | None = None, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

動画データ用システムメタデータ。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of SystemMetadataMovie from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of SystemMetadataMovie from a JSON string

input_duration: StrictFloat | StrictInt | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.task module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task.Task(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], phase: TaskPhase, phase_stage: Annotated[int, Strict(strict=True), Ge(ge=1)], status: TaskStatus, input_data_id_list: List[Annotated[str, Strict(strict=True)]], account_id: Annotated[str, Strict(strict=True)] | None = None, histories_by_phase: List[TaskHistoryShort], work_time_span: Annotated[int, Strict(strict=True)], number_of_rejections: Annotated[int, Strict(strict=True)], started_datetime: str | None = None, updated_datetime: str, operation_updated_datetime: str | None = None, sampling: Annotated[str, Strict(strict=True)] | None = None, metadata: Dict[str, Any] | None = None)[source]#

Bases: BaseModel

account_id: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Task from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Task from a JSON string

histories_by_phase: List[TaskHistoryShort]#

input_data_id_list: List[StrictStr]#

metadata: Dict[str, Any] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number_of_rejections: StrictInt#

operation_updated_datetime: str | None#

phase: TaskPhase#

phase_stage: Annotated[int, Field(strict=True, ge=1)]#

project_id: StrictStr#

sampling: StrictStr | None#

classmethod sampling_validate_enum(value)[source]#: Validates the enum

started_datetime: str | None#

status: TaskStatus#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

work_time_span: StrictInt#

annofabapi.pydantic_models.task_assign_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_assign_request.TaskAssignRequest(*, request_type: TaskAssignRequestType)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskAssignRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskAssignRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

request_type: TaskAssignRequestType#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.task_assign_request_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_assign_request_type.TaskAssignRequestType(*args, oneof_schema_1_validator: TaskAssignRequestTypeRandom | None = None, oneof_schema_2_validator: TaskAssignRequestTypeSelection | None = None, oneof_schema_3_validator: TaskAssignRequestTypeTaskProperty | None = None, actual_instance: TaskAssignRequestTypeRandom | TaskAssignRequestTypeSelection | TaskAssignRequestTypeTaskProperty | None = None, one_of_schemas: Set[str] = {'TaskAssignRequestTypeRandom', 'TaskAssignRequestTypeSelection', 'TaskAssignRequestTypeTaskProperty'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

TaskAssignRequestTypeRandom: 自分自身にランダムにタスクを割り当てます。プロジェクト設定でタスクのランダム割当を有効にした場合のみ利用できます。 * TaskAssignRequestTypeSelection: メンバーに指定したタスクを割り当てます。ただし、メンバーはプロジェクトオーナーもしくはチェッカーロールを持つ必要があります。プロジェクト設定でタスクの選択割当を有効にした場合のみ利用できます。 * TaskAssignRequestTypeTaskProperty: タスクプロパティ割当の設定に基づいて、タスクを自分自身に割り当てます。プロジェクト設定でタスクプロパティ割当を有効にした場合のみ利用できます。

actual_instance: TaskAssignRequestTypeRandom | TaskAssignRequestTypeSelection | TaskAssignRequestTypeTaskProperty | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: TaskAssignRequestTypeRandom | None#

oneof_schema_2_validator: TaskAssignRequestTypeSelection | None#

oneof_schema_3_validator: TaskAssignRequestTypeTaskProperty | None#

to_dict() → Dict[str, Any] | TaskAssignRequestTypeRandom | TaskAssignRequestTypeSelection | TaskAssignRequestTypeTaskProperty | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.task_assign_request_type_random module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_assign_request_type_random.TaskAssignRequestTypeRandom(*, phase: TaskPhase, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskAssignRequestTypeRandom from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskAssignRequestTypeRandom from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.task_assign_request_type_selection module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_assign_request_type_selection.TaskAssignRequestTypeSelection(*, user_id: Annotated[str, Strict(strict=True)], task_ids: List[Annotated[str, Strict(strict=True)]], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskAssignRequestTypeSelection from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskAssignRequestTypeSelection from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

task_ids: List[StrictStr]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

user_id: StrictStr#

annofabapi.pydantic_models.task_assign_request_type_task_property module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_assign_request_type_task_property.TaskAssignRequestTypeTaskProperty(*, phase: TaskPhase, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskAssignRequestTypeTaskProperty from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskAssignRequestTypeTaskProperty from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.task_assignment_order module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_assignment_order.TaskAssignmentOrder(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

タスクの割当優先度を決定するための並び順。 * asc - 昇順 * desc - 降順

ASC = 'asc'#

DESC = 'desc'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of TaskAssignmentOrder from a JSON string

annofabapi.pydantic_models.task_assignment_property module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_assignment_property.TaskAssignmentProperty(*, name: Annotated[str, Strict(strict=True)], order: TaskAssignmentOrder)[source]#

Bases: BaseModel

プロジェクト設定でタスクプロパティ割当を有効にしている場合のみ指定してください。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskAssignmentProperty from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskAssignmentProperty from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr#

order: TaskAssignmentOrder#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.task_assignment_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_assignment_type.TaskAssignmentType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

プロジェクトで使用するタスクの割当方式。 * random - タスクフェーズのみを指定してランダムにタスクを自身に割当する方式です。 * selection - 担当者とタスクを明示的に指定してタスクを割当する方式です。プロジェクトオーナーもしくはチェッカーのみ、自身以外のプロジェクトメンバーを担当者に指定できます。 * random_and_selection - ランダム割当と選択割当の両機能を使用する方式です。 * task_property - タスクのプロパティ(タスクID/更新日時/メタデータ)と並び順(昇順/降順)を設定して、その順番通りにタスクを割当する方式です。順番が同じタスクが複数ある場合は、その中からランダムに1つのタスクを割当します。プロパティと並び順は`TaskAssignmentProperty` から設定します。 * custom - タスク割当アルゴリズム (API) を独自に定義してタスクを割当する方式です。

CUSTOM = 'custom'#

RANDOM = 'random'#

RANDOM_AND_SELECTION = 'random_and_selection'#

SELECTION = 'selection'#

TASK_PROPERTY = 'task_property'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of TaskAssignmentType from a JSON string

annofabapi.pydantic_models.task_generate_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_generate_request.TaskGenerateRequest(*, task_generate_rule: TaskGenerateRule, project_last_updated_datetime: str)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskGenerateRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskGenerateRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_last_updated_datetime: str#

task_generate_rule: TaskGenerateRule#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.task_generate_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_generate_response.TaskGenerateResponse(*, job: ProjectJobInfo, project: Project)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskGenerateResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskGenerateResponse from a JSON string

job: ProjectJobInfo#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project: Project#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.task_generate_response_wrapper module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_generate_response_wrapper.TaskGenerateResponseWrapper(*args, oneof_schema_1_validator: Project | None = None, oneof_schema_2_validator: TaskGenerateResponse | None = None, actual_instance: Project | TaskGenerateResponse | None = None, one_of_schemas: Set[str] = {'Project', 'TaskGenerateResponse'})[source]#

Bases: BaseModel

actual_instance: Project | TaskGenerateResponse | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: Project | None#

oneof_schema_2_validator: TaskGenerateResponse | None#

to_dict() → Dict[str, Any] | Project | TaskGenerateResponse | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.task_generate_rule module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_generate_rule.TaskGenerateRule(*args, oneof_schema_1_validator: TaskGenerateRuleByCount | None = None, oneof_schema_2_validator: TaskGenerateRuleByDirectory | None = None, oneof_schema_3_validator: TaskGenerateRuleByInputDataCsv | None = None, actual_instance: TaskGenerateRuleByCount | TaskGenerateRuleByDirectory | TaskGenerateRuleByInputDataCsv | None = None, one_of_schemas: Set[str] = {'TaskGenerateRuleByCount', 'TaskGenerateRuleByDirectory', 'TaskGenerateRuleByInputDataCsv'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

タスク生成のルール * TaskGenerateRuleByCount: 1つのタスクに割り当てる入力データの個数を指定してタスクを生成します。 * TaskGenerateRuleByDirectory: 入力データ名をファイルパスに見立てて、ディレクトリ単位でタスクを生成します。 * TaskGenerateRuleByInputDataCsv: 各タスクへの入力データへの割り当てを記入したCSVをアップロードした、一時データ保存先パスを指定してタスクを生成します。

actual_instance: TaskGenerateRuleByCount | TaskGenerateRuleByDirectory | TaskGenerateRuleByInputDataCsv | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_1_validator: TaskGenerateRuleByCount | None#

oneof_schema_2_validator: TaskGenerateRuleByDirectory | None#

oneof_schema_3_validator: TaskGenerateRuleByInputDataCsv | None#

to_dict() → Dict[str, Any] | TaskGenerateRuleByCount | TaskGenerateRuleByDirectory | TaskGenerateRuleByInputDataCsv | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.task_generate_rule_by_count module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_generate_rule_by_count.TaskGenerateRuleByCount(*, task_id_prefix: Annotated[str, Strict(strict=True)], allow_duplicate_input_data: Annotated[bool, Strict(strict=True)], input_data_count: Annotated[int, Strict(strict=True), Ge(ge=1), Le(le=200)], input_data_order: InputDataOrder, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

1つのタスクに割り当てる入力データの個数を指定してタスクを生成します。

allow_duplicate_input_data: StrictBool#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskGenerateRuleByCount from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskGenerateRuleByCount from a JSON string

input_data_count: Annotated[int, Field(le=200, strict=True, ge=1)]#

input_data_order: InputDataOrder#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

task_id_prefix: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.task_generate_rule_by_directory module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_generate_rule_by_directory.TaskGenerateRuleByDirectory(*, task_id_prefix: Annotated[str, Strict(strict=True)], input_data_name_prefix: Annotated[str, Strict(strict=True)] | None = None, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

入力データ名をファイルパスに見立て、ディレクトリ単位でタスクを生成します。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskGenerateRuleByDirectory from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskGenerateRuleByDirectory from a JSON string

input_data_name_prefix: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

task_id_prefix: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.task_generate_rule_by_input_data_csv module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_generate_rule_by_input_data_csv.TaskGenerateRuleByInputDataCsv(*, csv_data_path: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

各タスクへの入力データへの割当を記入したCSVへのS3上のパスを指定してタスクを生成します。 1つのタスクに対する入力データの個数は最大200です。200を超えるタスクが1つでもある場合にはタスク生成に失敗します。

csv_data_path: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskGenerateRuleByInputDataCsv from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskGenerateRuleByInputDataCsv from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

annofabapi.pydantic_models.task_history module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_history.TaskHistory(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], task_history_id: Annotated[str, Strict(strict=True)], started_datetime: str | None = None, ended_datetime: str | None = None, accumulated_labor_time_milliseconds: Annotated[str, Strict(strict=True)], phase: TaskPhase, phase_stage: Annotated[int, Strict(strict=True), Ge(ge=1)], account_id: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

タスクのあるフェーズで、誰がいつどれくらいの作業時間を費やしたかを表すタスク履歴です。

account_id: StrictStr | None#

accumulated_labor_time_milliseconds: StrictStr#

ended_datetime: str | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskHistory from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskHistory from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

phase_stage: Annotated[int, Field(strict=True, ge=1)]#

project_id: StrictStr#

started_datetime: str | None#

task_history_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.task_history_event module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_history_event.TaskHistoryEvent(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], task_history_id: Annotated[str, Strict(strict=True)], created_datetime: str, phase: TaskPhase, phase_stage: Annotated[int, Strict(strict=True), Ge(ge=1)], status: TaskStatus, account_id: Annotated[str, Strict(strict=True)] | None = None, request: TaskOperation | None = None)[source]#

Bases: BaseModel

タスク履歴イベントは、タスクの状態が変化した１時点を表します。作業時間は、複数のこれらイベントを集約して計算するものなので、このオブジェクトには含まれません。

account_id: StrictStr | None#

created_datetime: str#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskHistoryEvent from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskHistoryEvent from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

phase_stage: Annotated[int, Field(strict=True, ge=1)]#

project_id: StrictStr#

request: TaskOperation | None#

status: TaskStatus#

task_history_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.task_history_short module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_history_short.TaskHistoryShort(*, phase: TaskPhase, phase_stage: Annotated[int, Strict(strict=True), Ge(ge=1)], account_id: Annotated[str, Strict(strict=True)], worked: Annotated[bool, Strict(strict=True)] | None = False)[source]#

Bases: BaseModel

タスクのあるフェーズを誰が担当したかを表します。

account_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskHistoryShort from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskHistoryShort from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

phase_stage: Annotated[int, Field(strict=True, ge=1)]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

worked: StrictBool | None#

annofabapi.pydantic_models.task_identifier module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_identifier.TaskIdentifier(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

タスクを指定するための情報

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskIdentifier from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskIdentifier from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.task_input_validation module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_input_validation.TaskInputValidation(*, input_data_id: Annotated[str, Strict(strict=True)], annotation_errors: List[ValidationError], inspection_errors: List[InspectionValidationError], comment_errors: List[CommentValidationError])[source]#

Bases: BaseModel

タスクの提出操作に対する入力データID別のバリデーション結果です。

annotation_errors: List[ValidationError]#

comment_errors: List[CommentValidationError]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskInputValidation from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskInputValidation from a JSON string

input_data_id: StrictStr#

inspection_errors: List[InspectionValidationError]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.task_list module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_list.TaskList(*, list: List[Task], page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_page_no: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], total_count: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], over_limit: Annotated[bool, Strict(strict=True)], aggregations: List[AggregationResult])[source]#

Bases: BaseModel

aggregations: List[AggregationResult]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskList from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskList from a JSON string

list: List[Task]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

over_limit: StrictBool#

page_no: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

total_count: StrictFloat | StrictInt#

total_page_no: StrictFloat | StrictInt#

annofabapi.pydantic_models.task_operation module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_operation.TaskOperation(*, status: TaskStatus, last_updated_datetime: str, account_id: Annotated[str, Strict(strict=True)] | None = None, force: Annotated[bool, Strict(strict=True)] | None = False)[source]#

Bases: BaseModel

account_id: StrictStr | None#

force: StrictBool | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskOperation from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskOperation from a JSON string

last_updated_datetime: str#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: TaskStatus#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.task_phase module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_phase.TaskPhase(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

タスクのフェーズ * annotation - 教師付け * inspection - 検査 * acceptance - 受入

ACCEPTANCE = 'acceptance'#

ANNOTATION = 'annotation'#

INSPECTION = 'inspection'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of TaskPhase from a JSON string

annofabapi.pydantic_models.task_phase_statistics module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_phase_statistics.TaskPhaseStatistics(*, project_id: Annotated[str, Strict(strict=True)], date: str, phases: List[PhaseStatistics])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskPhaseStatistics from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskPhaseStatistics from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phases: List[PhaseStatistics]#

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

var_date: str#

annofabapi.pydantic_models.task_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_request.TaskRequest(*, input_data_id_list: List[Annotated[str, Strict(strict=True)]], metadata: Dict[str, Any] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskRequest from a JSON string

input_data_id_list: List[StrictStr]#

metadata: Dict[str, Any] | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.task_status module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_status.TaskStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

タスクのステータス * not_started - 未着手 * working - 作業中 * on_hold - 保留中 * break - 休憩中 * complete - 完了 * rejected - 差し戻し。[operateTask](#operation/operateTask) APIのリクエストボディに渡すときのみ利用する。その他のAPIのリクエストやレスポンスには使われない。 * cancelled - 提出の取り消し。[operateTask](#operation/operateTask) APIのリクエストボディに渡すときのみ利用する。その他のAPIのリクエストやレスポンスには使われない。

BREAK = 'break'#

CANCELLED = 'cancelled'#

COMPLETE = 'complete'#

NOT_STARTED = 'not_started'#

ON_HOLD = 'on_hold'#

REJECTED = 'rejected'#

WORKING = 'working'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of TaskStatus from a JSON string

annofabapi.pydantic_models.task_validation module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.task_validation.TaskValidation(*, project_id: Annotated[str, Strict(strict=True)], task_id: Annotated[str, Strict(strict=True)], inputs: List[InputDataSummary])[source]#

Bases: BaseModel

タスクの全入力データに対するバリデーション結果です。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TaskValidation from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TaskValidation from a JSON string

inputs: List[InputDataSummary]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

task_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.temporary_url module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.temporary_url.TemporaryUrl(*, url: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

認証済み一時URL

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of TemporaryUrl from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of TemporaryUrl from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

url: StrictStr#

annofabapi.pydantic_models.token module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.token.Token(*, id_token: Annotated[str, Strict(strict=True)], access_token: Annotated[str, Strict(strict=True)], refresh_token: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

トークン情報

access_token: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Token from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Token from a JSON string

id_token: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

refresh_token: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.unconfirmed_user_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.unconfirmed_user_response.UnconfirmedUserResponse(*, temporary_token: Token)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UnconfirmedUserResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UnconfirmedUserResponse from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

temporary_token: Token#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.unknown_additional_data module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.unknown_additional_data.UnknownAdditionalData(*, label_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], additional_data_definition_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

何らかの原因で、アノテーション仕様にない属性がついているエラー

additional_data_definition_id: StrictStr#

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UnknownAdditionalData from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UnknownAdditionalData from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.unknown_label module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.unknown_label.UnknownLabel(*, label_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

何らかの原因で、アノテーション仕様にないラベルがついているエラー

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UnknownLabel from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UnknownLabel from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.unknown_link_target module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.unknown_link_target.UnknownLinkTarget(*, label_id: Annotated[str, Strict(strict=True)], annotation_id: Annotated[str, Strict(strict=True)], additional_data_definition_id: Annotated[str, Strict(strict=True)], _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

指定されたIDに該当するアノテーションが存在しないエラー

additional_data_definition_id: StrictStr#

annotation_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UnknownLinkTarget from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UnknownLinkTarget from a JSON string

label_id: StrictStr#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

annofabapi.pydantic_models.update_status_required module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.update_status_required.UpdateStatusRequired(*, comment: Comment, _type: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

状態変更が必要である時のエラー

comment: Comment#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UpdateStatusRequired from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UpdateStatusRequired from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.usage_status module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.usage_status.UsageStatus(*, organization_id: Annotated[str, Strict(strict=True)], year_month: Annotated[str, Strict(strict=True)], aggregation_period_from: str, aggregation_period_to: str, editor_usage: List[EditorUsageTimespan], storage_usage: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)])[source]#

Bases: BaseModel

利用状況

aggregation_period_from: str#

aggregation_period_to: str#

editor_usage: List[EditorUsageTimespan]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UsageStatus from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UsageStatus from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr#

storage_usage: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

year_month: StrictStr#

annofabapi.pydantic_models.usage_status_by_day module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.usage_status_by_day.UsageStatusByDay(*, organization_id: Annotated[str, Strict(strict=True)], date: str, aggregation_period_from: str, aggregation_period_to: str, editor_usage: List[EditorUsageTimespan], storage_usage: Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], created_datetime: str)[source]#

Bases: BaseModel

日ごとの利用状況

aggregation_period_from: str#

aggregation_period_to: str#

created_datetime: str#

editor_usage: List[EditorUsageTimespan]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UsageStatusByDay from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UsageStatusByDay from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organization_id: StrictStr#

storage_usage: StrictFloat | StrictInt#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

var_date: str#

annofabapi.pydantic_models.usage_status_csv_file_url module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.usage_status_csv_file_url.UsageStatusCsvFileUrl(*, url: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

利用状況詳細のCSVファイルのURL

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UsageStatusCsvFileUrl from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UsageStatusCsvFileUrl from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

url: StrictStr#

annofabapi.pydantic_models.user_cache_record module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.user_cache_record.UserCacheRecord(*, account: Annotated[str, Strict(strict=True)] | None = None, members: Annotated[str, Strict(strict=True)] | None = None, organizations: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

account: StrictStr | None#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UserCacheRecord from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UserCacheRecord from a JSON string

members: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

organizations: StrictStr | None#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.user_defined_annotation_data_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.user_defined_annotation_data_type.UserDefinedAnnotationDataType(*, _type: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UserDefinedAnnotationDataType from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UserDefinedAnnotationDataType from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr | None#

classmethod type_validate_enum(value)[source]#: Validates the enum

annofabapi.pydantic_models.user_defined_annotation_type_definition module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.user_defined_annotation_type_definition.UserDefinedAnnotationTypeDefinition(*, annotation_type_name: InternationalizationMessage, field_definitions: List[UserDefinedAnnotationTypeDefinitionFieldDefinitionsInner], metadata: Dict[str, Annotated[str, Strict(strict=True)]], annotation_data_type: UserDefinedAnnotationDataType)[source]#

Bases: BaseModel

annotation_data_type: UserDefinedAnnotationDataType#

annotation_type_name: InternationalizationMessage#

field_definitions: List[UserDefinedAnnotationTypeDefinitionFieldDefinitionsInner]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UserDefinedAnnotationTypeDefinition from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UserDefinedAnnotationTypeDefinition from a JSON string

metadata: Dict[str, StrictStr]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.user_defined_annotation_type_definition_field_definitions_inner module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.user_defined_annotation_type_definition_field_definitions_inner.UserDefinedAnnotationTypeDefinitionFieldDefinitionsInner(*, field_id: Annotated[str, Strict(strict=True)], definition: UserDefinedAnnotationTypeFieldDefinition)[source]#

Bases: BaseModel

definition: UserDefinedAnnotationTypeFieldDefinition#

field_id: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UserDefinedAnnotationTypeDefinitionFieldDefinitionsInner from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UserDefinedAnnotationTypeDefinitionFieldDefinitionsInner from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.user_defined_annotation_type_field_definition module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.user_defined_annotation_type_field_definition.UserDefinedAnnotationTypeFieldDefinition(*args, oneof_schema_1_validator: AnnotationTypeFieldDefinitionMinimumSize2d | None = None, oneof_schema_2_validator: AnnotationTypeFieldDefinitionMinimumSize2dWithDefaultInsertPosition | None = None, oneof_schema_3_validator: AnnotationTypeFieldDefinitionMarginOfErrorTolerance | None = None, oneof_schema_4_validator: AnnotationTypeFieldDefinitionVertexCountMinMax | None = None, oneof_schema_5_validator: AnnotationTypeFieldDefinitionMinimumArea2d | None = None, oneof_schema_6_validator: AnnotationTypeFieldDefinitionDisplayLineDirection | None = None, oneof_schema_7_validator: AnnotationTypeFieldDefinitionAnnotationEditorFeature | None = None, oneof_schema_8_validator: AnnotationTypeFieldDefinitionOneIntegerField | None = None, oneof_schema_9_validator: AnnotationTypeFieldDefinitionOneStringField | None = None, oneof_schema_10_validator: AnnotationTypeFieldDefinitionOneBooleanField | None = None, actual_instance: AnnotationTypeFieldDefinitionAnnotationEditorFeature | AnnotationTypeFieldDefinitionDisplayLineDirection | AnnotationTypeFieldDefinitionMarginOfErrorTolerance | AnnotationTypeFieldDefinitionMinimumArea2d | AnnotationTypeFieldDefinitionMinimumSize2d | AnnotationTypeFieldDefinitionMinimumSize2dWithDefaultInsertPosition | AnnotationTypeFieldDefinitionOneBooleanField | AnnotationTypeFieldDefinitionOneIntegerField | AnnotationTypeFieldDefinitionOneStringField | AnnotationTypeFieldDefinitionVertexCountMinMax | None = None, one_of_schemas: Set[str] = {'AnnotationTypeFieldDefinitionAnnotationEditorFeature', 'AnnotationTypeFieldDefinitionDisplayLineDirection', 'AnnotationTypeFieldDefinitionMarginOfErrorTolerance', 'AnnotationTypeFieldDefinitionMinimumArea2d', 'AnnotationTypeFieldDefinitionMinimumSize2d', 'AnnotationTypeFieldDefinitionMinimumSize2dWithDefaultInsertPosition', 'AnnotationTypeFieldDefinitionOneBooleanField', 'AnnotationTypeFieldDefinitionOneIntegerField', 'AnnotationTypeFieldDefinitionOneStringField', 'AnnotationTypeFieldDefinitionVertexCountMinMax'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

ユーザー定義のアノテーション種別に設定可能なフィールドについての定義です。

actual_instance: AnnotationTypeFieldDefinitionAnnotationEditorFeature | AnnotationTypeFieldDefinitionDisplayLineDirection | AnnotationTypeFieldDefinitionMarginOfErrorTolerance | AnnotationTypeFieldDefinitionMinimumArea2d | AnnotationTypeFieldDefinitionMinimumSize2d | AnnotationTypeFieldDefinitionMinimumSize2dWithDefaultInsertPosition | AnnotationTypeFieldDefinitionOneBooleanField | AnnotationTypeFieldDefinitionOneIntegerField | AnnotationTypeFieldDefinitionOneStringField | AnnotationTypeFieldDefinitionVertexCountMinMax | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_10_validator: AnnotationTypeFieldDefinitionOneBooleanField | None#

oneof_schema_1_validator: AnnotationTypeFieldDefinitionMinimumSize2d | None#

oneof_schema_2_validator: AnnotationTypeFieldDefinitionMinimumSize2dWithDefaultInsertPosition | None#

oneof_schema_3_validator: AnnotationTypeFieldDefinitionMarginOfErrorTolerance | None#

oneof_schema_4_validator: AnnotationTypeFieldDefinitionVertexCountMinMax | None#

oneof_schema_5_validator: AnnotationTypeFieldDefinitionMinimumArea2d | None#

oneof_schema_6_validator: AnnotationTypeFieldDefinitionDisplayLineDirection | None#

oneof_schema_7_validator: AnnotationTypeFieldDefinitionAnnotationEditorFeature | None#

oneof_schema_8_validator: AnnotationTypeFieldDefinitionOneIntegerField | None#

oneof_schema_9_validator: AnnotationTypeFieldDefinitionOneStringField | None#

to_dict() → Dict[str, Any] | AnnotationTypeFieldDefinitionAnnotationEditorFeature | AnnotationTypeFieldDefinitionDisplayLineDirection | AnnotationTypeFieldDefinitionMarginOfErrorTolerance | AnnotationTypeFieldDefinitionMinimumArea2d | AnnotationTypeFieldDefinitionMinimumSize2d | AnnotationTypeFieldDefinitionMinimumSize2dWithDefaultInsertPosition | AnnotationTypeFieldDefinitionOneBooleanField | AnnotationTypeFieldDefinitionOneIntegerField | AnnotationTypeFieldDefinitionOneStringField | AnnotationTypeFieldDefinitionVertexCountMinMax | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.user_id_determinant module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.user_id_determinant.UserIdDeterminant(*, _type: Annotated[str, Strict(strict=True)], user_id: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

ユーザーIDを元に外部IDプロバイダーを特定する決定因子。指定されたユーザが利用すべき外部IDプロバイダーが一つに定まる場合に、その一つを特定する。

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of UserIdDeterminant from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of UserIdDeterminant from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

type: StrictStr#

classmethod type_validate_enum(value)[source]#: Validates the enum

user_id: StrictStr#

annofabapi.pydantic_models.validation_error module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.validation_error.ValidationError(*args, oneof_schema_1_validator: InvalidAnnotationData | None = None, oneof_schema_2_validator: DuplicatedSegmentationV2 | None = None, oneof_schema_3_validator: InvalidValue | None = None, oneof_schema_4_validator: UnknownLinkTarget | None = None, oneof_schema_5_validator: InvalidLinkTarget | None = None, oneof_schema_6_validator: InvalidChoice | None = None, oneof_schema_7_validator: DuplicatedV1 | None = None, oneof_schema_8_validator: DuplicatedV2 | None = None, oneof_schema_9_validator: UnknownAdditionalData | None = None, oneof_schema_10_validator: OverlappedRangeAnnotation | None = None, oneof_schema_11_validator: UnknownLabel | None = None, actual_instance: DuplicatedSegmentationV2 | DuplicatedV1 | DuplicatedV2 | InvalidAnnotationData | InvalidChoice | InvalidLinkTarget | InvalidValue | OverlappedRangeAnnotation | UnknownAdditionalData | UnknownLabel | UnknownLinkTarget | None = None, one_of_schemas: Set[str] = {'DuplicatedSegmentationV2', 'DuplicatedV1', 'DuplicatedV2', 'InvalidAnnotationData', 'InvalidChoice', 'InvalidLinkTarget', 'InvalidValue', 'OverlappedRangeAnnotation', 'UnknownAdditionalData', 'UnknownLabel', 'UnknownLinkTarget'}, discriminator_value_class_map: Dict[str, str] = {})[source]#

Bases: BaseModel

actual_instance: DuplicatedSegmentationV2 | DuplicatedV1 | DuplicatedV2 | InvalidAnnotationData | InvalidChoice | InvalidLinkTarget | InvalidValue | OverlappedRangeAnnotation | UnknownAdditionalData | UnknownLabel | UnknownLinkTarget | None#

classmethod actual_instance_must_validate_oneof(v)[source]#

discriminator_value_class_map: Dict[str, str]#

classmethod from_dict(obj: str | Dict[str, Any]) → Self[source]#

classmethod from_json(json_str: str) → Self[source]#: Returns the object represented by the json string

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]#

oneof_schema_10_validator: OverlappedRangeAnnotation | None#

oneof_schema_11_validator: UnknownLabel | None#

oneof_schema_1_validator: InvalidAnnotationData | None#

oneof_schema_2_validator: DuplicatedSegmentationV2 | None#

oneof_schema_3_validator: InvalidValue | None#

oneof_schema_4_validator: UnknownLinkTarget | None#

oneof_schema_5_validator: InvalidLinkTarget | None#

oneof_schema_6_validator: InvalidChoice | None#

oneof_schema_7_validator: DuplicatedV1 | None#

oneof_schema_8_validator: DuplicatedV2 | None#

oneof_schema_9_validator: UnknownAdditionalData | None#

to_dict() → Dict[str, Any] | DuplicatedSegmentationV2 | DuplicatedV1 | DuplicatedV2 | InvalidAnnotationData | InvalidChoice | InvalidLinkTarget | InvalidValue | OverlappedRangeAnnotation | UnknownAdditionalData | UnknownLabel | UnknownLinkTarget | None[source]#: Returns the dict representation of the actual instance

to_json() → str[source]#: Returns the JSON representation of the actual instance

to_str() → str[source]#: Returns the string representation of the actual instance

annofabapi.pydantic_models.verify_email_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.verify_email_request.VerifyEmailRequest(*, token: Token)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of VerifyEmailRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of VerifyEmailRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

token: Token#

annofabapi.pydantic_models.webhook module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.webhook.Webhook(*, project_id: Annotated[str, Strict(strict=True)], event_type: WebhookEventType, webhook_id: Annotated[str, Strict(strict=True)], webhook_status: WebhookStatus, method: WebhookHttpMethod, headers: List[WebhookHeader], body: Annotated[str, Strict(strict=True)] | None = None, url: Annotated[str, Strict(strict=True)], created_datetime: str, updated_datetime: str)[source]#

Bases: BaseModel

body: StrictStr | None#

created_datetime: str#

event_type: WebhookEventType#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of Webhook from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of Webhook from a JSON string

headers: List[WebhookHeader]#

method: WebhookHttpMethod#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

updated_datetime: str#

url: StrictStr#

webhook_id: StrictStr#

webhook_status: WebhookStatus#

annofabapi.pydantic_models.webhook_event_type module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.webhook_event_type.WebhookEventType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

Webhookイベントの種類 * task-completed - タスク受入完了 * annotation-archive-updated - アノテーションZIP作成完了 * input-data-zip-registered - 入力データZIP登録完了 * project-copy-completed - プロジェクトコピー完了

ANNOTATION_MINUS_ARCHIVE_MINUS_UPDATED = 'annotation-archive-updated'#

INPUT_MINUS_DATA_MINUS_ZIP_MINUS_REGISTERED = 'input-data-zip-registered'#

PROJECT_MINUS_COPY_MINUS_COMPLETED = 'project-copy-completed'#

TASK_MINUS_COMPLETED = 'task-completed'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of WebhookEventType from a JSON string

annofabapi.pydantic_models.webhook_header module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.webhook_header.WebhookHeader(*, name: Annotated[str, Strict(strict=True)], value: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of WebhookHeader from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of WebhookHeader from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

value: StrictStr#

annofabapi.pydantic_models.webhook_http_method module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.webhook_http_method.WebhookHttpMethod(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

Webhook通知するHTTPリクエストのメソッド

DELETE = 'DELETE'#

GET = 'GET'#

POST = 'POST'#

PUT = 'PUT'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of WebhookHttpMethod from a JSON string

annofabapi.pydantic_models.webhook_status module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.webhook_status.WebhookStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

Webhookの状態

ACTIVE = 'active'#

INACTIVE = 'inactive'#

classmethod from_json(json_str: str) → Self[source]#: Create an instance of WebhookStatus from a JSON string

annofabapi.pydantic_models.webhook_test_request module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.webhook_test_request.WebhookTestRequest(*, placeholders: Dict[str, Annotated[str, Strict(strict=True)]])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of WebhookTestRequest from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of WebhookTestRequest from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

placeholders: Dict[str, StrictStr]#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.webhook_test_response module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.webhook_test_response.WebhookTestResponse(*, result: Annotated[str, Strict(strict=True)], request_body: Annotated[str, Strict(strict=True)] | None = None, response_status: Annotated[int, Strict(strict=True)] | None = None, response_body: Annotated[str, Strict(strict=True)] | None = None, message: Annotated[str, Strict(strict=True)] | None = None)[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of WebhookTestResponse from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of WebhookTestResponse from a JSON string

message: StrictStr | None#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

request_body: StrictStr | None#

response_body: StrictStr | None#

response_status: StrictInt | None#

result: StrictStr#

classmethod result_validate_enum(value)[source]#: Validates the enum

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.worktime_statistics module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.worktime_statistics.WorktimeStatistics(*, project_id: Annotated[str, Strict(strict=True)], date: str, by_tasks: List[WorktimeStatisticsItem], by_inputs: List[WorktimeStatisticsItem], by_minutes: List[WorktimeStatisticsItem], accounts: List[AccountWorktimeStatistics])[source]#

Bases: BaseModel

accounts: List[AccountWorktimeStatistics]#

by_inputs: List[WorktimeStatisticsItem]#

by_minutes: List[WorktimeStatisticsItem]#

by_tasks: List[WorktimeStatisticsItem]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of WorktimeStatistics from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of WorktimeStatistics from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

var_date: str#

annofabapi.pydantic_models.worktime_statistics_by_account module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.worktime_statistics_by_account.WorktimeStatisticsByAccount(*, project_id: Annotated[str, Strict(strict=True)], account_id: Annotated[str, Strict(strict=True)], data_series: List[WorktimeStatisticsData])[source]#

Bases: BaseModel

account_id: StrictStr#

data_series: List[WorktimeStatisticsData]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of WorktimeStatisticsByAccount from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of WorktimeStatisticsByAccount from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.worktime_statistics_by_project module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.worktime_statistics_by_project.WorktimeStatisticsByProject(*, project_id: Annotated[str, Strict(strict=True)], data_series: List[WorktimeStatisticsData])[source]#

Bases: BaseModel

data_series: List[WorktimeStatisticsData]#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of WorktimeStatisticsByProject from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of WorktimeStatisticsByProject from a JSON string

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

annofabapi.pydantic_models.worktime_statistics_data module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.worktime_statistics_data.WorktimeStatisticsData(*, date: str, grouped_by_input: List[WorktimeStatisticsItem], grouped_by_task: List[WorktimeStatisticsItem], grouped_by_minute: List[WorktimeStatisticsItem])[source]#

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of WorktimeStatisticsData from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of WorktimeStatisticsData from a JSON string

grouped_by_input: List[WorktimeStatisticsItem]#

grouped_by_minute: List[WorktimeStatisticsItem]#

grouped_by_task: List[WorktimeStatisticsItem]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias

var_date: str#

annofabapi.pydantic_models.worktime_statistics_item module#

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class annofabapi.pydantic_models.worktime_statistics_item.WorktimeStatisticsItem(*, phase: TaskPhase, histogram: List[HistogramItem], average: Annotated[str, Strict(strict=True)], standard_deviation: Annotated[str, Strict(strict=True)])[source]#

Bases: BaseModel

average: StrictStr#

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]#: Create an instance of WorktimeStatisticsItem from a dict

classmethod from_json(json_str: str) → Self | None[source]#: Create an instance of WorktimeStatisticsItem from a JSON string

histogram: List[HistogramItem]#

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phase: TaskPhase#

standard_deviation: StrictStr#

to_dict() → Dict[str, Any][source]#

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str[source]#: Returns the JSON representation of the model using alias

to_str() → str[source]#: Returns the string representation of the model using alias