Skip to main content

​
Sample

class 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
  • **data: Any
Bases
  • pydantic.main.BaseModel
  • pydantic.utils.Representation
Class variables
  • Config The type of the None singleton.
  • added: datetime.datetime The type of the None singleton.
  • bounding_boxes: List[edgeimpulse_api.models.bounding_box.BoundingBox] The type of the None singleton.
  • bounding_boxes_type: pydantic.types.StrictStr The type of the None singleton.
  • category: edgeimpulse_api.models.raw_data_category.RawDataCategory The type of the None singleton.
  • chart_type: pydantic.types.StrictStr The type of the None singleton.
  • coldstorage_filename: pydantic.types.StrictStr The type of the None singleton.
  • created: datetime.datetime The type of the None singleton.
  • created_by_synthetic_data_job_id: pydantic.types.StrictInt | None The type of the None singleton.
  • device_name: pydantic.types.StrictStr | None The type of the None singleton.
  • device_type: pydantic.types.StrictStr The type of the None singleton.
  • filename: pydantic.types.StrictStr The type of the None singleton.
  • frequency: float The type of the None singleton.
  • id: pydantic.types.StrictInt The type of the None singleton.
  • image_dimensions: edgeimpulse_api.models.sample_image_dimensions.SampleImageDimensions | None The type of the None singleton.
  • interval_ms: float The type of the None singleton.
  • is_cropped: pydantic.types.StrictBool The type of the None singleton.
  • is_disabled: pydantic.types.StrictBool The type of the None singleton.
  • is_processing: pydantic.types.StrictBool The type of the None singleton.
  • label: pydantic.types.StrictStr The type of the None singleton.
  • last_modified: datetime.datetime The type of the None singleton.
  • metadata: Dict[str, pydantic.types.StrictStr] | None The type of the None singleton.
  • original_frequency: float The type of the None singleton.
  • original_interval_ms: float The type of the None singleton.
  • processing_error: pydantic.types.StrictBool The type of the None singleton.
  • processing_error_string: pydantic.types.StrictStr | None The type of the None singleton.
  • processing_job_id: pydantic.types.StrictInt | None The type of the None singleton.
  • project_id: pydantic.types.StrictInt The type of the None singleton.
  • project_labeling_method: pydantic.types.StrictStr | None The type of the None singleton.
  • project_name: pydantic.types.StrictStr | None The type of the None singleton.
  • project_owner_name: pydantic.types.StrictStr | None The type of the None singleton.
  • sensors: List[edgeimpulse_api.models.sensor.Sensor] The type of the None singleton.
  • sha256_hash: pydantic.types.StrictStr The type of the None singleton.
  • signature_key: pydantic.types.StrictStr | None The type of the None singleton.
  • signature_method: pydantic.types.StrictStr | None The type of the None singleton.
  • signature_validate: pydantic.types.StrictBool The type of the None singleton.
  • structured_labels: List[edgeimpulse_api.models.structured_label.StructuredLabel] | None The type of the None singleton.
  • structured_labels_list: List[pydantic.types.StrictStr] | None The type of the None singleton.
  • thumbnail_video: pydantic.types.StrictStr | None The type of the None singleton.
  • thumbnail_video_full: pydantic.types.StrictStr | None The type of the None singleton.
  • total_length_ms: float | None The type of the None singleton.
  • values_count: pydantic.types.StrictInt The type of the None singleton.
  • video_url: pydantic.types.StrictStr | None The type of the None singleton.
  • video_url_full: pydantic.types.StrictStr | None The type of the None singleton.

​
Static methods

​
bounding_boxes_type_validate_enum

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

​
chart_type_validate_enum

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

​
from_dict

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

​
from_json

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

​
project_labeling_method_validate_enum

edgeimpulse_api.models.sample.project_labeling_method_validate_enum(
		v
)
Parameters
  • v

​
Methods

​
to_dict

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

​
to_json

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

​
to_str

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