AWS Lambda
wrappers
editor_agent
Dependencies
DAssetPath
Get a local file path to data asset temporarily stored till end of agent execution.dep_asset
ValueError
- if the underlying assets are not videos, images, or audio.EncordException
- if data type not supported by SDK yet.
DEncordClient
Get an authenticated user client.dep_client
DObjectCrops
Get all object crops that the agent was triggered on. The instance crop contains the object instance, the frame content (pixel values), and the frame.dep_object_crops
-
filter_ontology_objects
- Specify a list of ontology objects to include. If provided, only instances of these object types are included. Strings are matched againstfeature_node_hashes
. -
Returns
- The dependency to be injected into the cloud function.
DObjectsInstances
Get all object instances that the agent was triggered on. No pixels, just the annotation.dep_objects
Description not available in Core reference MDX.DSingleFrame
Get the single frame that the agent was triggered on.dep_single_frame
lr.data_hash.{suffix}
.
When the function has finished running, the downloaded file is removed from the file system.
Example:
storage_item
- The Storage item. Automatically injected (see example above).
DStorageItem
Get the storage item associated with the underlying agent task to, for example, read/write client metadata or read data properties.dependencies.shares
DataLookup Objects
DataLookup
is deprecated and will be removed in version 0.2.10.
Migration Guide:
- For accessing storage items, use
dep_storage_item
instead:
dep_storage_item
StorageItem
is useful for multiple things like
- Updating client metadata
- Reading file properties like storage location, fps, duration, DICOM tags, etc.
DVideoIterator
Get a video frame iterator for doing things over many frames.dep_video_iterator
storage_item
- Automatically injected storage item dependency.
NotImplementedError
- Fails for data types other than video.
GCP
wrappers
editor_agent
label_row_metadata_include_args
- arguments to overwrite default arguments onproject.list_label_rows_v2()
.label_row_initialise_labels_args
- Arguments to overwrite default arguments onlabel_row.initialise_labels(...)
custom_cors_regex
- A regex to use for the CORS settings. If not provided, the default regex will be used. Only required if the agent is not deployed on Encord’s platform.
Dependencies
DAssetPath
Get a local file path to data asset temporarily stored till end of agent execution.dep_asset
ValueError
- if the underlying assets are not videos, images, or audio.EncordException
- if data type not supported by SDK yet.
DEncordClient
Get an authenticated user client.dep_client
DObjectCrops
Get all object crops that the agent was triggered on. The instance crop contains the object instance, the frame content (pixel values), and the frame.dep_object_crops
-
filter_ontology_objects
- Specify a list of ontology objects to include. If provided, only instances of these object types are included. Strings are matched againstfeature_node_hashes
. -
Returns
- The dependency to be injected into the cloud function.
DObjectsInstances
Get all object instances that the agent was triggered on. No pixels, just the annotation.dep_objects
Description not available in Core reference MDX.DSingleFrame
Get the single frame that the agent was triggered on.dep_single_frame
lr.data_hash.{suffix}
.
When the function has finished running, the downloaded file is removed from the file system.
Example:
storage_item
- The Storage item. Automatically injected (see example above).
DStorageItem
Get the storage item associated with the underlying agent task to, for example, read/write client metadata or read data properties.dependencies.shares
DataLookup Objects
DataLookup
is deprecated and will be removed in version 0.2.10.
Migration Guide:
- For accessing storage items, use
dep_storage_item
instead:
dep_storage_item
StorageItem
is useful for multiple things like
- Updating client metadata
- Reading file properties like storage location, fps, duration, DICOM tags, etc.
DVideoIterator
Get a video frame iterator for doing things over many frames.dep_video_iterator
storage_item
- Automatically injected storage item dependency.
NotImplementedError
- Fails for data types other than video.
FastAPI
cors
Convenience method to easily extend FastAPI servers with the appropriate CORS Middleware to allow interactions from the Encord platform.EncordCORSMiddleware Objects
fastapi.middleware.cors.CORSMiddleware
but matches against
the Encord origin by default and handles X-Encord-Editor-Agent test header
Example:
The CORS middleware will allow POST requests from the Encord domain.
EncordTestHeaderMiddleware Objects
dispatch
get_encord_app
custom_cors_regex
str | None, optional - A regex to use for the CORS middleware. Only necessary if you are not using the default Encord domain.
FastAPI
- A FastAPI app with the Encord middleware.
utils
verify_auth
dependencies
Dependencies for injection in FastAPI servers. This module contains dependencies that you can inject within your api routes. Dependencies that depend on others don’t need to be used together. They’ll work just fine alone. Note that you can also use the function parameter:FrameData
is automatically injected via the api request body.
dep_client
dep_label_row_with_args
label_row_metadata_include_args
- What arguments to include on the metadata frontlabel_row_initialise_labels_args
- How and whether to initialize the label rows
dep_label_row
frame_data
- the frame data from the route. This parameter is automatically injected if it’s a part of your route (see example above)
dep_storage_item
StorageItem
is useful for multiple things like
- Updating client metadata
- Reading file properties like storage location, fps, duration, DICOM tags, etc.
dep_single_frame
lr.data_hash.{suffix}
.
When the function has finished, the downloaded file will be removed from the file system.
Example:
-
storage_item
- The label row. Automatically injected (see example above). -
frame_data
- the frame data from the route. This parameter is automatically injected if it’s a part of your route (see example above). -
Returns
- Numpy array of shape [h, w, 3] RGB colors.
dep_asset
ValueError
- if the underlying assets are not videos, images, or audio.EncordException
- if data type not supported by SDK yet.
dep_video_iterator
storage_item
- Automatically injected storage item dependency.
NotImplementedError
- Will fail for other data types than video.
dep_project
dep_data_lookup
dep_data_lookup
is deprecated and will be removed in version 0.2.10.
Use dep_storage_item
instead for accessing storage items.
Migration Guide:
lookup
- The object that you can use to lookup data rows and storage items. Automatically injected.
dep_object_crops
filter_ontology_objects
- Optional list of ontology objects to filter by. If provided, only instances of these object types will be included. Strings are matched againstfeature_node_hashes
.