oercommons_models ================= .. py:module:: oercommons_models Attributes ---------- .. autoapisummary:: oercommons_models.json_path Classes ------- .. autoapisummary:: oercommons_models.FieldSource oercommons_models.Model Module Contents --------------- .. py:class:: FieldSource(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` !!! abstract "Usage Documentation" [Models](../concepts/models.md) A base class for creating Pydantic models. Attributes: __class_vars__: The names of the class variables defined on the model. __private_attributes__: Metadata about the private attributes of the model. __signature__: The synthesized `__init__` [`Signature`][inspect.Signature] of the model. __pydantic_complete__: Whether model building is completed, or if there are still undefined fields. __pydantic_core_schema__: The core schema of the model. __pydantic_custom_init__: Whether the model has a custom `__init__` function. __pydantic_decorators__: Metadata containing the decorators defined on the model. This replaces `Model.__validators__` and `Model.__root_validators__` from Pydantic V1. __pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these. __pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models. __pydantic_post_init__: The name of the post-init method for the model, if defined. __pydantic_root_model__: Whether the model is a [`RootModel`][pydantic.root_model.RootModel]. __pydantic_serializer__: The `pydantic-core` `SchemaSerializer` used to dump instances of the model. __pydantic_validator__: The `pydantic-core` `SchemaValidator` used to validate instances of the model. __pydantic_fields__: A dictionary of field names and their corresponding [`FieldInfo`][pydantic.fields.FieldInfo] objects. __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [`ComputedFieldInfo`][pydantic.fields.ComputedFieldInfo] objects. __pydantic_extra__: A dictionary containing extra values, if [`extra`][pydantic.config.ConfigDict.extra] is set to `'allow'`. __pydantic_fields_set__: The names of fields explicitly set during instantiation. __pydantic_private__: Values of private attributes set on the model instance. .. py:attribute:: id :type: str .. py:attribute:: django_ct :type: str .. py:attribute:: django_id :type: str .. py:attribute:: saves_count :type: int .. py:attribute:: comments_count :type: int .. py:attribute:: downloads_count :type: int .. py:attribute:: ga_visits_count :type: int .. py:attribute:: visits_count :type: int .. py:attribute:: uuid :type: str .. py:attribute:: provider :type: int .. py:attribute:: provider_name :type: str .. py:attribute:: provider_name_exact :type: str .. py:attribute:: provider_slug :type: str .. py:attribute:: provider_slug_exact :type: str .. py:attribute:: is_private :type: bool .. py:attribute:: endorsements :type: list[int] .. py:attribute:: endorsement_names :type: list[str] .. py:attribute:: endorsement_names_exact :type: list[str] .. py:attribute:: collections :type: list[int] .. py:attribute:: collections_titles :type: list[str] .. py:attribute:: is_shared :type: bool .. py:attribute:: evaluated_rubrics :type: list .. py:attribute:: evaluation_types :type: list .. py:attribute:: alignment_tag_codes :type: list .. py:attribute:: alignment_tag_descriptions :type: list .. py:attribute:: unified_alignment_tags_codes :type: list .. py:attribute:: unified_alignment_tags_path :type: list .. py:attribute:: alignment_standards :type: list .. py:attribute:: alignment_grades :type: list .. py:attribute:: alignment_categories :type: list .. py:attribute:: alignment_tags :type: list .. py:attribute:: alignment_tags_exact :type: list .. py:attribute:: faceted_alignment_tags :type: list .. py:attribute:: ngss_alignment_standards :type: list .. py:attribute:: ngss_faceted_alignment_standards :type: list .. py:attribute:: ngss_alignment_grades :type: list .. py:attribute:: ngss_alignment_science_domains :type: list .. py:attribute:: ngss_faceted_alignment_science_domains :type: list .. py:attribute:: ngss_alignment_topics :type: list .. py:attribute:: ngss_faceted_alignment_topics :type: list .. py:attribute:: ngss_alignment_practices :type: list .. py:attribute:: ngss_faceted_alignment_practices :type: list .. py:attribute:: ngss_alignment_cross_cutting_concepts :type: list .. py:attribute:: ngss_faceted_alignment_cross_cutting_concepts :type: list .. py:attribute:: ngss_alignment_disciplinary_core_ideas :type: list .. py:attribute:: ngss_alignment_tags :type: list .. py:attribute:: ngss_faceted_alignment_tags :type: list .. py:attribute:: minnesota_alignment_standards :type: list .. py:attribute:: minnesota_alignment_grades :type: list .. py:attribute:: minnesota_alignment_learning_domains :type: list .. py:attribute:: minnesota_alignment_tags :type: list .. py:attribute:: aaas_alignment_standards :type: list .. py:attribute:: aaas_alignment_grades :type: list .. py:attribute:: aaas_alignment_learning_domains :type: list .. py:attribute:: aaas_alignment_tags :type: list .. py:attribute:: nhss_alignment_standards :type: list .. py:attribute:: nhss_alignment_grades :type: list .. py:attribute:: nhss_alignment_learning_domains :type: list .. py:attribute:: nhss_alignment_topics :type: list .. py:attribute:: nhss_alignment_tags :type: list .. py:attribute:: aasl_alignment_standards :type: list .. py:attribute:: aasl_alignment_grades :type: list .. py:attribute:: aasl_alignment_learning_domains :type: list .. py:attribute:: aasl_alignment_tags :type: list .. py:attribute:: aasl_faceted_alignment_tags :type: list .. py:attribute:: aasl_if_alignment_standards :type: list .. py:attribute:: aasl_if_alignment_levels :type: list .. py:attribute:: aasl_if_alignment_learning_domains :type: list .. py:attribute:: aasl_if_alignment_tags :type: list .. py:attribute:: az_alignment_standards :type: list .. py:attribute:: az_alignment_learning_domains :type: list .. py:attribute:: az_alignment_tags :type: list .. py:attribute:: az_faceted_alignment_tags :type: list .. py:attribute:: az_carlit_alignment_standards :type: list .. py:attribute:: az_carlit_alignment_learning_domains :type: list .. py:attribute:: az_carlit_alignment_tags :type: list .. py:attribute:: az_carlit_faceted_alignment_tags :type: list .. py:attribute:: unesco_alignment_standards :type: list .. py:attribute:: unesco_alignment_levels :type: list .. py:attribute:: unesco_alignment_learning_domains :type: list .. py:attribute:: unesco_alignment_tags :type: list .. py:attribute:: unesco_faceted_alignment_tags :type: list .. py:attribute:: nd_alignment_standards :type: list .. py:attribute:: nd_alignment_grades :type: list .. py:attribute:: nd_alignment_learning_domains :type: list .. py:attribute:: nd_alignment_tags :type: list .. py:attribute:: nd_faceted_alignment_tags :type: list .. py:attribute:: iowa_alignment_standards :type: list .. py:attribute:: iowa_alignment_grades :type: list .. py:attribute:: iowa_alignment_learning_domains :type: list .. py:attribute:: iowa_alignment_tags :type: list .. py:attribute:: iowa_faceted_alignment_tags :type: list .. py:attribute:: ne_alignment_standards :type: list .. py:attribute:: ne_alignment_grades :type: list .. py:attribute:: ne_alignment_learning_domains :type: list .. py:attribute:: ne_alignment_tags :type: list .. py:attribute:: ne_faceted_alignment_tags :type: list .. py:attribute:: mo_alignment_standards :type: list .. py:attribute:: mo_alignment_grades :type: list .. py:attribute:: mo_alignment_learning_domains :type: list .. py:attribute:: mo_alignment_tags :type: list .. py:attribute:: mo_faceted_alignment_tags :type: list .. py:attribute:: mccrs_alignment_standards :type: list .. py:attribute:: mccrs_alignment_grades :type: list .. py:attribute:: mccrs_alignment_learning_domains :type: list .. py:attribute:: mccrs_alignment_tags :type: list .. py:attribute:: mccrs_faceted_alignment_tags :type: list .. py:attribute:: pa_alignment_standards :type: list .. py:attribute:: pa_alignment_grades :type: list .. py:attribute:: pa_alignment_learning_domains :type: list .. py:attribute:: pa_alignment_tags :type: list .. py:attribute:: pa_faceted_alignment_tags :type: list .. py:attribute:: pa_sci_alignment_standards :type: list .. py:attribute:: pa_sci_alignment_grades :type: list .. py:attribute:: pa_sci_alignment_science_domains :type: list .. py:attribute:: pa_sci_alignment_topics :type: list .. py:attribute:: pa_sci_alignment_tags :type: list .. py:attribute:: pa_sci_faceted_alignment_tags :type: list .. py:attribute:: wy_alignment_standards :type: list .. py:attribute:: wy_alignment_grades :type: list .. py:attribute:: wy_alignment_learning_domains :type: list .. py:attribute:: wy_alignment_tags :type: list .. py:attribute:: wy_faceted_alignment_tags :type: list .. py:attribute:: csta_alignment_standards :type: list .. py:attribute:: csta_alignment_grades :type: list .. py:attribute:: csta_alignment_science_domains :type: list .. py:attribute:: csta_alignment_topics :type: list .. py:attribute:: csta_alignment_practices :type: list .. py:attribute:: csta_alignment_tags :type: list .. py:attribute:: csta_faceted_alignment_tags :type: list .. py:attribute:: wa_alignment_standards :type: list .. py:attribute:: wa_alignment_grades :type: list .. py:attribute:: wa_alignment_learning_domains :type: list .. py:attribute:: wa_alignment_tags :type: list .. py:attribute:: wa_faceted_alignment_tags :type: list .. py:attribute:: oregon_alignment_standards :type: list .. py:attribute:: oregon_alignment_grades :type: list .. py:attribute:: oregon_alignment_learning_domains :type: list .. py:attribute:: oregon_alignment_tags :type: list .. py:attribute:: oregon_faceted_alignment_tags :type: list .. py:attribute:: texas_alignment_standards :type: list .. py:attribute:: texas_alignment_grades :type: list .. py:attribute:: texas_alignment_learning_domains :type: list .. py:attribute:: texas_alignment_tags :type: list .. py:attribute:: texas_faceted_alignment_tags :type: list .. py:attribute:: florida_alignment_standards :type: list .. py:attribute:: florida_alignment_grades :type: list .. py:attribute:: florida_alignment_learning_domains :type: list .. py:attribute:: florida_alignment_tags :type: list .. py:attribute:: florida_faceted_alignment_tags :type: list .. py:attribute:: georgia_alignment_standards :type: list .. py:attribute:: georgia_alignment_grades :type: list .. py:attribute:: georgia_alignment_learning_domains :type: list .. py:attribute:: georgia_alignment_tags :type: list .. py:attribute:: georgia_faceted_alignment_tags :type: list .. py:attribute:: nc_alignment_standards :type: list .. py:attribute:: nc_alignment_grades :type: list .. py:attribute:: nc_alignment_learning_domains :type: list .. py:attribute:: nc_alignment_tags :type: list .. py:attribute:: nces_alignment_standards :type: list .. py:attribute:: nces_alignment_grades :type: list .. py:attribute:: nces_alignment_learning_domains :type: list .. py:attribute:: nces_alignment_tags :type: list .. py:attribute:: va_alignment_standards :type: list .. py:attribute:: va_alignment_grades :type: list .. py:attribute:: va_alignment_learning_domains :type: list .. py:attribute:: va_alignment_tags :type: list .. py:attribute:: mada_alignment_standards :type: list .. py:attribute:: mada_alignment_levels :type: list .. py:attribute:: mada_alignment_learning_domains :type: list .. py:attribute:: mada_alignment_tags :type: list .. py:attribute:: nces_gd_alignment_standards :type: list .. py:attribute:: nces_gd_alignment_learning_domains :type: list .. py:attribute:: nces_gd_alignment_tags :type: list .. py:attribute:: nces_wl_alignment_standards :type: list .. py:attribute:: nces_wl_alignment_levels :type: list .. py:attribute:: nces_wl_alignment_learning_domains :type: list .. py:attribute:: nces_wl_alignment_tags :type: list .. py:attribute:: ncdlca_alignment_standards :type: list .. py:attribute:: ncdlca_alignment_learning_domains :type: list .. py:attribute:: ncdlca_alignment_tags :type: list .. py:attribute:: ncdlct_alignment_standards :type: list .. py:attribute:: ncdlct_alignment_learning_domains :type: list .. py:attribute:: ncdlct_alignment_tags :type: list .. py:attribute:: ncpts_alignment_standards :type: list .. py:attribute:: ncpts_alignment_learning_domains :type: list .. py:attribute:: ncpts_alignment_tags :type: list .. py:attribute:: mi_alignment_standards :type: list .. py:attribute:: mi_alignment_grades :type: list .. py:attribute:: mi_alignment_learning_domains :type: list .. py:attribute:: mi_alignment_tags :type: list .. py:attribute:: mi_faceted_alignment_tags :type: list .. py:attribute:: lacc_alignment_standards :type: list .. py:attribute:: lacc_alignment_learning_domains :type: list .. py:attribute:: lacc_alignment_tags :type: list .. py:attribute:: lacc_faceted_alignment_tags :type: list .. py:attribute:: viva_alignment_standards :type: list .. py:attribute:: viva_alignment_learning_domains :type: list .. py:attribute:: viva_alignment_tags :type: list .. py:attribute:: viva_faceted_alignment_tags :type: list .. py:attribute:: oh_alignment_standards :type: list .. py:attribute:: oh_alignment_learning_domains :type: list .. py:attribute:: oh_alignment_tags :type: list .. py:attribute:: oh_faceted_alignment_tags :type: list .. py:attribute:: oet_alignment_standards :type: list .. py:attribute:: oet_alignment_learning_domains :type: list .. py:attribute:: oet_alignment_tags :type: list .. py:attribute:: oet_faceted_alignment_tags :type: list .. py:attribute:: cuny_alignment_standards :type: list .. py:attribute:: cuny_alignment_learning_domains :type: list .. py:attribute:: cuny_alignment_tags :type: list .. py:attribute:: ncccs_alignment_standards :type: list .. py:attribute:: ncccs_alignment_learning_domains :type: list .. py:attribute:: ncccs_alignment_tags :type: list .. py:attribute:: sced_alignment_standards :type: list .. py:attribute:: sced_alignment_levels :type: list .. py:attribute:: sced_alignment_learning_domains :type: list .. py:attribute:: sced_alignment_tags :type: list .. py:attribute:: ct_alignment_standards :type: list .. py:attribute:: ct_alignment_learning_domains :type: list .. py:attribute:: ct_alignment_tags :type: list .. py:attribute:: ct_faceted_alignment_tags :type: list .. py:attribute:: infohio_alignment_standards :type: list .. py:attribute:: infohio_alignment_learning_domains :type: list .. py:attribute:: infohio_alignment_tags :type: list .. py:attribute:: infohio_wl_alignment_standards :type: list .. py:attribute:: infohio_wl_alignment_levels :type: list .. py:attribute:: infohio_wl_alignment_learning_domains :type: list .. py:attribute:: infohio_wl_alignment_tags :type: list .. py:attribute:: ut_alignment_standards :type: list .. py:attribute:: ut_alignment_grades :type: list .. py:attribute:: ut_alignment_learning_domains :type: list .. py:attribute:: ut_alignment_tags :type: list .. py:attribute:: visa_alignment_standards :type: list .. py:attribute:: visa_alignment_grades :type: list .. py:attribute:: visa_alignment_learning_domains :type: list .. py:attribute:: visa_alignment_tags :type: list .. py:attribute:: ccss_alignment_standards :type: list .. py:attribute:: ccss_alignment_grades :type: list .. py:attribute:: ccss_alignment_learning_domains :type: list .. py:attribute:: ccss_alignment_tags :type: list .. py:attribute:: wi_alignment_standards :type: list .. py:attribute:: wi_alignment_grades :type: list .. py:attribute:: wi_alignment_learning_domains :type: list .. py:attribute:: wi_alignment_tags :type: list .. py:attribute:: wi_ts_alignment_standards :type: list .. py:attribute:: wi_ts_alignment_learning_domains :type: list .. py:attribute:: wi_ts_alignment_tags :type: list .. py:attribute:: wi_wl_alignment_standards :type: list .. py:attribute:: wi_wl_alignment_levels :type: list .. py:attribute:: wi_wl_alignment_learning_domains :type: list .. py:attribute:: wi_wl_alignment_tags :type: list .. py:attribute:: acgm_alignment_standards :type: list .. py:attribute:: acgm_alignment_learning_domains :type: list .. py:attribute:: acgm_alignment_tags :type: list .. py:attribute:: wecm_alignment_standards :type: list .. py:attribute:: wecm_alignment_learning_domains :type: list .. py:attribute:: wecm_alignment_tags :type: list .. py:attribute:: sas_alignment_standards :type: list .. py:attribute:: sas_alignment_grades :type: list .. py:attribute:: sas_alignment_learning_domains :type: list .. py:attribute:: sas_alignment_tags :type: list .. py:attribute:: sask_alignment_standards :type: list .. py:attribute:: sask_alignment_grades :type: list .. py:attribute:: sask_alignment_learning_domains :type: list .. py:attribute:: sask_alignment_tags :type: list .. py:attribute:: sws_alignment_standards :type: list .. py:attribute:: sws_alignment_grades :type: list .. py:attribute:: sws_alignment_learning_domains :type: list .. py:attribute:: sws_alignment_tags :type: list .. py:attribute:: tenant_name_keyword :type: str .. py:attribute:: tenant_name_keyword_exact :type: str .. py:attribute:: tenant_schema_keyword :type: str .. py:attribute:: tenant_schema_keyword_exact :type: str .. py:attribute:: text :type: str .. py:attribute:: text_ar :type: str .. py:attribute:: slug :type: str .. py:attribute:: thumbnail_url :type: str .. py:attribute:: title :type: str .. py:attribute:: title_ar :type: str .. py:attribute:: sortable_title_2 :type: str .. py:attribute:: content_creation_date_for_index :type: str .. py:attribute:: modified_timestamp :type: str .. py:attribute:: published_on :type: str .. py:attribute:: featured :type: bool .. py:attribute:: primary_user :type: list[int] .. py:attribute:: primary_user_slug :type: list[str] .. py:attribute:: primary_user_slug_exact :type: list[str] .. py:attribute:: primary_user_name :type: list[str] .. py:attribute:: primary_user_name_exact :type: list[str] .. py:attribute:: grade_sublevels :type: list[int] .. py:attribute:: grade_sublevel_slugs :type: list[str] .. py:attribute:: grade_sublevel_slugs_exact :type: list[str] .. py:attribute:: grade_sublevel_names :type: list[str] .. py:attribute:: grade_sublevel_names_exact :type: list[str] .. py:attribute:: grades :type: list .. py:attribute:: proficiency_level :type: list .. py:attribute:: proficiency_level_slugs :type: list .. py:attribute:: proficiency_level_slugs_exact :type: list .. py:attribute:: proficiency_level_names :type: list .. py:attribute:: proficiency_level_names_exact :type: list .. py:attribute:: keywords :type: list[str] .. py:attribute:: keywords_names :type: list[str] .. py:attribute:: keywords_names_ar :type: list[str] .. py:attribute:: content_source :type: str .. py:attribute:: member_activities :type: list[str] .. py:attribute:: rating :type: int .. py:attribute:: ratings_number :type: int .. py:attribute:: creator :type: int .. py:attribute:: license :type: str .. py:attribute:: cou_bucket :type: str .. py:attribute:: license_types :type: list[str] .. py:attribute:: license_bucket_title :type: str .. py:attribute:: django_ct_id :type: int .. py:attribute:: microsites :type: list .. py:attribute:: hide_from_main_site :type: bool .. py:attribute:: topics :type: list .. py:attribute:: indexed_topics :type: list .. py:attribute:: workflow_state :type: str .. py:attribute:: is_displayed :type: bool .. py:attribute:: displayed_date :type: str .. py:attribute:: visits :type: int .. py:attribute:: groups :type: list[int] .. py:attribute:: abstract :type: str .. py:attribute:: abstract_ar :type: str .. py:attribute:: full_text :type: str .. py:attribute:: authors :type: list[str] .. py:attribute:: general_subjects :type: list[int] .. py:attribute:: general_subjects_slugs :type: list[str] .. py:attribute:: general_subjects_slugs_exact :type: list[str] .. py:attribute:: general_subjects_names :type: list[str] .. py:attribute:: general_subjects_names_exact :type: list[str] .. py:attribute:: course_material_types :type: list[int] .. py:attribute:: course_material_types_slugs :type: list[str] .. py:attribute:: course_material_types_slugs_exact :type: list[str] .. py:attribute:: course_material_types_names :type: list[str] .. py:attribute:: course_material_types_names_exact :type: list[str] .. py:attribute:: media_formats :type: list[int] .. py:attribute:: media_formats_slugs :type: list[str] .. py:attribute:: media_formats_slugs_exact :type: list[str] .. py:attribute:: media_formats_names :type: list[str] .. py:attribute:: media_formats_names_exact :type: list[str] .. py:attribute:: accessibility :type: list[int] .. py:attribute:: accessibility_slugs :type: list[str] .. py:attribute:: accessibility_slugs_exact :type: list[str] .. py:attribute:: accessibility_names :type: list[str] .. py:attribute:: accessibility_names_exact :type: list[str] .. py:attribute:: educational_use :type: list .. py:attribute:: educational_use_slugs :type: list .. py:attribute:: educational_use_slugs_exact :type: list .. py:attribute:: educational_use_names :type: list .. py:attribute:: educational_use_names_exact :type: list .. py:attribute:: languages :type: list[int] .. py:attribute:: languages_slugs :type: list[str] .. py:attribute:: languages_slugs_exact :type: list[str] .. py:attribute:: languages_names :type: list[str] .. py:attribute:: languages_names_exact :type: list[str] .. py:attribute:: asn_ids :type: list .. py:class:: Model(/, **data: Any) Bases: :py:obj:`pydantic.BaseModel` !!! abstract "Usage Documentation" [Models](../concepts/models.md) A base class for creating Pydantic models. Attributes: __class_vars__: The names of the class variables defined on the model. __private_attributes__: Metadata about the private attributes of the model. __signature__: The synthesized `__init__` [`Signature`][inspect.Signature] of the model. __pydantic_complete__: Whether model building is completed, or if there are still undefined fields. __pydantic_core_schema__: The core schema of the model. __pydantic_custom_init__: Whether the model has a custom `__init__` function. __pydantic_decorators__: Metadata containing the decorators defined on the model. This replaces `Model.__validators__` and `Model.__root_validators__` from Pydantic V1. __pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these. __pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models. __pydantic_post_init__: The name of the post-init method for the model, if defined. __pydantic_root_model__: Whether the model is a [`RootModel`][pydantic.root_model.RootModel]. __pydantic_serializer__: The `pydantic-core` `SchemaSerializer` used to dump instances of the model. __pydantic_validator__: The `pydantic-core` `SchemaValidator` used to validate instances of the model. __pydantic_fields__: A dictionary of field names and their corresponding [`FieldInfo`][pydantic.fields.FieldInfo] objects. __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [`ComputedFieldInfo`][pydantic.fields.ComputedFieldInfo] objects. __pydantic_extra__: A dictionary containing extra values, if [`extra`][pydantic.config.ConfigDict.extra] is set to `'allow'`. __pydantic_fields_set__: The names of fields explicitly set during instantiation. __pydantic_private__: Values of private attributes set on the model instance. .. py:attribute:: field_index :type: str :value: None .. py:attribute:: field_type :type: str :value: None .. py:attribute:: field_id :type: str :value: None .. py:attribute:: field_score :type: float :value: None .. py:attribute:: field_source :type: FieldSource :value: None .. py:data:: json_path