Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encord.com/llms.txt

Use this file to discover all available pages before exploring further.

​
EncordException Objects

class EncordException(Exception)
Base class for all exceptions.

​
InitialisationError Objects

class InitialisationError(EncordException)
Exception thrown when API key fails to initialise.

​
AuthenticationError Objects

class AuthenticationError(EncordException)
Exception thrown when API key fails authentication.

​
AuthorisationError Objects

class AuthorisationError(EncordException)
Exception thrown when access is unauthorized. (E.g. access to a data asset or method).

​
ResourceNotFoundError Objects

class ResourceNotFoundError(EncordException)
Exception thrown when a requested resource is not found. (E.g. label, data asset).

​
TimeOutError Objects

class TimeOutError(EncordException)
Exception thrown when a request times out.

​
RequestException Objects

class RequestException(EncordException)
Ambiguous exception while handling request.

​
RateLimitExceededError Objects

class RateLimitExceededError(EncordException)
Exception raised when requests exceed the Encord API rate limit.

​
PayloadTooLargeError Objects

class PayloadTooLargeError(EncordException)
Exception raised when request payload exceeds the maximum allowed size.

​
UnknownException Objects

class UnknownException(EncordException)
Unknown error.

​
InvalidDateFormatError Objects

class InvalidDateFormatError(EncordException)
Invalid date format error

​
MethodNotAllowedError Objects

class MethodNotAllowedError(EncordException)
Exception thrown when HTTP method is not allowed.

​
OperationNotAllowed Objects

class OperationNotAllowed(EncordException)
Exception thrown when a read/write operation is not allowed. The API key blocks the operation.

​
AnswerDictionaryError Objects

class AnswerDictionaryError(EncordException)
Exception thrown when answer dictionaries are incomplete. Occurs when an object or classification is missing.

​
CorruptedLabelError Objects

class CorruptedLabelError(EncordException)
Exception thrown when a label is corrupted. (E.g. the frame labels have more frames than the video).

​
FileTypeNotSupportedError Objects

class FileTypeNotSupportedError(EncordException)
Exception thrown when a file type is not supported. Supported file types are: image/jpeg, image/png, video/webm, video/mp4.

​
FileSizeNotSupportedError Objects

class FileSizeNotSupportedError(EncordException)
Exception thrown when the combined size of the input files is larger than the supported limit.

​
FeatureDoesNotExistError Objects

class FeatureDoesNotExistError(EncordException)
If a feature uid does not exist in a given project ontology.

​
ModelWeightsInconsistentError Objects

class ModelWeightsInconsistentError(EncordException)
Exception thrown when an attempted model training iteration has a different type of weights than what is recorded (i.e. if type of model_hash (uid) is faster_rcnn, but is attempted trained with different model weights).

​
ModelFeaturesInconsistentError Objects

class ModelFeaturesInconsistentError(EncordException)
If a feature type is different than what is supported by the model (e.g. if creating a classification model using a bounding box).

​
UploadOperationNotSupportedError Objects

class UploadOperationNotSupportedError(EncordException)
Exception thrown when trying to upload a video/image group to non-Encord storage dataset

​
DetectionRangeInvalidError Objects

class DetectionRangeInvalidError(EncordException)
Exception thrown when a detection range is invalid. (E.g. negative or higher than num frames in video).

​
InvalidAlgorithmError Objects

class InvalidAlgorithmError(EncordException)
Exception thrown when invalid labeling algorithm name is sent.

​
ResourceExistsError Objects

class ResourceExistsError(EncordException)
Exception thrown when trying to re-create a resource. Avoids overriding existing work.

​
DuplicateSshKeyError Objects

class DuplicateSshKeyError(EncordException)
Exception thrown when using an SSH key that was added twice to the platform.

​
SshKeyNotFound Objects

class SshKeyNotFound(EncordException)
Exception thrown when using an SSH key that was not added to the platform.

​
InvalidArgumentsError Objects

class InvalidArgumentsError(EncordException)
Exception thrown when the arguments are invalid.

​
GenericServerError Objects

class GenericServerError(EncordException)
The server has reported an error which is not recognized by this SDK version. Try upgrading the SDK version to see the precise error that is reported.

​
CloudUploadError Objects

class CloudUploadError(EncordException)
The upload to the cloud was not successful

​
MultiLabelLimitError Objects

class MultiLabelLimitError(EncordException)
Too many labels were requested

​
LabelRowError Objects

class LabelRowError(EncordException)
An error thrown when the construction of a LabelRow class is invalid.

​
OntologyError Objects

class OntologyError(EncordException)
An error thrown when using the ontology class with an error.

​
WrongProjectTypeError Objects

class WrongProjectTypeError(CordException)
An error thrown when project type does not match the operation E.g. when TMS2 specific operations are attempted on non-TMS2 project

​
BundledMoveWorkflowTasksPayloadError Objects

class BundledMoveWorkflowTasksPayloadError(EncordException)
An error thrown when an invalid item is added to the bundle to move workflow tasks