# fiftyone.core.odm.frame
Backing document classes for [`fiftyone.core.frame.Frame`](fiftyone.core.frame.md#fiftyone.core.frame.Frame) instances.
Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)
**Classes:**
| [`DatasetFrameDocument`](#fiftyone.core.odm.frame.DatasetFrameDocument)(\*\*kwargs) | |
|-----------------------------------------------------------------------------------------|----|
| [`NoDatasetFrameDocument`](#fiftyone.core.odm.frame.NoDatasetFrameDocument)(\*\*kwargs) | |
### *class* fiftyone.core.odm.frame.DatasetFrameDocument(\*\*kwargs)
Bases: [`DatasetMixin`](fiftyone.core.odm.mixins.md#fiftyone.core.odm.mixins.DatasetMixin), [`Document`](fiftyone.core.odm.document.md#fiftyone.core.odm.document.Document)
**Attributes:**
| [`id`](#fiftyone.core.odm.frame.DatasetFrameDocument.id) | An Object ID field. |
|--------------------------------------------------------------------------------------|-----------------------------------------------------------|
| [`frame_number`](#fiftyone.core.odm.frame.DatasetFrameDocument.frame_number) | A video frame number field. |
| [`created_at`](#fiftyone.core.odm.frame.DatasetFrameDocument.created_at) | A datetime field. |
| [`last_modified_at`](#fiftyone.core.odm.frame.DatasetFrameDocument.last_modified_at) | A datetime field. |
| [`STRICT`](#fiftyone.core.odm.frame.DatasetFrameDocument.STRICT) | |
| [`collection_name`](#fiftyone.core.odm.frame.DatasetFrameDocument.collection_name) | |
| [`field_names`](#fiftyone.core.odm.frame.DatasetFrameDocument.field_names) | An ordered tuple of the public fields of this document. |
| [`in_db`](#fiftyone.core.odm.frame.DatasetFrameDocument.in_db) | Whether the document has been inserted into the database. |
| [`pk`](#fiftyone.core.odm.frame.DatasetFrameDocument.pk) | Get the primary key. |
**Methods:**
| [`add_field`](#fiftyone.core.odm.frame.DatasetFrameDocument.add_field)(path, ftype[, embedded_doc_type, ...]) | Adds a new field or embedded field to the document, if necessary. |
|------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`add_implied_field`](#fiftyone.core.odm.frame.DatasetFrameDocument.add_implied_field)(path, value[, ...]) | Adds the field or embedded field to the document, if necessary, inferring the field type from the provided value. |
| [`cascade_save`](#fiftyone.core.odm.frame.DatasetFrameDocument.cascade_save)(\*\*kwargs) | Recursively save any references and generic references on the document. |
| [`clean`](#fiftyone.core.odm.frame.DatasetFrameDocument.clean)() | Hook for doing document level data cleaning (usually validation or assignment) before validation is run. |
| [`clear_field`](#fiftyone.core.odm.frame.DatasetFrameDocument.clear_field)(field_name) | Clears the field from the document. |
| [`compare_indexes`](#fiftyone.core.odm.frame.DatasetFrameDocument.compare_indexes)() | Compares the indexes defined in MongoEngine with the ones existing in the database. |
| [`copy`](#fiftyone.core.odm.frame.DatasetFrameDocument.copy)([new_id]) | Returns a deep copy of the document. |
| [`copy_with_new_id`](#fiftyone.core.odm.frame.DatasetFrameDocument.copy_with_new_id)() | |
| [`create_index`](#fiftyone.core.odm.frame.DatasetFrameDocument.create_index)(keys[, background]) | Creates the given indexes if required. |
| [`delete`](#fiftyone.core.odm.frame.DatasetFrameDocument.delete)([signal_kwargs]) | Delete the `Document` from the database. |
| [`drop_collection`](#fiftyone.core.odm.frame.DatasetFrameDocument.drop_collection)() | Drops the entire collection associated with this `Document` type from the database. |
| [`ensure_indexes`](#fiftyone.core.odm.frame.DatasetFrameDocument.ensure_indexes)() | Checks the document meta data and ensures all the indexes exist. |
| [`fancy_repr`](#fiftyone.core.odm.frame.DatasetFrameDocument.fancy_repr)([class_name, select_fields, ...]) | Generates a customizable string representation of the document. |
| [`field_to_mongo`](#fiftyone.core.odm.frame.DatasetFrameDocument.field_to_mongo)(field_name) | |
| [`field_to_python`](#fiftyone.core.odm.frame.DatasetFrameDocument.field_to_python)(field_name, value) | |
| [`from_dict`](#fiftyone.core.odm.frame.DatasetFrameDocument.from_dict)(d[, extended]) | Loads the document from a BSON/JSON dictionary. |
| [`from_json`](#fiftyone.core.odm.frame.DatasetFrameDocument.from_json)(s) | Loads the document from a JSON string. |
| [`get_field`](#fiftyone.core.odm.frame.DatasetFrameDocument.get_field)(field_name) | Gets the field of the document. |
| [`get_field_schema`](#fiftyone.core.odm.frame.DatasetFrameDocument.get_field_schema)([ftype, embedded_doc_type, ...]) | Returns a schema dictionary describing the fields of this document. |
| [`get_text_score`](#fiftyone.core.odm.frame.DatasetFrameDocument.get_text_score)() | Get text score from text query |
| [`has_field`](#fiftyone.core.odm.frame.DatasetFrameDocument.has_field)(field_name) | Determines whether the document has a field of the given name. |
| [`iter_fields`](#fiftyone.core.odm.frame.DatasetFrameDocument.iter_fields)() | Returns an iterator over the `(name, value)` pairs of the public fields of the document. |
| [`list_indexes`](#fiftyone.core.odm.frame.DatasetFrameDocument.list_indexes)() | Lists all indexes that should be created for the Document collection. |
| [`merge`](#fiftyone.core.odm.frame.DatasetFrameDocument.merge)(doc[, merge_lists, merge_dicts, overwrite]) | Merges the contents of the given document into this document. |
| [`merge_field_schema`](#fiftyone.core.odm.frame.DatasetFrameDocument.merge_field_schema)(schema[, expand_schema, ...]) | Merges the field schema into this document. |
| [`modify`](#fiftyone.core.odm.frame.DatasetFrameDocument.modify)([query]) | Perform an atomic update of the document in the database and reload the document object using updated version. |
| [`register_delete_rule`](#fiftyone.core.odm.frame.DatasetFrameDocument.register_delete_rule)(document_cls, ...) | This method registers the delete rules to apply when removing this object. |
| [`reload`](#fiftyone.core.odm.frame.DatasetFrameDocument.reload)(\*fields, \*\*kwargs) | Reloads the document from the database. |
| [`save`](#fiftyone.core.odm.frame.DatasetFrameDocument.save)([upsert, validate, safe]) | Saves the document to the database. |
| [`select_related`](#fiftyone.core.odm.frame.DatasetFrameDocument.select_related)([max_depth]) | Handles dereferencing of [`DBRef`](https://pymongo.readthedocs.io/en/stable/api/bson/dbref.html#bson.dbref.DBRef) objects to a maximum depth in order to cut down the number queries to mongodb. |
| [`set_field`](#fiftyone.core.odm.frame.DatasetFrameDocument.set_field)(field_name, value[, create, ...]) | Sets the value of a field of the document. |
| [`switch_collection`](#fiftyone.core.odm.frame.DatasetFrameDocument.switch_collection)(collection_name[, ...]) | Temporarily switch the collection for a document instance. |
| [`switch_db`](#fiftyone.core.odm.frame.DatasetFrameDocument.switch_db)(db_alias[, keep_created]) | Temporarily switch the database for a document instance. |
| [`to_dbref`](#fiftyone.core.odm.frame.DatasetFrameDocument.to_dbref)() | Returns an instance of [`DBRef`](https://pymongo.readthedocs.io/en/stable/api/bson/dbref.html#bson.dbref.DBRef) useful in `__raw__` queries. |
| [`to_dict`](#fiftyone.core.odm.frame.DatasetFrameDocument.to_dict)([extended]) | Serializes this document to a BSON/JSON dictionary. |
| [`to_json`](#fiftyone.core.odm.frame.DatasetFrameDocument.to_json)([pretty_print]) | Serializes the document to a JSON string. |
| [`to_mongo`](#fiftyone.core.odm.frame.DatasetFrameDocument.to_mongo)(\*args, \*\*kwargs) | Return as SON data ready for use with MongoDB. |
| [`update`](#fiftyone.core.odm.frame.DatasetFrameDocument.update)(\*\*kwargs) | Performs an update on the `Document` A convenience wrapper to `update()`. |
| [`validate`](#fiftyone.core.odm.frame.DatasetFrameDocument.validate)([clean]) | Ensure that all fields' values are valid and that required fields are present. |
**Classes:**
| [`my_metaclass`](#fiftyone.core.odm.frame.DatasetFrameDocument.my_metaclass) | |
|--------------------------------------------------------------------------------|----|
#### id
An Object ID field.
* **Parameters:**
* **description** (*None*) – an optional description
* **info** (*None*) – an optional info dict
* **read_only** (*False*) – whether the field is read-only
* **created_at** (*None*) – the datetime the field was created
#### frame_number
A video frame number field.
* **Parameters:**
* **description** (*None*) – an optional description
* **info** (*None*) – an optional info dict
* **read_only** (*False*) – whether the field is read-only
* **created_at** (*None*) – the datetime the field was created
#### created_at
A datetime field.
* **Parameters:**
* **description** (*None*) – an optional description
* **info** (*None*) – an optional info dict
* **read_only** (*False*) – whether the field is read-only
* **created_at** (*None*) – the datetime the field was created
#### last_modified_at
A datetime field.
* **Parameters:**
* **description** (*None*) – an optional description
* **info** (*None*) – an optional info dict
* **read_only** (*False*) – whether the field is read-only
* **created_at** (*None*) – the datetime the field was created
#### STRICT *= False*
#### *classmethod* add_field(path, ftype, embedded_doc_type=None, subfield=None, fields=None, description=None, info=None, read_only=False, expand_schema=True, recursive=True, validate=True, \*\*kwargs)
Adds a new field or embedded field to the document, if necessary.
* **Parameters:**
* **path** – the field name or `embedded.field.name`
* **ftype** – the field type to create. Must be a subclass of
[`fiftyone.core.fields.Field`](fiftyone.core.fields.md#fiftyone.core.fields.Field)
* **embedded_doc_type** (*None*) – the
[`fiftyone.core.odm.BaseEmbeddedDocument`](fiftyone.core.odm.md#fiftyone.core.odm.BaseEmbeddedDocument) type of the
field. Only applicable when `ftype` is
[`fiftyone.core.fields.EmbeddedDocumentField`](fiftyone.core.fields.md#fiftyone.core.fields.EmbeddedDocumentField)
* **subfield** (*None*) – the [`fiftyone.core.fields.Field`](fiftyone.core.fields.md#fiftyone.core.fields.Field) type of
the contained field. Only applicable when `ftype` is
[`fiftyone.core.fields.ListField`](fiftyone.core.fields.md#fiftyone.core.fields.ListField) or
[`fiftyone.core.fields.DictField`](fiftyone.core.fields.md#fiftyone.core.fields.DictField)
* **fields** (*None*) – a list of [`fiftyone.core.fields.Field`](fiftyone.core.fields.md#fiftyone.core.fields.Field)
instances defining embedded document attributes. Only
applicable when `ftype` is
[`fiftyone.core.fields.EmbeddedDocumentField`](fiftyone.core.fields.md#fiftyone.core.fields.EmbeddedDocumentField)
* **description** (*None*) – an optional description
* **info** (*None*) – an optional info dict
* **read_only** (*False*) – whether the field should be read-only
* **expand_schema** (*True*) – whether to add new fields to the schema
(True) or simply validate that the field already exists with a
consistent type (False)
* **recursive** (*True*) – whether to recursively add embedded document
fields
* **validate** (*True*) – whether to validate the field against an existing
field at the same path
* **Returns:**
True/False whether one or more fields or embedded fields were added
to the document or its children
* **Raises:**
**ValueError** – if a field in the schema is not compliant with an
existing field of the same name
#### *classmethod* add_implied_field(path, value, expand_schema=True, dynamic=False, recursive=True, validate=True)
Adds the field or embedded field to the document, if necessary,
inferring the field type from the provided value.
* **Parameters:**
* **path** – the field name or `embedded.field.name`
* **value** – the field value
* **expand_schema** (*True*) – whether to add new fields to the schema
(True) or simply validate that the field already exists with a
consistent type (False)
* **dynamic** (*False*) – whether to declare dynamic embedded document
fields
* **recursive** (*True*) – whether to recursively add embedded document
fields
* **validate** (*True*) – whether to validate the field against an existing
field at the same path
* **Returns:**
True/False whether one or more fields or embedded fields were added
to the document or its children
* **Raises:**
**ValueError** – if a field in the schema is not compliant with an
existing field of the same name
#### cascade_save(\*\*kwargs)
Recursively save any references and generic references on the
document.
#### clean()
Hook for doing document level data cleaning (usually validation or assignment)
before validation is run.
Any ValidationError raised by this method will not be associated with
a particular field; it will have a special-case association with the
field defined by NON_FIELD_ERRORS.
#### clear_field(field_name)
Clears the field from the document.
* **Parameters:**
**field_name** – the field name
* **Raises:**
**ValueError** – if the field does not exist
#### *property* collection_name
#### *classmethod* compare_indexes()
Compares the indexes defined in MongoEngine with the ones
existing in the database. Returns any missing/extra indexes.
#### copy(new_id=False)
Returns a deep copy of the document.
* **Parameters:**
**new_id** (*False*) – whether to generate a new ID for the copied
document. By default, the ID is left as `None` and will be
automatically populated when the document is added to the
database
#### copy_with_new_id()
#### *classmethod* create_index(keys, background=False, \*\*kwargs)
Creates the given indexes if required.
* **Parameters:**
* **keys** – a single index key or a list of index keys (to
construct a multi-field index); keys may be prefixed with a **+**
or a **-** to determine the index ordering
* **background** – Allows index creation in the background
#### delete(signal_kwargs=None, \*\*write_concern)
Delete the `Document` from the database. This
will only take effect if the document has been previously saved.
* **Parameters:**
* **signal_kwargs** – (optional) kwargs dictionary to be passed to
the signal calls.
* **write_concern** – Extra keyword arguments are passed down which
will be used as options for the resultant `getLastError` command.
For example, `save(..., w: 2, fsync: True)` will
wait until at least two servers have recorded the write and
will force an fsync on the primary server.
#### *classmethod* drop_collection()
Drops the entire collection associated with this
`Document` type from the database.
Raises `OperationError` if the document has no collection set
(i.g. if it is `abstract`)
#### *classmethod* ensure_indexes()
Checks the document meta data and ensures all the indexes exist.
Global defaults can be set in the meta - see guide/defining-documents
By default, this will get called automatically upon first interaction with the
Document collection (query, save, etc) so unless you disabled `auto_create_index`, you
shouldn’t have to call this manually.
This also gets called upon every call to Document.save if `auto_create_index_on_save` is set to True
If called multiple times, MongoDB will not re-recreate indexes if they exist already
#### NOTE
You can disable automatic index creation by setting
`auto_create_index` to False in the documents meta data
#### fancy_repr(class_name=None, select_fields=None, exclude_fields=None, \*\*kwargs)
Generates a customizable string representation of the document.
* **Parameters:**
* **class_name** (*None*) – optional class name to use
* **select_fields** (*None*) – iterable of field names to restrict to
* **exclude_fields** (*None*) – iterable of field names to exclude
* **\*\*kwargs** – additional key-value pairs to include in the string
representation
* **Returns:**
a string representation of the document
#### *property* field_names
An ordered tuple of the public fields of this document.
#### field_to_mongo(field_name)
#### field_to_python(field_name, value)
#### *classmethod* from_dict(d, extended=False)
Loads the document from a BSON/JSON dictionary.
* **Parameters:**
* **d** – a dictionary
* **extended** (*False*) – whether the input dictionary may contain
serialized extended JSON constructs
* **Returns:**
a `SerializableDocument`
#### *classmethod* from_json(s)
Loads the document from a JSON string.
* **Returns:**
a `SerializableDocument`
#### get_field(field_name)
Gets the field of the document.
* **Parameters:**
**field_name** – the field name
* **Returns:**
the field value
* **Raises:**
**AttributeError** – if the field does not exist
#### *classmethod* get_field_schema(ftype=None, embedded_doc_type=None, subfield=None, read_only=None, info_keys=None, created_after=None, include_private=False, flat=False, unwind=True, mode=None)
Returns a schema dictionary describing the fields of this document.
If the document belongs to a dataset, the schema will apply to all
documents in the collection.
* **Parameters:**
* **ftype** (*None*) – an optional field type or iterable of field types to
which to restrict the returned schema. Must be subclass(es) of
[`fiftyone.core.fields.Field`](fiftyone.core.fields.md#fiftyone.core.fields.Field)
* **embedded_doc_type** (*None*) – an optional embedded document type or
iterable of types to which to restrict the returned schema.
Must be subclass(es) of
[`fiftyone.core.odm.BaseEmbeddedDocument`](fiftyone.core.odm.md#fiftyone.core.odm.BaseEmbeddedDocument)
* **subfield** (*None*) – an optional subfield type or iterable of subfield
types to which to restrict the returned schema. Must be
subclass(es) of [`fiftyone.core.fields.Field`](fiftyone.core.fields.md#fiftyone.core.fields.Field)
* **read_only** (*None*) – whether to restrict to (True) or exclude (False)
read-only fields. By default, all fields are included
* **info_keys** (*None*) – an optional key or list of keys that must be in
the field’s `info` dict
* **created_after** (*None*) – an optional `datetime` specifying a minimum
creation date
* **include_private** (*False*) – whether to include fields that start with
`_` in the returned schema
* **flat** (*False*) – whether to return a flattened schema where all
embedded document fields are included as top-level keys
* **unwind** (*True*) – whether to traverse into list fields. Only
applicable when `flat=True`
* **mode** (*None*) – whether to apply the above constraints before and/or
after flattening the schema. Only applicable when `flat=True`.
Supported values are `("before", "after", "both")`. The
default is `"after"`
* **Returns:**
a dict mapping field names to [`fiftyone.core.fields.Field`](fiftyone.core.fields.md#fiftyone.core.fields.Field)
instances
#### get_text_score()
Get text score from text query
#### has_field(field_name)
Determines whether the document has a field of the given name.
* **Parameters:**
**field_name** – the field name
* **Returns:**
True/False
#### *property* in_db
Whether the document has been inserted into the database.
#### iter_fields()
Returns an iterator over the `(name, value)` pairs of the
public fields of the document.
* **Returns:**
an iterator that emits `(name, value)` tuples
#### *classmethod* list_indexes()
Lists all indexes that should be created for the Document collection.
It includes all the indexes from super- and sub-classes.
Note that it will only return the indexes’ fields, not the indexes’ options
#### merge(doc, merge_lists=True, merge_dicts=True, overwrite=True)
Merges the contents of the given document into this document.
* **Parameters:**
* **doc** – a `SerializableDocument` of same type as this document
* **merge_lists** (*True*) – whether to merge the elements of top-level list
fields rather than treating the list as a single value
* **merge_dicts** (*True*) – whether to recursively merge the contents of
top-level dict fields rather than treating the dict as a single
value
* **overwrite** (*True*) – whether to overwrite (True) or skip (False)
existing fields
#### *classmethod* merge_field_schema(schema, expand_schema=True, recursive=True, validate=True, overwrite=False)
Merges the field schema into this document.
* **Parameters:**
* **schema** – a dict mapping field names or `embedded.field.names` to
[`fiftyone.core.fields.Field`](fiftyone.core.fields.md#fiftyone.core.fields.Field) instances
* **expand_schema** (*True*) – whether to add new fields to the schema
(True) or simply validate that fields already exist with
consistent types (False)
* **recursive** (*True*) – whether to recursively merge embedded document
fields
* **validate** (*True*) – whether to validate fields against existing fields
at the same path
* **overwrite** (*False*) – whether to overwrite the editable metadata of
existing fields
* **Returns:**
True/False whether any new fields were added
* **Raises:**
**ValueError** – if a field in the schema is not compliant with an
existing field of the same name or a new field is found but
`expand_schema == False`
#### modify(query=None, \*\*update)
Perform an atomic update of the document in the database and reload
the document object using updated version.
Returns True if the document has been updated or False if the document
in the database doesn’t match the query.
#### NOTE
All unsaved changes that have been made to the document are
rejected if the method returns True.
* **Parameters:**
* **query** – the update will be performed only if the document in the
database matches the query
* **update** – Django-style update keyword arguments
#### my_metaclass
alias of `TopLevelDocumentMetaclass`
#### *property* pk
Get the primary key.
#### *classmethod* register_delete_rule(document_cls, field_name, rule)
This method registers the delete rules to apply when removing this
object.
#### reload(\*fields, \*\*kwargs)
Reloads the document from the database.
* **Parameters:**
**\*fields** – an optional args list of specific fields to reload
#### save(upsert=False, validate=True, safe=False, \*\*kwargs)
Saves the document to the database.
If the document already exists, it will be updated, otherwise it will
be created.
* **Parameters:**
* **upsert** (*False*) – whether to insert the document if it has an `id`
populated but no document with that ID exists in the database
* **validate** (*True*) – whether to validate the document
* **safe** (*False*) – whether to `reload()` the document before raising
any errors
* **Returns:**
self
#### select_related(max_depth=1)
Handles dereferencing of [`DBRef`](https://pymongo.readthedocs.io/en/stable/api/bson/dbref.html#bson.dbref.DBRef) objects to
a maximum depth in order to cut down the number queries to mongodb.
#### set_field(field_name, value, create=True, validate=True, dynamic=False, \_enforce_read_only=True)
Sets the value of a field of the document.
* **Parameters:**
* **field_name** – the field name
* **value** – the field value
* **create** (*True*) – whether to create the field if it does not exist
* **Raises:**
**ValueError** – if `field_name` is not an allowed field name or does
not exist and `create == False`
#### switch_collection(collection_name, keep_created=True)
Temporarily switch the collection for a document instance.
Only really useful for archiving off data and calling `save()`:
```default
user = User.objects.get(id=user_id)
user.switch_collection('old-users')
user.save()
```
* **Parameters:**
* **collection_name** (*str*) – The database alias to use for saving the
document
* **keep_created** ([*bool*](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)) – keep self._created value after switching collection, else is reset to True
#### SEE ALSO
Use `switch_db`
if you need to read from another database
#### switch_db(db_alias, keep_created=True)
Temporarily switch the database for a document instance.
Only really useful for archiving off data and calling `save()`:
```default
user = User.objects.get(id=user_id)
user.switch_db('archive-db')
user.save()
```
* **Parameters:**
* **db_alias** (*str*) – The database alias to use for saving the document
* **keep_created** ([*bool*](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)) – keep self._created value after switching db, else is reset to True
#### SEE ALSO
Use `switch_collection`
if you need to read from another collection
#### to_dbref()
Returns an instance of [`DBRef`](https://pymongo.readthedocs.io/en/stable/api/bson/dbref.html#bson.dbref.DBRef) useful in
`__raw__` queries.
#### to_dict(extended=False)
Serializes this document to a BSON/JSON dictionary.
* **Parameters:**
**extended** (*False*) – whether to serialize extended JSON constructs
such as ObjectIDs, Binary, etc. into JSON format
* **Returns:**
a dict
#### to_json(pretty_print=False)
Serializes the document to a JSON string.
* **Parameters:**
**pretty_print** (*False*) – whether to render the JSON in human readable
format with newlines and indentations
* **Returns:**
a JSON string
#### to_mongo(\*args, \*\*kwargs)
Return as SON data ready for use with MongoDB.
#### update(\*\*kwargs)
Performs an update on the `Document`
A convenience wrapper to `update()`.
Raises `OperationError` if called on an object that has not yet
been saved.
#### validate(clean=True)
Ensure that all fields’ values are valid and that required fields
are present.
Raises `ValidationError` if any of the fields’ values are found
to be invalid.
### *class* fiftyone.core.odm.frame.NoDatasetFrameDocument(\*\*kwargs)
Bases: [`NoDatasetMixin`](fiftyone.core.odm.mixins.md#fiftyone.core.odm.mixins.NoDatasetMixin), [`SerializableDocument`](fiftyone.core.odm.document.md#fiftyone.core.odm.document.SerializableDocument)
**Attributes:**
| [`default_fields`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.default_fields) | |
|----------------------------------------------------------------------------------------------------|---------------------------------------------------------|
| [`default_fields_ordered`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.default_fields_ordered) | |
| [`field_names`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.field_names) | An ordered tuple of the public fields of this document. |
| [`in_db`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.in_db) | |
**Methods:**
| [`clear_field`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.clear_field)(field_name) | Clears the field from the document. |
|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| [`copy`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.copy)() | Returns a deep copy of the document. |
| [`delete`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.delete)() | |
| [`fancy_repr`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.fancy_repr)([class_name, select_fields, ...]) | Generates a customizable string representation of the document. |
| [`from_dict`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.from_dict)(d[, extended]) | Loads the document from a BSON/JSON dictionary. |
| [`from_json`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.from_json)(s) | Loads the document from a JSON string. |
| [`get_field`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.get_field)(field_name) | Gets the field of the document. |
| [`has_field`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.has_field)(field_name) | Determines whether the document has a field of the given name. |
| [`iter_fields`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.iter_fields)() | Returns an iterator over the `(name, value)` pairs of the public fields of the document. |
| [`merge`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.merge)(doc[, merge_lists, merge_dicts, overwrite]) | Merges the contents of the given document into this document. |
| [`reload`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.reload)() | |
| [`save`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.save)() | |
| [`set_field`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.set_field)(field_name, value[, create, ...]) | Sets the value of a field of the document. |
| [`to_dict`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.to_dict)([extended]) | Serializes this document to a BSON/JSON dictionary. |
| [`to_json`](#fiftyone.core.odm.frame.NoDatasetFrameDocument.to_json)([pretty_print]) | Serializes the document to a JSON string. |
#### default_fields *= {'_dataset_id': , '_sample_id': , 'created_at': , 'frame_number': , 'id': , 'last_modified_at': }*
#### default_fields_ordered *= ('id', 'frame_number', 'created_at', 'last_modified_at', '_sample_id', '_dataset_id')*
#### clear_field(field_name)
Clears the field from the document.
* **Parameters:**
**field_name** – the field name
* **Raises:**
**ValueError** – if the field does not exist
#### copy()
Returns a deep copy of the document.
* **Returns:**
a `SerializableDocument`
#### delete()
#### fancy_repr(class_name=None, select_fields=None, exclude_fields=None, \*\*kwargs)
Generates a customizable string representation of the document.
* **Parameters:**
* **class_name** (*None*) – optional class name to use
* **select_fields** (*None*) – iterable of field names to restrict to
* **exclude_fields** (*None*) – iterable of field names to exclude
* **\*\*kwargs** – additional key-value pairs to include in the string
representation
* **Returns:**
a string representation of the document
#### *property* field_names
An ordered tuple of the public fields of this document.
#### *classmethod* from_dict(d, extended=False)
Loads the document from a BSON/JSON dictionary.
* **Parameters:**
* **d** – a dictionary
* **extended** (*False*) – whether the input dictionary may contain
serialized extended JSON constructs
* **Returns:**
a `SerializableDocument`
#### *classmethod* from_json(s)
Loads the document from a JSON string.
* **Returns:**
a `SerializableDocument`
#### get_field(field_name)
Gets the field of the document.
* **Parameters:**
**field_name** – the field name
* **Returns:**
the field value
* **Raises:**
**AttributeError** – if the field does not exist
#### has_field(field_name)
Determines whether the document has a field of the given name.
* **Parameters:**
**field_name** – the field name
* **Returns:**
True/False
#### *property* in_db
#### iter_fields()
Returns an iterator over the `(name, value)` pairs of the
public fields of the document.
* **Returns:**
an iterator that emits `(name, value)` tuples
#### merge(doc, merge_lists=True, merge_dicts=True, overwrite=True)
Merges the contents of the given document into this document.
* **Parameters:**
* **doc** – a `SerializableDocument` of same type as this document
* **merge_lists** (*True*) – whether to merge the elements of top-level list
fields rather than treating the list as a single value
* **merge_dicts** (*True*) – whether to recursively merge the contents of
top-level dict fields rather than treating the dict as a single
value
* **overwrite** (*True*) – whether to overwrite (True) or skip (False)
existing fields
#### reload()
#### save()
#### set_field(field_name, value, create=True, validate=True, dynamic=False)
Sets the value of a field of the document.
* **Parameters:**
* **field_name** – the field name
* **value** – the field value
* **create** (*True*) – whether to create the field if it does not exist
* **Raises:**
**ValueError** – if `field_name` is not an allowed field name or does
not exist and `create == False`
#### to_dict(extended=False)
Serializes this document to a BSON/JSON dictionary.
* **Parameters:**
**extended** (*False*) – whether to serialize extended JSON constructs
such as ObjectIDs, Binary, etc. into JSON format
* **Returns:**
a dict
#### to_json(pretty_print=False)
Serializes the document to a JSON string.
* **Parameters:**
**pretty_print** (*False*) – whether to render the JSON in human readable
format with newlines and indentations
* **Returns:**
a JSON string