Skip to main content

Documentation Index

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

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

​
Classes

​
Sample

edgeimpulse_api.models.sample.Sample(
	**data: Any
)
Create a new model by parsing and validating input data from keyword arguments. Raises ValidationError if the input data cannot be parsed to form a valid model.
Parameters
**dataAny
Bases
pydantic.v1.main.BaseModel
pydantic.v1.utils.Representation
Class variables
Config
addeddatetime.datetime
bounding_boxesList[edgeimpulse_api.models.bounding_box.BoundingBox]
bounding_boxes_typepydantic.v1.types.StrictStr
categoryedgeimpulse_api.models.raw_data_category.RawDataCategory
chart_typepydantic.v1.types.StrictStr
coldstorage_filenamepydantic.v1.types.StrictStr
createddatetime.datetime
created_by_synthetic_data_job_idpydantic.v1.types.StrictInt | None
device_namepydantic.v1.types.StrictStr | None
device_typepydantic.v1.types.StrictStr
filenamepydantic.v1.types.StrictStr
frequencyfloat
idpydantic.v1.types.StrictInt
image_dimensionsedgeimpulse_api.models.sample_image_dimensions.SampleImageDimensions | None
interval_msfloat
is_croppedpydantic.v1.types.StrictBool
is_disabledpydantic.v1.types.StrictBool
is_processingpydantic.v1.types.StrictBool
labelpydantic.v1.types.StrictStr
label_mapedgeimpulse_api.models.sample_label_map_labels.SampleLabelMapLabels | None
last_modifieddatetime.datetime
metadataDict[str, pydantic.v1.types.StrictStr] | None
original_frequencyfloat
original_interval_msfloat
processing_errorpydantic.v1.types.StrictBool
processing_error_stringpydantic.v1.types.StrictStr | None
processing_job_idpydantic.v1.types.StrictInt | None
project_idpydantic.v1.types.StrictInt
project_labeling_methodedgeimpulse_api.models.project_labeling_method.ProjectLabelingMethod | None
project_namepydantic.v1.types.StrictStr | None
project_owner_namepydantic.v1.types.StrictStr | None
sensorsList[edgeimpulse_api.models.sensor.Sensor]
sha256_hashpydantic.v1.types.StrictStr
signature_keypydantic.v1.types.StrictStr | None
signature_methodpydantic.v1.types.StrictStr | None
signature_validatepydantic.v1.types.StrictBool
structured_labelsList[edgeimpulse_api.models.structured_label.StructuredLabel] | None
structured_labels_listList[pydantic.v1.types.StrictStr] | None
thumbnail_videopydantic.v1.types.StrictStr | None
thumbnail_video_fullpydantic.v1.types.StrictStr | None
total_length_msfloat | None
values_countpydantic.v1.types.StrictInt
video_urlpydantic.v1.types.StrictStr | None
video_url_fullpydantic.v1.types.StrictStr | None
STATIC METHODS

​
bounding_boxes_type_validate_enum

edgeimpulse_api.models.sample.Sample.bounding_boxes_type_validate_enum(
	v
)
Parameters
v

​
chart_type_validate_enum

edgeimpulse_api.models.sample.Sample.chart_type_validate_enum(
	v
)
Parameters
v

​
from_dict

edgeimpulse_api.models.sample.Sample.from_dict(
	obj: dict
) ‑> edgeimpulse_api.models.sample.Sample
Create an instance of Sample from a dict
Parameters
objdict
Returns
edgeimpulse_api.models.sample.Sample

​
from_json

edgeimpulse_api.models.sample.Sample.from_json(
	json_str: str
) ‑> edgeimpulse_api.models.sample.Sample
Create an instance of Sample from a JSON string
Parameters
json_strstr
Returns
edgeimpulse_api.models.sample.Sample
METHODS

​
to_dict

edgeimpulse_api.models.sample.Sample.to_dict(
	self
)
Returns the dictionary representation of the model using alias
Parameters
self

​
to_json

edgeimpulse_api.models.sample.Sample.to_json(
	self,
	indent=None
) ‑> str
Returns the JSON representation of the model using alias
Parameters
self
indent=None
Returns
str

​
to_str

edgeimpulse_api.models.sample.Sample.to_str(
	self
) ‑> str
Returns the string representation of the model using alias
Parameters
self
Returns
str