Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
edgeimpulse_api.api.admin_api
Parameters
api_client=None
Discourse
Log in a user to the forum. This function is only available through a JWT token.
Parameters
self
sso: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Single sign-on token', extra={})]
sig: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Verification signature', extra={})]
**kwargs
Return
None
Readme.io
Log in a user to the docs. This function is only available through a JWT token.
Parameters
self
**kwargs
Return
None
Parameters
api_client=None
User CDN resource
Proxy function to retrieve data from the user CDN. This function is only used during development.
Parameters
self
path: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='CDN Path', extra={})]
**kwargs
Return
str
Parameters
api_client=None
Clear DSP block
Clear generated features for a DSP block (used in tests).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Download a DSP artifact
Download an artifact from a DSP block for debugging. This is an internal API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
key: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='DSP artifact file key', extra={})]
**kwargs
Return
str
Download DSP data
Download output from a DSP block over all data in the training set, already sliced in windows. In Numpy binary format.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})]
raw: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to download raw data or processed data. Processed data is the default.', extra={})] = None
**kwargs
Return
str
Download DSP labels
Download labels for a DSP block over all data in the training set, already sliced in windows.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})]
**kwargs
Return
str
Features for sample
Runs the DSP block against a sample. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and run the DSP function for every window that is extracted.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.dsp_sample_features_response.DspSampleFeaturesResponse
Sample of trained features
Get a sample of trained features, this extracts a number of samples and their labels. Used to visualize the current training set.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
feature_ax1: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 1', extra={})]
feature_ax2: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 2', extra={})]
feature_ax3: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 3', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})]
**kwargs
Return
edgeimpulse_api.models.dsp_trained_features_response.DspTrainedFeaturesResponse
Get results from DSP autotuner
Get a set of parameters, found as a result of running the DSP autotuner.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.dsp_autotuner_results.DspAutotunerResults
Get config
Retrieve the configuration parameters for the DSP block. Use the impulse functions to retrieve all DSP blocks.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.dsp_config_response.DSPConfigResponse
Feature importance
Retrieve the feature importance for a DSP block (only available for blocks where dimensionalityReduction is not enabled)
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.dsp_feature_importance_response.DspFeatureImportanceResponse
Feature labels
Retrieve the names of the features the DSP block generates
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.dsp_feature_labels_response.DspFeatureLabelsResponse
Get metadata
Retrieve the metadata from a generated DSP block.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
exclude_included_samples: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description="Whether to exclude 'includedSamples' in the response (as these can slow down requests significantly).", extra={})] = None
**kwargs
Return
edgeimpulse_api.models.dsp_metadata_response.DSPMetadataResponse
Get raw sample
Get raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out. If you pass dspId = 0 this will return a raw graph without any processing.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
limit_payload_values: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_sample_response.GetSampleResponse
Get raw sample (slice)
Get slice of raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})]
slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_sample_response.GetSampleResponse
Get DSP block performance for all latency devices
Get estimated performance (latency and RAM) for the DSP block, for all supported project latency devices.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.dsp_performance_all_variants_response.DspPerformanceAllVariantsResponse
Get processed sample (from features array)
Takes in a features array and runs it through the DSP block. This data should have the same frequency as set in the input block in your impulse.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
dsp_run_request_with_features: edgeimpulse_api.models.dsp_run_request_with_features.DspRunRequestWithFeatures
**kwargs
Return
edgeimpulse_api.models.dsp_run_response.DspRunResponse
Get processed sample (slice)
Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})]
dsp_run_request_without_features: edgeimpulse_api.models.dsp_run_request_without_features.DspRunRequestWithoutFeatures
slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.dsp_run_response_with_sample.DspRunResponseWithSample
Get processed sample (slice)
Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})]
slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.dsp_run_response_with_sample.DspRunResponseWithSample
Set config
Set configuration parameters for the DSP block. Only values set in the body will be overwritten.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
dsp_config_request: edgeimpulse_api.models.dsp_config_request.DSPConfigRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Profile custom DSP block
Returns performance characteristics for a custom DSP block (needs hasTfliteImplementation
). Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
dsp_run_request_without_features_read_only: edgeimpulse_api.models.dsp_run_request_without_features_read_only.DspRunRequestWithoutFeaturesReadOnly
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Parameters
api_client=None
Classify sample (deprecated)
This API is deprecated, use classifySampleV2 instead (/v1/api/{projectId}/classify/v2/{sampleId}
). Classify a complete file against the current impulse. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
include_debug_info: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to return the debug information from FOMO classification.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.classify_sample_response.ClassifySampleResponse
Classify sample by learn block
This API is deprecated, use classifySampleByLearnBlockV2 (/v1/api/{projectId}/classify/anomaly-gmm/v2/{blockId}/{sampleId}
) instead. Classify a complete file against the specified learn block. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
block_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Block ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.classify_sample_response.ClassifySampleResponse
Classify sample by learn block
Classify a complete file against the specified learn block. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted. Depending on the size of your file, whether your sample is resampled, and whether the result is cached you'll get either the result or a job back. If you receive a job, then wait for the completion of the job, and then call this function again to receive the results. The unoptimized (float32) model is used by default, and classification with an optimized (int8) model can be slower.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
block_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Block ID', extra={})]
variant: typing_extensions.Annotated[Optional[edgeimpulse_api.models.keras_model_variant_enum.KerasModelVariantEnum], FieldInfo(default=PydanticUndefined, description='Keras model variant', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.classify_sample_v2200_response.ClassifySampleV2200Response
Classify sample for the given set of variants
Classify a complete file against the current impulse, for all given variants. Depending on the size of your file and whether the sample is resampled, you may get a job ID in the response.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
variants: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='List of keras model variants, given as a JSON string', extra={})]
include_debug_info: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to return the debug information from FOMO classification.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.classify_sample_for_variants200_response.ClassifySampleForVariants200Response
Classify sample
Classify a complete file against the current impulse. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted. Depending on the size of your file, whether your sample is resampled, and whether the result is cached you'll get either the result or a job back. If you receive a job, then wait for the completion of the job, and then call this function again to receive the results. The unoptimized (float32) model is used by default, and classification with an optimized (int8) model can be slower.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
include_debug_info: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to return the debug information from FOMO classification.', extra={})] = None
variant: typing_extensions.Annotated[Optional[edgeimpulse_api.models.keras_model_variant_enum.KerasModelVariantEnum], FieldInfo(default=PydanticUndefined, description='Keras model variant', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.classify_sample_v2200_response.ClassifySampleV2200Response
Classify job result
Get classify job result, containing the result for the complete testing dataset.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
feature_explorer_only: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to get only the classification results relevant to the feature explorer.', extra={})] = None
variant: typing_extensions.Annotated[Optional[edgeimpulse_api.models.keras_model_variant_enum.KerasModelVariantEnum], FieldInfo(default=PydanticUndefined, description='Keras model variant', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.classify_job_response.ClassifyJobResponse
Single page of a classify job result
Get classify job result, containing the predictions for a given page.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
variant: typing_extensions.Annotated[Optional[edgeimpulse_api.models.keras_model_variant_enum.KerasModelVariantEnum], FieldInfo(default=PydanticUndefined, description='Keras model variant', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.classify_job_response_page.ClassifyJobResponsePage
Get metrics for all available model variants
Get metrics, calculated during a classify all job, for all available model variants. This is experimental and may change in the future.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.metrics_all_variants_response.MetricsAllVariantsResponse
Get a window of raw sample features from cache, after a live classification job has completed.
Get raw sample features for a particular window. This is only available after a live classification job has completed and raw features have been cached.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
window_index: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample window index', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_sample_response.GetSampleResponse
Parameters
api_client=None
Create device
Create a new device. If you set ifNotExists
to false
and the device already exists, the deviceType
will be overwritten.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
create_device_request: edgeimpulse_api.models.create_device_request.CreateDeviceRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete device
Delete a device. When this device sends a new message to ingestion or connects to remote management the device will be recreated.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get device
Retrieves a single device
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_device_response.GetDeviceResponse
Get impulse records
Retrieve impulse records from the device.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]
get_impulse_records_request: edgeimpulse_api.models.get_impulse_records_request.GetImpulseRecordsRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Keep debug stream alive
If you have opened a debug stream, ping this interface every 10 seconds to let us know to keep the debug stream open.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]
keep_device_debug_stream_alive_request: edgeimpulse_api.models.keep_device_debug_stream_alive_request.KeepDeviceDebugStreamAliveRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Lists devices
List all devices for this project. Devices get included here if they connect to the remote management API or if they have sent data to the ingestion API and had the device_id
field set.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_devices_response.ListDevicesResponse
Rename device
Set the current name for a device.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]
rename_device_request: edgeimpulse_api.models.rename_device_request.RenameDeviceRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Trigger model update request
Trigger a model update request, this only works for devices connected to remote management server in inference mode.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Start inference debug stream
Start an inference debug stream for this device with inference results (and images if a camera is attached). Updates are streamed through the websocket API. A keep-alive token is returned, you'll need to ping the API (with keepDeviceDebugStreamAlive) every 10 seconds (so we know when the client is disconnected).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_device_debug_stream_response.StartDeviceDebugStreamResponse
Start snapshot debug stream
Start a snapshot debug stream for this device with a current camera view. Updates are streamed through the websocket API. A keep-alive token is returned, you'll need to ping the API (with keepDeviceDebugStreamAlive) every 10 seconds (so we know when the client is disconnected).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]
start_device_snapshot_debug_stream_request: edgeimpulse_api.models.start_device_snapshot_debug_stream_request.StartDeviceSnapshotDebugStreamRequest
**kwargs
Return
edgeimpulse_api.models.start_device_debug_stream_response.StartDeviceDebugStreamResponse
Start sampling
Start sampling on a device. This function returns immediately. Updates are streamed through the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]
start_sampling_request: edgeimpulse_api.models.start_sampling_request.StartSamplingRequest
**kwargs
Return
edgeimpulse_api.models.start_sampling_response.StartSamplingResponse
Stop debug stream
If you have opened a debug stream, close it.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
device_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Device ID', extra={})]
stop_device_debug_stream_request: edgeimpulse_api.models.stop_device_debug_stream_request.StopDeviceDebugStreamRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Download
Download the build artefacts for a project
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='The name of the built target. You can find this by listing all deployment targets through listDeploymentTargetsForProject
(via GET /v1/api/{projectId}/deployment/targets
) and see the format
type.', extra={})]
model_type: typing_extensions.Annotated[Optional[edgeimpulse_api.models.keras_model_type_enum.KerasModelTypeEnum], FieldInfo(default=PydanticUndefined, description='Optional model type of the build (if not, it uses the settings in the Keras block)', extra={})] = None
engine: typing_extensions.Annotated[Optional[edgeimpulse_api.models.deployment_target_engine.DeploymentTargetEngine], FieldInfo(default=PydanticUndefined, description='Optional engine for the build (if not, it uses the default engine for the deployment target)', extra={})] = None
**kwargs
Return
str
Find Syntiant posterior parameters
Automatically find the current posterior parameters for the Syntiant deployment target
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
target_words: List[pydantic.types.StrictStr]
reference_set: pydantic.types.StrictStr
wav_file: Optional[pydantic.types.StrictStr] = None
meta_csv_file: Optional[pydantic.types.StrictStr] = None
deployment_target: Optional[pydantic.types.StrictStr] = None
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Get deployment info
Gives information on whether a deployment was already built for a type
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='The name of the built target. You can find this by listing all deployment targets through listDeploymentTargetsForProject
(via GET /v1/api/{projectId}/deployment/targets
) and see the format
type.', extra={})]
model_type: typing_extensions.Annotated[Optional[edgeimpulse_api.models.keras_model_type_enum.KerasModelTypeEnum], FieldInfo(default=PydanticUndefined, description='Optional model type of the build (if not, it uses the settings in the Keras block)', extra={})] = None
engine: typing_extensions.Annotated[Optional[edgeimpulse_api.models.deployment_target_engine.DeploymentTargetEngine], FieldInfo(default=PydanticUndefined, description='Optional engine for the build (if not, it uses the default engine for the deployment target)', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_deployment_response.GetDeploymentResponse
Evaluate job result
Get evaluate job result, containing detailed performance statistics for every possible variant of the impulse.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.evaluate_job_response.EvaluateJobResponse
Check evaluate job result (cache)
Get evaluate job result, containing detailed performance statistics for every possible variant of the impulse. This only checks cache, and throws an error if there is no data in cache.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.evaluate_job_response.EvaluateJobResponse
Get information on the last deployment build
Get information on the result of the last successful deployment job, including info on the build e.g. whether it is still valid.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_last_deployment_build_response.GetLastDeploymentBuildResponse
Get Syntiant posterior parameters
Get the current posterior parameters for the Syntiant deployment target
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_syntiant_posterior_response.GetSyntiantPosteriorResponse
Deployment targets
List all deployment targets
Parameters
self
**kwargs
Return
edgeimpulse_api.models.deployment_targets_response.DeploymentTargetsResponse
Deployment targets
List deployment targets for a project
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.project_deployment_targets_response.ProjectDeploymentTargetsResponse
Deployment targets (data sources)
List deployment targets for a project from data sources page (it shows some things like all Linux deploys, and hides 'fake' deploy targets like mobile phone / computer)
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.deployment_targets_response.DeploymentTargetsResponse
Set Syntiant posterior parameters
Set the current posterior parameters for the Syntiant deployment target
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
set_syntiant_posterior_request: edgeimpulse_api.models.set_syntiant_posterior_request.SetSyntiantPosteriorRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Get email verification status
Get the status of an email verification.
Parameters
self
email_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Unique identifier for an email verification request', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_email_verification_status_response.GetEmailVerificationStatusResponse
Request email verification
Request an email activation code to be sent to the specified email address.
Parameters
self
email: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Email address', extra={})]
request_email_verification_request: edgeimpulse_api.models.request_email_verification_request.RequestEmailVerificationRequest
**kwargs
Return
edgeimpulse_api.models.entity_created_response.EntityCreatedResponse
Verify email
Verify an email address using the specified verification code.
Parameters
self
activate_user_or_verify_email_request: edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest
**kwargs
Return
edgeimpulse_api.models.verify_email_response.VerifyEmailResponse
Parameters
api_client=None
Get URL of export
Get the URL to the exported artefacts for an export job of a project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.export_get_url_response.ExportGetUrlResponse
Parameters
api_client=None
Get studio api containers health
Get studio api containers health.
Parameters
self
requester: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Health check requester', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get studio web containers health
Get studio web containers health.
Parameters
self
requester: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Health check requester', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Create new block version
Create a new version of a given block
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
block_type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Type of block', extra={})]
block_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Block ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.create_block_version_response.CreateBlockVersionResponse
Create impulse
Sets the impulse for this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
impulse: edgeimpulse_api.models.impulse.Impulse
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete impulse
Completely clears the impulse for this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get impulse
Retrieve the impulse for this project
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_impulse_response.GetImpulseResponse
Get impulse including disabled blocks
Retrieve the impulse for this project including disabled blocks
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_impulse_response.GetImpulseResponse
Get impulse blocks
Lists all possible blocks that can be used in the impulse
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_impulse_blocks_response.GetImpulseBlocksResponse
Update block version details
Update the details of a block version
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
block_type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Type of block', extra={})]
block_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Block ID', extra={})]
impulse_block_version: edgeimpulse_api.models.impulse_block_version.ImpulseBlockVersion
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Verify custom DSP block
Verify the validity of a custom DSP block
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
verify_dsp_block_url_request: edgeimpulse_api.models.verify_dsp_block_url_request.VerifyDspBlockUrlRequest
**kwargs
Return
edgeimpulse_api.models.verify_dsp_block_url_response.VerifyDspBlockUrlResponse
Parameters
api_client=None
Add Keras files
Add Keras block files with the contents of a zip. This is an internal API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
zip: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Trained features
Get a sample of trained features, this extracts a number of samples and their features.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
feature_ax1: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 1', extra={})]
feature_ax2: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 2', extra={})]
**kwargs
Return
edgeimpulse_api.models.anomaly_trained_features_response.AnomalyTrainedFeaturesResponse
Trained features for sample
Get trained features for a single sample. This runs both the DSP prerequisites and the anomaly classifier.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.anomaly_trained_features_response.AnomalyTrainedFeaturesResponse
Download Keras data export
Download the data of an exported Keras block - needs to be exported via 'exportKerasBlockData' first
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
str
Download Keras export
Download an exported Keras block - needs to be exported via 'exportKerasBlock' first
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
str
Download trained model
Download a trained model for a learning block. Depending on the block this can be a TensorFlow model, or the cluster centroids.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
model_download_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Model download ID, which can be obtained from the project information', extra={})]
**kwargs
Return
str
Download pretrained model
Download a pretrained model file
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
pretrained_model_download_type: pydantic.types.StrictStr
**kwargs
Return
str
Anomaly information
Get information about an anomaly block, such as its dependencies. Use the impulse blocks to find the learnId.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.anomaly_response.AnomalyResponse
Anomaly metadata
Get metadata about a trained anomaly block. Use the impulse blocks to find the learnId.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.anomaly_model_metadata.AnomalyModelMetadata
Anomaly GMM metadata
Get raw model metadata of the Gaussian mixture model (GMM) for a trained anomaly block. Use the impulse blocks to find the learnId.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.anomaly_gmm_metadata.AnomalyGmmMetadata
Keras information
Get information about a Keras block, such as its dependencies. Use the impulse blocks to find the learnId.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.keras_response.KerasResponse
Get data explorer features
t-SNE2 output of the raw dataset using embeddings from this Keras block
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_data_explorer_features_response.GetDataExplorerFeaturesResponse
Keras metadata
Get metadata about a trained Keras block. Use the impulse blocks to find the learnId.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.keras_model_metadata.KerasModelMetadata
Download data
Download the processed data for this learning block. This is data already processed by the signal processing blocks.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
str
Download labels
Download the labels for this learning block. This is data already processed by the signal processing blocks. Not all blocks support this function. If so, a GenericApiResponse is returned with an error message.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
str
Get pretrained model
Receive info back about the earlier uploaded pretrained model (via uploadPretrainedModel
) input/output tensors. If you want to deploy a pretrained model from the API, see startDeployPretrainedModelJob
.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_pretrained_model_response.GetPretrainedModelResponse
Profile pretrained model
Returns the latency, RAM and ROM used for the pretrained model - upload first via uploadPretrainedModel
. This is using the project's selected latency device. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Save parameters for pretrained model
Save input / model configuration for a pretrained model. This overrides the current impulse. If you want to deploy a pretrained model from the API, see startDeployPretrainedModelJob
.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
save_pretrained_model_request: Optional[edgeimpulse_api.models.save_pretrained_model_request.SavePretrainedModelRequest] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Anomaly settings
Configure the anomaly block, such as its minimum confidence score. Use the impulse blocks to find the learnId.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
set_anomaly_parameter_request: edgeimpulse_api.models.set_anomaly_parameter_request.SetAnomalyParameterRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Keras settings
Configure the Keras block, such as its minimum confidence score. Use the impulse blocks to find the learnId.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
set_keras_parameter_request: edgeimpulse_api.models.set_keras_parameter_request.SetKerasParameterRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Test pretrained model
Test out a pretrained model (using raw features) - upload first via uploadPretrainedModel
. If you want to deploy a pretrained model from the API, see startDeployPretrainedModelJob
.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
test_pretrained_model_request: Optional[edgeimpulse_api.models.test_pretrained_model_request.TestPretrainedModelRequest] = None
**kwargs
Return
edgeimpulse_api.models.test_pretrained_model_response.TestPretrainedModelResponse
Upload Keras files
Replace Keras block files with the contents of a zip. This is an internal API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
zip: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Upload a pretrained model
Upload a pretrained model and receive info back about the input/output tensors. If you want to deploy a pretrained model from the API, see startDeployPretrainedModelJob
.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
model_file: pydantic.types.StrictStr
model_file_name: pydantic.types.StrictStr
model_file_type: pydantic.types.StrictStr
representative_features: Optional[pydantic.types.StrictStr] = None
device: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='MCU used for calculating latency, query latencyDevices
in listProject
for a list of supported devices (and use the \"mcu\" property here). If this is kept empty then we'll show an overview of multiple devices.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Parameters
api_client=None
Autotune DSP parameters
Autotune DSP block parameters. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
autotune_dsp_request: edgeimpulse_api.models.autotune_dsp_request.AutotuneDspRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Build on-device model
Generate code to run the impulse on an embedded device. When this step is complete use downloadBuild
to download the artefacts. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='The name of the built target. You can find this by listing all deployment targets through listDeploymentTargetsForProject
(via GET /v1/api/{projectId}/deployment/targets
) and see the format
type.', extra={})]
build_on_device_model_request: edgeimpulse_api.models.build_on_device_model_request.BuildOnDeviceModelRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Build organizational on-device model
Generate code to run the impulse on an embedded device using an organizational deployment block. When this step is complete use downloadBuild
to download the artefacts. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
build_organization_on_device_model_request: edgeimpulse_api.models.build_organization_on_device_model_request.BuildOrganizationOnDeviceModelRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Calculate data quality metrics. Only available for EI staff.
Calculate data quality metrics for the dataset
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
calculate_data_quality_metrics_request: edgeimpulse_api.models.calculate_data_quality_metrics_request.CalculateDataQualityMetricsRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Cancel job
Cancel a running job.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
force_cancel: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="If set to 'true', we won't wait for the job cluster to cancel the job, and will mark the job as finished.", extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Download logs
Download the logs for a job (as a text file).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
log_level: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Log level (error, warn, info, debug)', extra={})] = None
**kwargs
Return
str
Export Keras block
Export the training pipeline of a Keras block. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Export Keras block data
Export the data of a Keras block (already split in train/validate data). Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
export_keras_block_data_request: Optional[edgeimpulse_api.models.export_keras_block_data_request.ExportKerasBlockDataRequest] = None
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Generate data explorer features
Generate features for the data explorer
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Generate features
Take the raw training set and generate features from them. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
generate_features_request: edgeimpulse_api.models.generate_features_request.GenerateFeaturesRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Get job status
Get the status for a job.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_job_response.GetJobResponse
Get logs
Get the logs for a job.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
log_level: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Log level (error, warn, info, debug)', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.log_stdout_response.LogStdoutResponse
Job summary
Get a summary of jobs, grouped by key. Used to report to users how much compute they've used.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
start_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})]
end_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})]
**kwargs
Return
edgeimpulse_api.models.job_summary_response.JobSummaryResponse
Get TFLite profile result (GET)
Get the results from a job started from startProfileTfliteJob (via a GET request).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.profile_tf_lite_response.ProfileTfLiteResponse
Get TFLite profile result (POST)
Get the results from a job started from startProfileTfliteJob (via a POST request).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.profile_tf_lite_response.ProfileTfLiteResponse
List active jobs
Get all active jobs for this project
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
root_only: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_jobs_response.ListJobsResponse
List all jobs
Get all jobs for this project
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
start_date: typing_extensions.Annotated[Optional[datetime.datetime], FieldInfo(default=PydanticUndefined, description='Start date', extra={})] = None
end_date: typing_extensions.Annotated[Optional[datetime.datetime], FieldInfo(default=PydanticUndefined, description='End date', extra={})] = None
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
root_only: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None
key: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Job key to filter on', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_jobs_response.ListJobsResponse
List finished jobs
Get all finished jobs for this project
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
start_date: typing_extensions.Annotated[Optional[datetime.datetime], FieldInfo(default=PydanticUndefined, description='Start date', extra={})] = None
end_date: typing_extensions.Annotated[Optional[datetime.datetime], FieldInfo(default=PydanticUndefined, description='End date', extra={})] = None
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
root_only: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_jobs_response.ListJobsResponse
Optimize model
Evaluates optimal model architecture
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Sets EON tuner primary model
Sets EON tuner primary model
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
trial_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='trial ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Classify
Classifies all items in the testing dataset against the current impulse. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
start_classify_job_request: Optional[edgeimpulse_api.models.start_classify_job_request.StartClassifyJobRequest] = None
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Deploy pretrained model
Takes in a TFLite file and builds the model and SDK. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
deploy_pretrained_model_request: edgeimpulse_api.models.deploy_pretrained_model_request.DeployPretrainedModelRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Evaluate
Evaluates every variant of the current impulse. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Add keywords and noise
Add keywords and noise data to a project (for getting started guide)
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Make a version public
Make a version of a project public. This makes all data and state available (read-only) on a public URL, and allows users to clone this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
version_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Export original data
Export all the data in the project as it was uploaded to Edge Impulse. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
export_original_data_request: edgeimpulse_api.models.export_original_data_request.ExportOriginalDataRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Performance Calibration
Simulates real world usage and returns performance metrics.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
start_performance_calibration_request: edgeimpulse_api.models.start_performance_calibration_request.StartPerformanceCalibrationRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Profile TFLite model
Takes in a TFLite model and returns the latency, RAM and ROM used for this model. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
profile_tf_lite_request: edgeimpulse_api.models.profile_tf_lite_request.ProfileTfLiteRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Restore project to version
Restore a project to a certain version. This can only applied to a project without data, and will overwrite your impulse and all settings.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
restore_project_request: edgeimpulse_api.models.restore_project_request.RestoreProjectRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Restore project to public version
Restore a project to a certain public version. This can only applied to a project without data, and will overwrite your impulse and all settings.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
restore_project_from_public_request: edgeimpulse_api.models.restore_project_from_public_request.RestoreProjectFromPublicRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Retrain
Retrains the current impulse with the last known parameters. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Version project
Create a new version of the project. This stores all data and configuration offsite. If you have access to the enterprise version of Edge Impulse you can store your data in your own storage buckets (only through JWT token authentication).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
project_version_request: edgeimpulse_api.models.project_version_request.ProjectVersionRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Export data as WAV
Export all the data in the project in WAV format. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
export_wav_data_request: edgeimpulse_api.models.export_wav_data_request.ExportWavDataRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Train model (Anomaly)
Take the output from a DSP block and train an anomaly detection model using K-means or GMM. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
start_training_request_anomaly: edgeimpulse_api.models.start_training_request_anomaly.StartTrainingRequestAnomaly
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Train model (Keras)
Take the output from a DSP block and train a neural network using Keras. Updates are streamed over the websocket API.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
learn_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})]
set_keras_parameter_request: edgeimpulse_api.models.set_keras_parameter_request.SetKerasParameterRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Update job
Update a job.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
update_job_request: edgeimpulse_api.models.update_job_request.UpdateJobRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Get public metrics
Get information about number of projects, compute and data samples. Updated once per hour.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.get_public_metrics_response.GetPublicMetricsResponse
Log analytics event
Log an analytics event.
Parameters
self
log_analytics_event_request: edgeimpulse_api.models.log_analytics_event_request.LogAnalyticsEventRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Log website pageview
Log a website pageview. Used for website analytics.
Parameters
self
log_website_pageview_request: edgeimpulse_api.models.log_website_pageview_request.LogWebsitePageviewRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Create trial
Create trial
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
tuner_create_trial_impulse: edgeimpulse_api.models.tuner_create_trial_impulse.TunerCreateTrialImpulse
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete EON tuner state
Completely clears the EON tuner state for this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get config
Get config
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.optimize_config_response.OptimizeConfigResponse
Retrieves DSP block parameters
Retrieves DSP block parameters
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
organization_dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization DSP ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.optimize_dsp_parameters_response.OptimizeDSPParametersResponse
Search space
Search space
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.optimize_space_response.OptimizeSpaceResponse
Retrieves the EON tuner state
Retrieves the EON tuner state
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.optimize_state_response.OptimizeStateResponse
Retrieves available transfer learning models
Retrieves available transfer learning models
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.optimize_transfer_learning_models_response.OptimizeTransferLearningModelsResponse
Get trial logs
Get the logs for a trial.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
trial_id: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='trial ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.log_stdout_response.LogStdoutResponse
Retrieves EON tuner state for a run.
Retrieves the EON tuner state for a specific run.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
tuner_coordinator_job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Tuner coordinator job ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.optimize_state_response.OptimizeStateResponse
Get window settings
Get window settings
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.window_settings_response.WindowSettingsResponse
List all tuner runs
List all the tuner runs for a project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_tuner_runs_response.ListTunerRunsResponse
Score trial
Score trial
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
tuner_create_trial_impulse: edgeimpulse_api.models.tuner_create_trial_impulse.TunerCreateTrialImpulse
**kwargs
Return
edgeimpulse_api.models.score_trial_response.ScoreTrialResponse
Update config
Update config
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
optimize_config: edgeimpulse_api.models.optimize_config.OptimizeConfig
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update EON tuner state
Updates the EON tuner state for a specific run.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
tuner_coordinator_job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Tuner coordinator job ID', extra={})]
update_tuner_run_request: edgeimpulse_api.models.update_tuner_run_request.UpdateTunerRunRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Add deploy block
Adds a deploy block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
name: pydantic.types.StrictStr
docker_container: pydantic.types.StrictStr
description: pydantic.types.StrictStr
cli_arguments: pydantic.types.StrictStr
requests_cpu: Optional[float] = None
requests_memory: Optional[pydantic.types.StrictInt] = None
limits_cpu: Optional[float] = None
limits_memory: Optional[pydantic.types.StrictInt] = None
photo: Optional[pydantic.types.StrictStr] = None
integrate_url: Optional[pydantic.types.StrictStr] = None
privileged: Optional[pydantic.types.StrictBool] = None
mount_learn_block: Optional[pydantic.types.StrictBool] = None
supports_eon_compiler: Optional[pydantic.types.StrictBool] = None
show_optimizations: Optional[pydantic.types.StrictBool] = None
category: Optional[pydantic.types.StrictStr] = None
**kwargs
Return
edgeimpulse_api.models.add_organization_deploy_block_response.AddOrganizationDeployBlockResponse
Add dsp block
Adds a dsp block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
add_organization_dsp_block_request: edgeimpulse_api.models.add_organization_dsp_block_request.AddOrganizationDspBlockRequest
**kwargs
Return
edgeimpulse_api.models.add_organization_dsp_block_response.AddOrganizationDspBlockResponse
Add secret
Adds a secret.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
add_organization_secret_request: edgeimpulse_api.models.add_organization_secret_request.AddOrganizationSecretRequest
**kwargs
Return
edgeimpulse_api.models.add_organization_secret_response.AddOrganizationSecretResponse
Add transfer learning block
Adds a transfer learning block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
add_organization_transfer_learning_block_request: edgeimpulse_api.models.add_organization_transfer_learning_block_request.AddOrganizationTransferLearningBlockRequest
**kwargs
Return
edgeimpulse_api.models.add_organization_transfer_learning_block_response.AddOrganizationTransferLearningBlockResponse
Add transformation block
Adds a transformation block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
add_organization_transformation_block_request: edgeimpulse_api.models.add_organization_transformation_block_request.AddOrganizationTransformationBlockRequest
**kwargs
Return
edgeimpulse_api.models.add_organization_transformation_block_response.AddOrganizationTransformationBlockResponse
Delete deploy block
Deletes a deploy block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
deploy_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Deploy block ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete dsp block
Deletes a dsp block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete secret
Deletes a secret
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
secret_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Secret ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete transfer learning block
Deletes a transfer learning block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
transfer_learning_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Transfer learning ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete transformation block
Deletes a transformation block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
transformation_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Transformation block ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Export deploy block
Download the source code for this block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
deploy_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Deploy block ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.export_block_response.ExportBlockResponse
Export dsp block
Download the source code for this block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.export_block_response.ExportBlockResponse
Export transfer learning block
Download the source code for this block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
transfer_learning_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Transfer learning ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.export_block_response.ExportBlockResponse
Export transformation block
Download the source code for this block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
transformation_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Transformation block ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.export_block_response.ExportBlockResponse
Get deploy block
Gets a deploy block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
deploy_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Deploy block ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_deploy_block_response.GetOrganizationDeployBlockResponse
Get dsp block
Gets a dsp block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_dsp_block_response.GetOrganizationDspBlockResponse
Get transfer learning block
Gets a transfer learning block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
transfer_learning_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Transfer learning ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_transfer_learning_block_response.GetOrganizationTransferLearningBlockResponse
Get transformation block
Get a transformation block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
transformation_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Transformation block ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_transformation_block_response.GetOrganizationTransformationBlockResponse
Get deploy blocks
Retrieve all deploy blocks.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_organization_deploy_blocks_response.ListOrganizationDeployBlocksResponse
Get dsp blocks
Retrieve all dsp blocks.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_organization_dsp_blocks_response.ListOrganizationDspBlocksResponse
Get secrets
Retrieve all secrets.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_organization_secrets_response.ListOrganizationSecretsResponse
Get transfer learning blocks
Retrieve all transfer learning blocks.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_organization_transfer_learning_blocks_response.ListOrganizationTransferLearningBlocksResponse
Get transformation blocks
Retrieve all transformation blocks.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_organization_transformation_blocks_response.ListOrganizationTransformationBlocksResponse
List public transformation blocks
Retrieve all transformation blocks published by other organizations, available for all organizations.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_public_organization_transformation_blocks_response.ListPublicOrganizationTransformationBlocksResponse
Retry connection to dsp block
Retry launch a dsp block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update deploy block
Updates a deploy block. Only values in the body will be updated.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
deploy_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Deploy block ID.', extra={})]
name: Optional[pydantic.types.StrictStr] = None
docker_container: Optional[pydantic.types.StrictStr] = None
description: Optional[pydantic.types.StrictStr] = None
cli_arguments: Optional[pydantic.types.StrictStr] = None
requests_cpu: Optional[float] = None
requests_memory: Optional[pydantic.types.StrictInt] = None
limits_cpu: Optional[float] = None
limits_memory: Optional[pydantic.types.StrictInt] = None
photo: Optional[pydantic.types.StrictStr] = None
integrate_url: Optional[pydantic.types.StrictStr] = None
privileged: Optional[pydantic.types.StrictBool] = None
mount_learn_block: Optional[pydantic.types.StrictBool] = None
supports_eon_compiler: Optional[pydantic.types.StrictBool] = None
show_optimizations: Optional[pydantic.types.StrictBool] = None
category: Optional[pydantic.types.StrictStr] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update dsp block
Updates a dsp block. Only values in the body will be updated.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
update_organization_dsp_block_request: edgeimpulse_api.models.update_organization_dsp_block_request.UpdateOrganizationDspBlockRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update transfer learning block
Updates a transfer learning block. Only values in the body will be updated.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
transfer_learning_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Transfer learning ID', extra={})]
update_organization_transfer_learning_block_request: edgeimpulse_api.models.update_organization_transfer_learning_block_request.UpdateOrganizationTransferLearningBlockRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update transformation block
Updates a transformation block. Only values in the body will be updated.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
transformation_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Transformation block ID.', extra={})]
update_organization_transformation_block_request: edgeimpulse_api.models.update_organization_transformation_block_request.UpdateOrganizationTransformationBlockRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Add a data campaign
Add a new data campaign to a data campaign dashboard
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
add_organization_data_campaign_request: edgeimpulse_api.models.add_organization_data_campaign_request.AddOrganizationDataCampaignRequest
**kwargs
Return
edgeimpulse_api.models.add_organization_data_campaign_response.AddOrganizationDataCampaignResponse
Add data campaign dashboard
Add a new data campaign dashboard
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
add_organization_data_campaign_dashboard_request: edgeimpulse_api.models.add_organization_data_campaign_dashboard_request.AddOrganizationDataCampaignDashboardRequest
**kwargs
Return
edgeimpulse_api.models.add_organization_data_campaign_dashboard_response.AddOrganizationDataCampaignDashboardResponse
Delete data campaign
Delete a data campaign
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
campaign_id: pydantic.types.StrictInt
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete data campaign dashboard
Delete a data campaign dashboard
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
campaign_dashboard_id: pydantic.types.StrictInt
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get data campaign
Get a data campaign
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
campaign_id: pydantic.types.StrictInt
**kwargs
Return
edgeimpulse_api.models.get_organization_data_campaign_response.GetOrganizationDataCampaignResponse
Get data campaign dashboard
Get a data campaign dashboard
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
campaign_dashboard_id: pydantic.types.StrictInt
**kwargs
Return
edgeimpulse_api.models.get_organization_data_campaign_dashboard_response.GetOrganizationDataCampaignDashboardResponse
Get data campaign dashboards
List all data campaign dashboards
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_data_campaign_dashboards_response.GetOrganizationDataCampaignDashboardsResponse
Get diff for data campaign
Get which items have changed for a data campaign. You post the data points and we'll return which data items are different in the past day.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
campaign_id: pydantic.types.StrictInt
organization_data_campaign_diff_request: edgeimpulse_api.models.organization_data_campaign_diff_request.OrganizationDataCampaignDiffRequest
**kwargs
Return
edgeimpulse_api.models.organization_data_campaign_diff_response.OrganizationDataCampaignDiffResponse
Get data campaigns
Get a list of all data campaigns for a dashboard
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
campaign_dashboard_id: pydantic.types.StrictInt
**kwargs
Return
edgeimpulse_api.models.get_organization_data_campaigns_response.GetOrganizationDataCampaignsResponse
Update data campaign
Update a data campaign
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
campaign_id: pydantic.types.StrictInt
update_organization_data_campaign_request: edgeimpulse_api.models.update_organization_data_campaign_request.UpdateOrganizationDataCampaignRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update data campaign dashboard
Update a data campaign dashboard
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
campaign_dashboard_id: pydantic.types.StrictInt
update_organization_data_campaign_dashboard_request: edgeimpulse_api.models.update_organization_data_campaign_dashboard_request.UpdateOrganizationDataCampaignDashboardRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Upload a dashboard screenshot
Used internally to upload a picture of a screenshot
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
campaign_dashboard_id: pydantic.types.StrictInt
image: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Cancel job
Cancel a running job.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
force_cancel: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="If set to 'true', we won't wait for the job cluster to cancel the job, and will mark the job as finished.", extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Download logs
Download the logs for a job (as a text file).
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
log_level: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Log level (error, warn, info, debug)', extra={})] = None
**kwargs
Return
str
Get job status
Get the status for a job.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_job_response.GetJobResponse
Get logs
Get the logs for a job.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
job_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
log_level: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Log level (error, warn, info, debug)', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.log_stdout_response.LogStdoutResponse
Get socket token for an organization
Get a token to authenticate with the web socket interface.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.socket_token_response.SocketTokenResponse
List active jobs
Get all active jobs for this organization
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
root_only: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_jobs_response.ListJobsResponse
List all jobs
Get all jobs for this organization
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
start_date: typing_extensions.Annotated[Optional[datetime.datetime], FieldInfo(default=PydanticUndefined, description='Start date', extra={})] = None
end_date: typing_extensions.Annotated[Optional[datetime.datetime], FieldInfo(default=PydanticUndefined, description='End date', extra={})] = None
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
exclude_pipeline_transform_jobs: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude pipeline / transformation jobs', extra={})] = None
root_only: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None
key: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Job key to filter on', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_jobs_response.ListJobsResponse
List finished jobs
Get all finished jobs for this organization
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
start_date: typing_extensions.Annotated[Optional[datetime.datetime], FieldInfo(default=PydanticUndefined, description='Start date', extra={})] = None
end_date: typing_extensions.Annotated[Optional[datetime.datetime], FieldInfo(default=PydanticUndefined, description='End date', extra={})] = None
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
root_only: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_jobs_response.ListJobsResponse
Parameters
api_client=None
Clear failed transform jobs
Clear all failed transform job from a create project job. Only jobs that have failed will be cleared.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete transformation job
Remove a transformation job. This will stop all running jobs.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete create project file
Remove a file from a create project job. Only files for which no jobs are running can be deleted.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
create_project_file_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job file ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get transformation job status
Get the current status of a transformation job job.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
transform_limit: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Maximum number of results of transformation jobs', extra={})]
transform_offset: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Offset in results of transformation jobs, can be used in conjunction with TransformLimitResultsParameter to implement paging.', extra={})]
selection: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Type of selected rows, either 'all', 'created', 'in-progress' or 'failed' (defaults to 'all')", extra={})] = None
**kwargs
Return
edgeimpulse_api.models.organization_create_project_status_response.OrganizationCreateProjectStatusResponse
List transformation jobs
Get list of transformation jobs.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
include_pipeline_jobs: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='If enabled, also includes jobs that are part of a pipeline', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.organization_get_create_projects_response.OrganizationGetCreateProjectsResponse
Add a collaborator to a project within an organisation
Add a new collaborator to a project owned by an organisation.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_organization_add_collaborator_request: edgeimpulse_api.models.update_organization_add_collaborator_request.UpdateOrganizationAddCollaboratorRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Create new empty project
Create a new empty project within an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_organization_create_empty_project_request: edgeimpulse_api.models.update_organization_create_empty_project_request.UpdateOrganizationCreateEmptyProjectRequest
**kwargs
Return
edgeimpulse_api.models.create_project_response.CreateProjectResponse
Start transformation job
Start a transformation job to fetch data from the organization and put it in a project, or transform into new data.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
organization_create_project_request: edgeimpulse_api.models.organization_create_project_request.OrganizationCreateProjectRequest
**kwargs
Return
edgeimpulse_api.models.organization_create_project_response.OrganizationCreateProjectResponse
Retry transformation file
Retry a transformation action on a file from a transformation job. Only files that have failed can be retried.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
create_project_file_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job file ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Retry failed transform jobs
Retry all failed transform job from a transformation job. Only jobs that have failed will be retried.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Retry transformation upload job
Retry the upload job from a transformation job. Only jobs that have failed can be retried.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update transformation job
Update the properties of a transformation job.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
update_organization_create_project_request: edgeimpulse_api.models.update_organization_create_project_request.UpdateOrganizationCreateProjectRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Upload a custom block
Upload a zip file containing a custom transformation or deployment block.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
tar: pydantic.types.StrictStr
type: pydantic.types.StrictStr
block_id: pydantic.types.StrictInt
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Parameters
api_client=None
Add a storage bucket
Add a storage bucket.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
add_organization_bucket_request: edgeimpulse_api.models.add_organization_bucket_request.AddOrganizationBucketRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Add files
Add a new file to an existing data item.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Data ID', extra={})]
files: List[pydantic.types.StrictBytes]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Add data items from bucket
Bulk adds data items that already exist in a storage bucket. The bucket path specified should contain folders. Each folder is added as a data item in Edge Impulse.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
organization_add_data_folder_request: edgeimpulse_api.models.organization_add_data_folder_request.OrganizationAddDataFolderRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Add new data
Add a new data item. You can add a maximum of 10000 files directly through this API. Use addOrganizationDataFile
to add additional files.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
name: pydantic.types.StrictStr
dataset: pydantic.types.StrictStr
metadata: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Key-value pair of metadata (in JSON format)', extra={})]
files: List[pydantic.types.StrictBytes]
bucket_id: Optional[pydantic.types.StrictInt] = None
bucket_name: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Name of the bucket name (as an Edge Impulse name)', extra={})] = None
bucket_path: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Optional path in the bucket to create this data item (files are created under this path).', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Add dataset
Add a new research dataset
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
organization_add_dataset_request: edgeimpulse_api.models.organization_add_dataset_request.OrganizationAddDatasetRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Change dataset
Change the dataset for selected data items.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_ids: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Data IDs as an Array', extra={})]
set_organization_data_dataset_request: edgeimpulse_api.models.set_organization_data_dataset_request.SetOrganizationDataDatasetRequest
dataset: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Selected dataset', extra={})] = None
filter: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).", extra={})] = None
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Clear checklist for data
Clear all checklist flags for selected data items.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_ids: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Data IDs as an Array', extra={})]
dataset: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Selected dataset', extra={})] = None
filter: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).", extra={})] = None
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Create pre-signed S3 upload link
Creates a signed link to securely upload data to s3 bucket directly from the client.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
create_signed_upload_link_request: edgeimpulse_api.models.create_signed_upload_link_request.CreateSignedUploadLinkRequest
**kwargs
Return
edgeimpulse_api.models.create_signed_upload_link_response.CreateSignedUploadLinkResponse
Delete file from dataset
Delete a file from a dataset
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
delete_portal_file_request: edgeimpulse_api.models.delete_portal_file_request.DeletePortalFileRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete file
Delete a single file from a data item.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Data ID', extra={})]
file_name: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='File name', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete data
Delete a data item. This will remove items the items from the underlying storage if your dataset has "bucketPath" set.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Data ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete data
Delete all data for selected data items. This removes all data in the underlying data bucket.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_ids: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Data IDs as an Array', extra={})]
dataset: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Selected dataset', extra={})] = None
filter: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).", extra={})] = None
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Delete projects data
Delete data samples from organizational projects.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Unique identifier of the organizational project from where data samples will be fetched.', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Download file from dataset
Download a file from a dataset. Will return a signed URL to the bucket.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
download_portal_file_request: edgeimpulse_api.models.download_portal_file_request.DownloadPortalFileRequest
**kwargs
Return
edgeimpulse_api.models.download_portal_file_response.DownloadPortalFileResponse
Download folder from dataset
Download all files in the given folder in a dataset, ignoring any subdirectories.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
path: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Path, relative to dataset', extra={})]
**kwargs
Return
str
Download file
Download a single file from a data item.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Data ID', extra={})]
file_name: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='File name', extra={})]
**kwargs
Return
str
Download data
Download all data for selected data items. This function does not query the underlying bucket.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_ids: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Data IDs as an Array', extra={})]
dataset: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Selected dataset', extra={})] = None
filter: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).", extra={})] = None
**kwargs
Return
str
Download data
Download all selected project data items.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Unique identifier of the organizational project from where data samples will be fetched.', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
**kwargs
Return
str
Download data
Download all data for this data item.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Data ID', extra={})]
filter: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).", extra={})] = None
**kwargs
Return
str
Get storage bucket
Get storage bucket details.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
bucket_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Bucket ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_bucket_response.GetOrganizationBucketResponse
Get data metadata
Get a data item. This will HEAD the underlying bucket to retrieve the last file information.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Data ID', extra={})]
filter: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).", extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_organization_data_item_response.GetOrganizationDataItemResponse
Get transformation jobs for data item
Get all transformation jobs that ran for a data item. If limit / offset is not provided then max. 20 results are returned.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Data ID', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_organization_data_item_transform_jobs_response.GetOrganizationDataItemTransformJobsResponse
Get dataset
Get information about a dataset
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_dataset_response.GetOrganizationDatasetResponse
Get projects data count
Get the number of samples for all or for a specific organization project.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Unique identifier of the organizational project from where data samples will be fetched.', extra={})] = None
filter: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Data filter in SQL WHERE format, where you can reference 'filename', 'label', 'project_name', 'category', 'sensors', 'frequency', and any metadata through 'metadata->' (dots are replaced by underscore).", extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_organization_projects_data_count_response.GetOrganizationProjectsDataCountResponse
Hide dataset
Hide a dataset (does not remove underlying data)
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
List files in dataset
List all files and directories in specified prefix.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
list_portal_files_in_folder_request: edgeimpulse_api.models.list_portal_files_in_folder_request.ListPortalFilesInFolderRequest
**kwargs
Return
edgeimpulse_api.models.list_portal_files_in_folder_response.ListPortalFilesInFolderResponse
List storage buckets
Retrieve all configured storage buckets. This does not list the secret key.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_organization_buckets_response.ListOrganizationBucketsResponse
List data
Lists all data items. This can be filtered by the ?filter parameter.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Selected dataset', extra={})] = None
filter: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).", extra={})] = None
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_organization_data_response.ListOrganizationDataResponse
List files
Lists all files included by the filter.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Selected dataset', extra={})] = None
filter: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).", extra={})] = None
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_organization_files_response.ListOrganizationFilesResponse
Get projects data
Retrieve all the data samples from organizational projects.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Unique identifier of the organizational project from where data samples will be fetched.', extra={})] = None
filter: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description="Data filter in SQL WHERE format, where you can reference 'filename', 'label', 'project_name', 'category', 'sensors', 'frequency', and any metadata through 'metadata->' (dots are replaced by underscore).", extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_organization_projects_data_response.ListOrganizationProjectsDataResponse
Bulk update metadata
Bulk update the metadata of many data items in one go. This requires you to submit a CSV file with headers, one of which the columns should be named 'name'. The other columns are used as metadata keys.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: pydantic.types.StrictStr
csv_file: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Batch disable data
Batch disable project data samples by dataId
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
organization_projects_data_batch_request: edgeimpulse_api.models.organization_projects_data_batch_request.OrganizationProjectsDataBatchRequest
**kwargs
Return
edgeimpulse_api.models.organization_projects_data_batch_disable_response.OrganizationProjectsDataBatchDisableResponse
Batch enable data
Batch enable project data samples by dataId
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
organization_projects_data_batch_request: edgeimpulse_api.models.organization_projects_data_batch_request.OrganizationProjectsDataBatchRequest
**kwargs
Return
edgeimpulse_api.models.organization_projects_data_batch_enable_response.OrganizationProjectsDataBatchEnableResponse
Bulk update metadata
Bulk update the metadata of many raw data items in one go. This requires you to submit a CSV file with headers, one of which the columns should be named 'name'. The other columns are used as metadata keys.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
csv_file: pydantic.types.StrictStr
project_ids: Optional[List[pydantic.types.StrictInt]] = None
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Preview files in a default dataset
Preview files and directories in a default dataset for the given prefix, with support for wildcards. This is an internal API used when starting a transformation job.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
preview_default_files_in_folder_request: edgeimpulse_api.models.preview_default_files_in_folder_request.PreviewDefaultFilesInFolderRequest
**kwargs
Return
edgeimpulse_api.models.preview_default_files_in_folder_response.PreviewDefaultFilesInFolderResponse
Preview file
Preview a single file from a data item (same as downloadOrganizationDataFile but w/ content-disposition inline and could be truncated).
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Data ID', extra={})]
file_name: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='File name', extra={})]
**kwargs
Return
str
Refresh data
Update all data items. HEADs all underlying buckets to retrieve the last file information. Use this API after uploading data directly to S3. If your dataset has bucketId and bucketPath set then this will also remove items that have been removed from S3.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Selected dataset', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Remove storage bucket
Remove a storage bucket. This will render any data in this storage bucket unreachable.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
bucket_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Bucket ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Rename file from dataset
Rename a file in a dataset
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
rename_portal_file_request: edgeimpulse_api.models.rename_portal_file_request.RenamePortalFileRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update storage bucket
Updates storage bucket details. This only updates fields that were set in the request body.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
bucket_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Bucket ID', extra={})]
update_organization_bucket_request: edgeimpulse_api.models.update_organization_bucket_request.UpdateOrganizationBucketRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update data metadata
Update the data item metadata.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
data_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Data ID', extra={})]
update_organization_data_item_request: edgeimpulse_api.models.update_organization_data_item_request.UpdateOrganizationDataItemRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update dataset
Set information about a dataset
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
update_organization_dataset_request: edgeimpulse_api.models.update_organization_dataset_request.UpdateOrganizationDatasetRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Verify dataset
Verify whether we can reach a dataset (and return some random files, used for data sources)
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
**kwargs
Return
edgeimpulse_api.models.verify_organization_bucket_response.VerifyOrganizationBucketResponse
Verify existing bucket connectivity
Verify whether we can reach a bucket before adding it.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
bucket_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Bucket ID', extra={})]
verify_organization_existing_bucket_request: edgeimpulse_api.models.verify_organization_existing_bucket_request.VerifyOrganizationExistingBucketRequest
**kwargs
Return
edgeimpulse_api.models.verify_organization_bucket_response.VerifyOrganizationBucketResponse
Verify bucket connectivity
Verify whether we can reach a bucket before adding it.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
verify_organization_bucket_request: edgeimpulse_api.models.verify_organization_bucket_request.VerifyOrganizationBucketRequest
**kwargs
Return
edgeimpulse_api.models.verify_organization_bucket_response.VerifyOrganizationBucketResponse
View file from dataset
View a file that's located in a dataset (requires JWT auth). File might be converted (e.g. Parquet) or truncated (e.g. CSV).
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
dataset: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Dataset name', extra={})]
path: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Path to file in portal', extra={})]
**kwargs
Return
str
Parameters
api_client=None
Create pipeline
Create an organizational pipelines
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
organization_update_pipeline_body: edgeimpulse_api.models.organization_update_pipeline_body.OrganizationUpdatePipelineBody
**kwargs
Return
edgeimpulse_api.models.create_pipeline_response.CreatePipelineResponse
Delete pipeline
Delete an organizational pipelines
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
pipeline_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get pipeline
Retrieve an organizational pipelines
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
pipeline_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_pipelines_response.GetOrganizationPipelinesResponse
List archived pipelines
Retrieve all archived organizational pipelines
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='If set, filters on pipelines which are attached to this project.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_organization_pipelines_response.ListOrganizationPipelinesResponse
List pipelines
Retrieve all organizational pipelines
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='If set, filters on pipelines which are attached to this project.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_organization_pipelines_response.ListOrganizationPipelinesResponse
Run pipeline
Run an organizational pipeline
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
pipeline_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})]
ignore_last_successful_run: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='If set then EI_LAST_SUCCESSFUL_RUN
is not set. You can use this to re-run a pipeline from scratch.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.run_organization_pipeline_response.RunOrganizationPipelineResponse
Stop a running pipeline
Stops the pipeline, and marks it as failed.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
pipeline_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update pipeline
Update an organizational pipelines
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
pipeline_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Pipeline ID', extra={})]
organization_update_pipeline_body: edgeimpulse_api.models.organization_update_pipeline_body.OrganizationUpdatePipelineBody
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Create upload portal
Creates a new upload portal for the organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_organization_portal_request: edgeimpulse_api.models.create_organization_portal_request.CreateOrganizationPortalRequest
**kwargs
Return
edgeimpulse_api.models.create_organization_portal_response.CreateOrganizationPortalResponse
Delete upload portal
Deletes an upload portal for the organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Retrieve upload portal information
Retrieve a single upload portals identified by ID.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_portal_response.GetOrganizationPortalResponse
List upload portals
Retrieve all configured upload portals.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_organization_portals_response.ListOrganizationPortalsResponse
Rotate upload portal token
Rotates the token for an upload portal.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update upload portal
Updates an upload portal for the organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
create_organization_portal_request: edgeimpulse_api.models.create_organization_portal_request.CreateOrganizationPortalRequest
**kwargs
Return
edgeimpulse_api.models.update_organization_portal_response.UpdateOrganizationPortalResponse
Verify upload portal information
Retrieve a subset of files from the portal, to be used in the data source wizard.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.verify_organization_bucket_response.VerifyOrganizationBucketResponse
Parameters
api_client=None
Add API key
Add an API key.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
add_organization_api_key_request: edgeimpulse_api.models.add_organization_api_key_request.AddOrganizationApiKeyRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Add member
Add a member to an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
add_member_request: edgeimpulse_api.models.add_member_request.AddMemberRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Create new organization
Create a new organization. This is an internal API.
Parameters
self
create_organization_request: edgeimpulse_api.models.create_organization_request.CreateOrganizationRequest
**kwargs
Return
edgeimpulse_api.models.create_organization_response.CreateOrganizationResponse
Remove organization
Remove the current organization, and all data associated with it. This is irrevocable!
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Download organization data export
Download a data export for an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
export_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})]
**kwargs
Return
None
Get organization data export
Get a data export for an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
export_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_data_export_response.GetOrganizationDataExportResponse
Get all organization data exports
Get all data exports for an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_organization_data_exports_response.GetOrganizationDataExportsResponse
Organization information
List all information about this organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.organization_info_response.OrganizationInfoResponse
Organization metrics
Get general metrics for this organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
exclude_edge_impulse_users: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude Edge Impulse users when counting enterprise entitlements usage', extra={})] = None
project_visibility: typing_extensions.Annotated[Optional[edgeimpulse_api.models.project_visibility.ProjectVisibility], FieldInfo(default=PydanticUndefined, description='What project visibility type to include when counting enterprise entitlements usage', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.organization_metrics_response.OrganizationMetricsResponse
Invite member
Invite a member to an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
invite_organization_member_request: edgeimpulse_api.models.invite_organization_member_request.InviteOrganizationMemberRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get API keys
Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes).
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_organization_api_keys_response.ListOrganizationApiKeysResponse
Get projects
Retrieve all projects for the organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_projects_response.ListProjectsResponse
List active organizations
Retrieve list of organizations that a user is a part of. If authenticating using JWT token this lists all the organizations the user has access to, if authenticating using an API key, this only lists that organization.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.list_organizations_response.ListOrganizationsResponse
Remove member
Remove a member from an organization. Note that you cannot invoke this function if only a single member is present to the organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
remove_member_request: edgeimpulse_api.models.remove_member_request.RemoveMemberRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Request trial extension
Request an extension for an enterprise trial.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
enterprise_upgrade_or_trial_extension_request: edgeimpulse_api.models.enterprise_upgrade_or_trial_extension_request.EnterpriseUpgradeOrTrialExtensionRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Resend invitation
Resend an invitation to a member in an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
member_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Revoke API key
Revoke an API key.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
api_key_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='API key ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Set member datasets
Set the datasets a guest member has access to in an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
member_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})]
set_member_datasets_request: edgeimpulse_api.models.set_member_datasets_request.SetMemberDatasetsRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Set member role
Change the role of a member in an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
member_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})]
set_member_role_request: edgeimpulse_api.models.set_member_role_request.SetMemberRoleRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Admin endpoint
Test endpoint that can only be reached with admin rights.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update organization
Update organization properties such as name and logo.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_organization_request: edgeimpulse_api.models.update_organization_request.UpdateOrganizationRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Upload organization header image
Uploads and updates the organization header image
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
image: Optional[pydantic.types.StrictStr] = None
**kwargs
Return
edgeimpulse_api.models.upload_asset_response.UploadAssetResponse
Upload organization logo
Uploads and updates the organization logo
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
image: Optional[pydantic.types.StrictStr] = None
**kwargs
Return
edgeimpulse_api.models.upload_asset_response.UploadAssetResponse
Upload image for readme
Uploads an image to the user CDN and returns the path.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
image: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.upload_readme_image_response.UploadReadmeImageResponse
White Label Admin - Add a development board to a whitelabel
White label admin only API to add a development board.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
development_board_request: Optional[edgeimpulse_api.models.development_board_request.DevelopmentBoardRequest] = None
**kwargs
Return
edgeimpulse_api.models.development_board_created_response.DevelopmentBoardCreatedResponse
White Label Admin - Add organization API key
White label admin only API to add an API key to an organization. Add a temporary API key that can be used to make Organizations API (/api/organizations/{organizationId}/) requests on behalf of the organization. These API keys are not visible to the organization itself and have a customizable TTL defaulting to 1 minute.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
admin_add_organization_api_key_request: edgeimpulse_api.models.admin_add_organization_api_key_request.AdminAddOrganizationApiKeyRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Add Project API key
White label admin only API to add an API key to a project. Add a temporary API key that can be used to make Projects API (/api/projects/{projectId}/) requests on behalf of the project admin. These API keys are not visible to the project itself and have a customizable TTL defaulting to 1 minute.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
admin_add_project_api_key_request: edgeimpulse_api.models.admin_add_project_api_key_request.AdminAddProjectApiKeyRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Add user to an organization
White label admin only API to add a user to an organization. If no user is provided, the current user is used.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
admin_add_organization_user_request: Optional[edgeimpulse_api.models.admin_add_organization_user_request.AdminAddOrganizationUserRequest] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Add user to a project
White label admin only API to add a user to a project. If no user is provided, the current user is used.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
admin_add_project_user_request: Optional[edgeimpulse_api.models.admin_add_project_user_request.AdminAddProjectUserRequest] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Create new organization within white label context
Create a new organization. This is an API only available to white label admins
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
whitelabel_admin_create_organization_request: edgeimpulse_api.models.whitelabel_admin_create_organization_request.WhitelabelAdminCreateOrganizationRequest
**kwargs
Return
edgeimpulse_api.models.create_organization_response.CreateOrganizationResponse
White Label Admin - Create a new organization data export
Create a new data export for an organization. A job is created to process the export request and the job details are returned in the response. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
admin_create_organization_data_export_request: edgeimpulse_api.models.admin_create_organization_data_export_request.AdminCreateOrganizationDataExportRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
White Label Admin - Create a new organization project
White label admin only API to create a new project for an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
admin_create_project_request: edgeimpulse_api.models.admin_create_project_request.AdminCreateProjectRequest
**kwargs
Return
edgeimpulse_api.models.create_project_response.CreateProjectResponse
White Label Admin - Creates a new usage report
Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
start_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})]
end_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})]
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
White Label Admin - Create a new project within white label context.
Create a new free tier project. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
admin_create_project_request: edgeimpulse_api.models.admin_create_project_request.AdminCreateProjectRequest
**kwargs
Return
edgeimpulse_api.models.create_project_response.CreateProjectResponse
White Label Admin - Delete an organization
White label admin only API to delete an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Delete organization data export
Delete a data export for an organization. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
export_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Delete usage report
Delete a usage report for an organization. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
usage_report_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Usage report ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Delete a project
White label admin only API to delete a project.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete a user
White label admin only API to delete a user.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Download usage report
Download a usage report for an organization. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
usage_report_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Usage report ID', extra={})]
**kwargs
Return
None
White Label Admin - Get white label information
White label admin only API to get the white label information.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_whitelabel_response.GetWhitelabelResponse
White Label Admin - Get global white label metrics
White label admin only API to get global metrics.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.admin_get_metrics_response.AdminGetMetricsResponse
White Label Admin - Get organization compute time usage
Get compute time usage for an organization over a period of time. This is an API only available to white label admins
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
start_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})]
end_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})]
**kwargs
Return
edgeimpulse_api.models.admin_get_organization_compute_time_usage_response.AdminGetOrganizationComputeTimeUsageResponse
White Label Admin - Get organization data export
Get a data export for an organization. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
export_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_organization_data_export_response.GetOrganizationDataExportResponse
White Label Admin - Get all organization data exports
Get all data exports for an organization. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_organization_data_exports_response.GetOrganizationDataExportsResponse
White Label Admin - Get organization information
White label admin only API to list all information about an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
include_deleted: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include deleted entities (users, projects, orgs)', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.admin_organization_info_response.AdminOrganizationInfoResponse
White Label Admin - Get usage report
Get a usage report for an organization. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
usage_report_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Usage report ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.admin_get_organization_usage_report_response.AdminGetOrganizationUsageReportResponse
White Label Admin - Get all usage reports
Get all usage reports for an organization. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.admin_get_organization_usage_reports_response.AdminGetOrganizationUsageReportsResponse
White Label Admin - Get all organizations within a white label
White label admin only API to get the list of all organizations.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
active: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None
include_deleted: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include deleted entities (users, projects, orgs)', extra={})] = None
sort: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.admin_get_organizations_response.AdminGetOrganizationsResponse
White Label Admin - Get a white label project
White label admin only API to get project information.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.project_info_response.ProjectInfoResponse
White Label Admin - Get all white label projects
White label admin only API to get the list of all projects.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
active: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None
sort: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.admin_list_projects_response.AdminListProjectsResponse
White Label Admin - Get a white label user
White label admin only API to get information about a user.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.admin_get_user_response.AdminGetUserResponse
White Label Admin - Get white label user metrics
White label admin only API to get marketing metrics about a user.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.admin_get_user_metrics_response.AdminGetUserMetricsResponse
White Label Admin - Get all white label users
White label admin only API to get the list of all registered users.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
active: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None
tier: typing_extensions.Annotated[Optional[edgeimpulse_api.models.user_tier_enum.UserTierEnum], FieldInfo(default=PydanticUndefined, description='Whether to search for free, community plus, professional, or enterprise entities (users, projects)', extra={})] = None
fields: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Comma separated list of fields to fetch in a query', extra={})] = None
sort: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.admin_get_users_response.AdminGetUsersResponse
White Label Admin - Remove a development board from a whitelabel
White label admin only API to remove a development board.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
development_board_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Development board ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Remove user from an organization
White label admin only API to remove a user from an organization.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Remove user from a project
White label admin only API to remove a user from a project.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Restore an organization
White label admin only API to restore a deleted organization. All organization projects sharing the same deletion date as that of the organization will also be restored. If this is a trial organization that was never upgraded to a paid plan then the organization will be restored to its original trial state.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update default deployment target
White label admin only API to update the default deployment target for this white label.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_whitelabel_default_deployment_target_request: edgeimpulse_api.models.update_whitelabel_default_deployment_target_request.UpdateWhitelabelDefaultDeploymentTargetRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update the order of deployment options in the deployment view
White label admin only API to customize the order of deployment options in the deployment view for this white label.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_whitelabel_deployment_options_order_request: edgeimpulse_api.models.update_whitelabel_deployment_options_order_request.UpdateWhitelabelDeploymentOptionsOrderRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update deployment targets
White label admin only API to update some or all of the deployment targets enabled for this white label.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_whitelabel_deployment_targets_request: edgeimpulse_api.models.update_whitelabel_deployment_targets_request.UpdateWhitelabelDeploymentTargetsRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update a development board in a whitelabel
White label admin only API to update a development board.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
development_board_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Development board ID.', extra={})]
development_board_request_update: Optional[edgeimpulse_api.models.development_board_request_update.DevelopmentBoardRequestUpdate] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update the image of a whitelabel development board
White label admin only API to update the image of a development board.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
development_board_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Development board ID.', extra={})]
image: Optional[pydantic.types.StrictStr] = None
**kwargs
Return
edgeimpulse_api.models.upload_asset_response.UploadAssetResponse
White Label Admin - Update white label information
White label admin only API to update the white label information.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_whitelabel_request: edgeimpulse_api.models.update_whitelabel_request.UpdateWhitelabelRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update learning blocks
White label admin only API to update some or all of the learning blocks enabled for this white label.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_whitelabel_learning_blocks_request: edgeimpulse_api.models.update_whitelabel_learning_blocks_request.UpdateWhitelabelLearningBlocksRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update organization
White label admin only API to update organization properties such as name and logo.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
admin_update_organization_request: edgeimpulse_api.models.admin_update_organization_request.AdminUpdateOrganizationRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update organization data export
Update a data export for an organization. This is an API only available to white label admins.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]
export_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})]
admin_update_organization_data_export_request: edgeimpulse_api.models.admin_update_organization_data_export_request.AdminUpdateOrganizationDataExportRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update white label project
White label admin only API to update project properties.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
update_project_request: edgeimpulse_api.models.update_project_request.UpdateProjectRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update theme colors
White label admin only API to update some or all theme colors.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_theme_colors_request: edgeimpulse_api.models.update_theme_colors_request.UpdateThemeColorsRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update theme device logo
White label admin only API to update the white label theme device logo.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
image: Optional[pydantic.types.StrictStr] = None
**kwargs
Return
edgeimpulse_api.models.upload_asset_response.UploadAssetResponse
White Label Admin - Update theme favicon
White label admin only API to update the theme favicon.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
image: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
White Label Admin - Update theme logo
White label admin only API to update the white label theme logo.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
image: Optional[pydantic.types.StrictStr] = None
**kwargs
Return
edgeimpulse_api.models.upload_asset_response.UploadAssetResponse
White Label Admin - Update white label user
White label admin only API to update user properties.
Parameters
self
organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
admin_update_user_request: edgeimpulse_api.models.admin_update_user_request.AdminUpdateUserRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Clear Performance Calibration state
Deletes all state related to performance calibration (used in tests for example).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Clear performance calibration parameters
Clears the current performance calibration parameters
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get ground truth
Get performance calibration ground truth data
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_performance_calibration_ground_truth_response.GetPerformanceCalibrationGroundTruthResponse
Get parameter sets
Get performance calibration parameter sets
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_performance_calibration_parameter_sets_response.GetPerformanceCalibrationParameterSetsResponse
Get raw result
Get performance calibration raw result
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_performance_calibration_raw_result_response.GetPerformanceCalibrationRawResultResponse
Get parameters
Get performance calibration stored parameters
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_performance_calibration_parameters_response.GetPerformanceCalibrationParametersResponse
Get status
Get performance calibration status
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_performance_calibration_status_response.GetPerformanceCalibrationStatusResponse
Get WAV file
Get the synthetic sample as a WAV file
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
str
Save performance calibration parameters
Set the current performance calibration parameters
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
performance_calibration_save_parameter_set_request: edgeimpulse_api.models.performance_calibration_save_parameter_set_request.PerformanceCalibrationSaveParameterSetRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Upload Performance Calibration Audio files
Upload a zip files with a wav file and its Label metadata to run performance calibration on it.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
zip: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.performance_calibration_upload_labeled_audio_response.PerformanceCalibrationUploadLabeledAudioResponse
Parameters
api_client=None
Add collaborator
Add a collaborator to a project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
add_collaborator_request: edgeimpulse_api.models.add_collaborator_request.AddCollaboratorRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Add API key
Add an API key. If you set developmentKey
to true
this flag will be removed from the current development API key.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
add_project_api_key_request: edgeimpulse_api.models.add_project_api_key_request.AddProjectApiKeyRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Add HMAC key
Add an HMAC key. If you set developmentKey
to true
this flag will be removed from the current development HMAC key.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
add_hmac_key_request: edgeimpulse_api.models.add_hmac_key_request.AddHmacKeyRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Create new project
Create a new project. This API can only be called using a JWT token.
Parameters
self
create_project_request: edgeimpulse_api.models.create_project_request.CreateProjectRequest
**kwargs
Return
edgeimpulse_api.models.create_project_response.CreateProjectResponse
Remove project
Remove the current project, and all data associated with it. This is irrevocable!
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete versions
Delete a version. This does not delete the version from cold storage.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
version_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Download CSV Wizard config
Returns a JSON file with the current CSV wizard config. If there is no config this will throw a 5xx error.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
str
Download CSV Wizard uploaded file
Returns the file that was uploaded when the CSV wizard was configured. If there is no config this will throw a 5xx error.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
str
Get CSV Wizard uploaded file info
Returns whether the file that was uploaded when the CSV wizard was configured is available.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_csv_wizard_uploaded_file_info.GetCsvWizardUploadedFileInfo
Get a list of all model variants available for this project
Get a list of model variants applicable to all trained learn blocks in this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_model_variants_response.GetModelVariantsResponse
Get notes
Get all notes in project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_notes_response.GetNotesResponse
Get data axes summary
Get a list of axes that are present in the training data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include disabled samples. Defaults to true', extra={})] = None
include_not_processed: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include non-processed samples. Defaults to true', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.project_data_axes_summary_response.ProjectDataAxesSummaryResponse
Project information
List all information about this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.project_info_response.ProjectInfoResponse
Public project information
List a summary about this project - available for public projects.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.project_info_summary_response.ProjectInfoSummaryResponse
Last modification
Get the last modification date for a project (will be upped when data is modified, or when an impulse is trained)
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.last_modification_date_response.LastModificationDateResponse
Get the interval (in ms) of the training data
Get the interval of the training data; if multiple intervals are present, the interval of the longest data item is returned.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.project_data_interval_response.ProjectDataIntervalResponse
Get data summary
Get summary of all data present in the training set. This returns the number of data items, the total length of all data, and the labels. This is similar to dataSummary
in ProjectInfoResponse
but allows you to exclude disabled items or items that are still processing.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include disabled samples. Defaults to true', extra={})] = None
include_not_processed: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include non-processed samples. Defaults to true', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.project_training_data_summary_response.ProjectTrainingDataSummaryResponse
Get socket token
Get a token to authenticate with the web socket interface.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.socket_token_response.SocketTokenResponse
Get target constraints
Retrieve target constraints for a project. The constraints object captures hardware attributes of your target device, along with an application budget to allow guidance on performance and resource usage
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_target_constraints_response.GetTargetConstraintsResponse
Launch getting started wizard
This clears out all data in your project, and is irrevocable. This function is only available through a JWT token, and is not available to all users.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Development boards
List all development boards for a project
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.development_boards_response.DevelopmentBoardsResponse
Get development keys
Retrieve the development API and HMAC keys for a project. These keys are specifically marked to be used during development. These keys can be undefined
if no development keys are set.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.development_keys_response.DevelopmentKeysResponse
Get downloads
Retrieve the downloads for a project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.project_downloads_response.ProjectDownloadsResponse
List emails
Get a list of all emails sent by Edge Impulse regarding this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_email_response.ListEmailResponse
Get API keys
Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes). The development key will be returned in full, as it'll be set in devices and is thus not private.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_api_keys_response.ListApiKeysResponse
Get HMAC keys
Retrieve all HMAC keys.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_hmac_keys_response.ListHmacKeysResponse
List active projects
Retrieve list of active projects. If authenticating using JWT token this lists all the projects the user has access to, if authenticating using an API key, this only lists that project.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.list_projects_response.ListProjectsResponse
List public projects
Retrieve the list of all public projects. You don't need any authentication for this method.
Parameters
self
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
project: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include projects that contain this string', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_public_projects_response.ListPublicProjectsResponse
List public versions
Get all public versions for this project. You don't need any authentication for this function.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_public_versions_response.ListPublicVersionsResponse
List versions
Get all versions for this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_versions_response.ListVersionsResponse
Make version private
Make a public version private.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
version_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Dismiss a notification
Dismiss a notification
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
project_dismiss_notification_request: edgeimpulse_api.models.project_dismiss_notification_request.ProjectDismissNotificationRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Remove collaborator
Remove a collaborator to a project. Note that you cannot invoke this function if only a single collaborator is present.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
remove_collaborator_request: edgeimpulse_api.models.remove_collaborator_request.RemoveCollaboratorRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Revoke API key
Revoke an API key. Note that if you revoke the development API key some services (such as automatic provisioning of devices through the serial daemon) will no longer work.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
api_key_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='API key ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Remove HMAC key
Revoke an HMAC key. Note that if you revoke the development key some services (such as automatic provisioning of devices through the serial daemon) will no longer work.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
hmac_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Hmac key ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Set compute time limit
Change the job compute time limit for the project. This function is only available through a JWT token, and is not available to all users.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
set_project_compute_time_request: edgeimpulse_api.models.set_project_compute_time_request.SetProjectComputeTimeRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Set DSP file size limit
Change the DSP file size limit for the project. This function is only available through a JWT token, and is not available to all users.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
set_project_dsp_file_size_request: edgeimpulse_api.models.set_project_dsp_file_size_request.SetProjectDspFileSizeRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Set target constraints
Set target constraints for a project. Use the constraints object to capture hardware attributes of your target device, along with an application budget to allow guidance on performance and resource usage
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
target_constraints: edgeimpulse_api.models.target_constraints.TargetConstraints
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Transfer ownership (user)
Transfer ownership of a project to another user.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
add_collaborator_request: edgeimpulse_api.models.add_collaborator_request.AddCollaboratorRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Transfer ownership (organization)
Transfer ownership of a project to another organization.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
transfer_ownership_organization_request: edgeimpulse_api.models.transfer_ownership_organization_request.TransferOwnershipOrganizationRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update project
Update project properties such as name and logo.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
update_project_request: edgeimpulse_api.models.update_project_request.UpdateProjectRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update tags
Update the list of project tags.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
update_project_tags_request: edgeimpulse_api.models.update_project_tags_request.UpdateProjectTagsRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update version
Updates a version, this only updates fields that were set in the body.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
version_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})]
update_version_request: edgeimpulse_api.models.update_version_request.UpdateVersionRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Store CSV Wizard uploaded file
Asynchronously called in the CSV Wizard to store the file that the CSV wizard was based on.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
file: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Upload image for readme
Uploads an image to the user CDN and returns the path.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
image: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.upload_readme_image_response.UploadReadmeImageResponse
Parameters
api_client=None
Remove multiple samples
Deletes samples. Note that this does not delete the data from cold storage.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Disable multiple samples
Disables samples, ensuring that they are excluded from the dataset.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Edit labels for multiple samples
Sets the label (also known as class) of multiple samples.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
edit_sample_label_request: edgeimpulse_api.models.edit_sample_label_request.EditSampleLabelRequest
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Enable multiple samples
Enables samples, ensuring that they are not excluded from the dataset.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Move multiple samples
Move multiple samples to another category (e.g. from test to training).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
move_raw_data_request: edgeimpulse_api.models.move_raw_data_request.MoveRawDataRequest
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Auto-label an image
Classify an image using another neural network.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
object_detection_auto_label_request: edgeimpulse_api.models.object_detection_auto_label_request.ObjectDetectionAutoLabelRequest
**kwargs
Return
edgeimpulse_api.models.object_detection_auto_label_response.ObjectDetectionAutoLabelResponse
Clear all object detection labels
Clears all object detection labels for this dataset, and places all images back in the labeling queue.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Clear data explorer
Remove the current data explorer state
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Count samples
Count all raw data by category.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.count_samples_response.CountSamplesResponse
Crop sample
Crop a sample to within a new range.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
crop_sample_request: edgeimpulse_api.models.crop_sample_request.CropSampleRequest
**kwargs
Return
edgeimpulse_api.models.crop_sample_response.CropSampleResponse
Remove all samples
Deletes all samples for this project over all categories. This also invalidates all DSP and learn blocks. Note that this does not delete the data from cold storage.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Remove all samples by category
Deletes all samples for this project over a single category. Note that this does not delete the data from cold storage.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Remove sample
Deletes the sample. Note that this does not delete the data from cold storage.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Disable sample
Disable a sample, ensuring that it is excluded from the dataset.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Edit label
Sets the label (also known as class) of the sample. Use the same label for similar types of data, as they are used during training.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
edit_sample_label_request: edgeimpulse_api.models.edit_sample_label_request.EditSampleLabelRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Enable sample
Enable a sample, ensuring that it is not excluded from the dataset.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Find segments
Find start and end times for all non-noise events in a sample
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
find_segment_sample_request: edgeimpulse_api.models.find_segment_sample_request.FindSegmentSampleRequest
**kwargs
Return
edgeimpulse_api.models.find_segment_sample_response.FindSegmentSampleResponse
List data with "imported from" metadata key
Lists all data with an 'imported from' metadata key. Used to check in a data source which items are already in a project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_all_imported_from_response.GetAllImportedFromResponse
Get auto-labeler results
Retrieve the results of the auto-labeler (after running StartJobResponse
)
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_auto_labeler_response.GetAutoLabelerResponse
Get auto-labeler image
Grab a segment image from the auto-labeler
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
image: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which image to receive from the auto-labeler', extra={})]
**kwargs
Return
str
View auto-labeler segment info
Get info from a specific segment in an image. Pass in both sampleId and segmentId in the URL.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_auto_labeler_segment_info_response.GetAutoLabelerSegmentInfoResponse
Get data explorer features
t-SNE2 output of the raw dataset
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_data_explorer_features_response.GetDataExplorerFeaturesResponse
Get data explorer predictions
Predictions for every data explorer point (only available when using current impulse to populate data explorer)
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.data_explorer_predictions_response.DataExplorerPredictionsResponse
Get data explorer settings
Get data explorer configuration, like the type of data, and the input / dsp block to use.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_data_explorer_settings_response.GetDataExplorerSettingsResponse
Get diversity metrics data
Obtain metrics that describe the similarity and diversity of a dataset. To calculate these metrics, use the calculateDataQualityMetrics
endpoint.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_diversity_data_response.GetDiversityDataResponse
Get label noise data
Obtain metrics that describe potential label noise issues in the dataset. To calculate these metrics, use the calculateDataQualityMetrics
endpoint.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_label_noise_data_response.GetLabelNoiseDataResponse
Object detection label queue
Get all unlabeled items from the object detection queue.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.object_detection_label_queue_response.ObjectDetectionLabelQueueResponse
Object detection label queue count
Get count for unlabeled items from the object detection queue.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.object_detection_label_queue_count_response.ObjectDetectionLabelQueueCountResponse
Get sample
Get a sample.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
limit_payload_values: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None
cache_key: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_sample_response.GetSampleResponse
Get WAV file
Get a sample as a WAV file. This only applies to samples with an audio axis.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
axis_ix: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Axis index', extra={})]
slice_start: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Begin index of the slice. If not given, the whole sample is used.', extra={})] = None
slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the whole sample is used.', extra={})] = None
cache_key: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None
**kwargs
Return
str
Get image file
Get a sample as an image file. This only applies to samples with RGBA data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
after_input_block: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to process the image through the input block first', extra={})] = None
cache_key: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None
**kwargs
Return
str
Download file
Download a sample in it's original format as uploaded to the ingestion service.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
str
Get video file
Get a sample as an video file. This only applies to samples with video data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
after_input_block: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to process the image through the input block first', extra={})] = None
cache_key: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None
**kwargs
Return
str
Get project sample metadata
Get metadata for all samples in a project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_sample_metadata_response.GetSampleMetadataResponse
Get sample slice
Get a slice of a sample.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})]
slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_sample_response.GetSampleResponse
Get the original downsampled data
Get the original, uncropped, downsampled data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
limit_payload_values: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None
zoom_start: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Zoom into the sample, with the focus starting at this index', extra={})] = None
zoom_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Zoom into the sample, with the focus ending at this index', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_sample_response.GetSampleResponse
Check data explorer features
t-SNE2 output of the raw dataset
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse
Check if data diversity metrics exist
Determine if data diversity metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics
endpoint.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse
Check if label noise metrics exist
Determine if label noise metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics
endpoint.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse
List samples
Retrieve all raw data by category.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
exclude_sensors: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude sensors in the response (as these can slow down requests when you have large pages).', extra={})] = None
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_samples_response.ListSamplesResponse
Move sample
Move a sample to another category (e.g. from test to training).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
move_raw_data_request: edgeimpulse_api.models.move_raw_data_request.MoveRawDataRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Move sample to labeling queue
Clears the bounding box labels and moves item back to labeling queue
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Rebalance dataset
Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.rebalance_dataset_response.RebalanceDatasetResponse
Rename sample
Sets the file name of the sample. This name does not need to be unique, but it's highly recommended to do so.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
rename_sample_request: edgeimpulse_api.models.rename_sample_request.RenameSampleRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Retry processing
If a sample failed processing, retry the processing operation.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Run auto-labeler job
Run the auto-labeler over all unlabeled data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
run_auto_labeler_request: edgeimpulse_api.models.run_auto_labeler_request.RunAutoLabelerRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Save auto-labeler clusters
Set labels for all auto-segment clusters.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
save_auto_labeler_clusters_request: edgeimpulse_api.models.save_auto_labeler_clusters_request.SaveAutoLabelerClustersRequest
**kwargs
Return
edgeimpulse_api.models.save_auto_labeler_clusters_response.SaveAutoLabelerClustersResponse
Segment sample
Slice a sample into multiple segments. The original file will be marked as deleted, but you can crop any created segment to retrieve the original file.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
segment_sample_request: edgeimpulse_api.models.segment_sample_request.SegmentSampleRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Set data explorer settings
Set data explorer configuration, like the type of data, and the input / dsp block to use.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
data_explorer_settings: edgeimpulse_api.models.data_explorer_settings.DataExplorerSettings
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Set bounding boxes
Set the bounding boxes for a sample
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
sample_bounding_boxes_request: edgeimpulse_api.models.sample_bounding_boxes_request.SampleBoundingBoxesRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Set sample metadata
Adds or updates the metadata associated to a sample.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
set_sample_metadata_request: edgeimpulse_api.models.set_sample_metadata_request.SetSampleMetadataRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update structured labels
Set structured labels for a sample. If a sample has structured labels the label
column is ignored, and the sample is allowed to have multiple labels. An array of { startIndex, endIndex, label } needs to be passed in with labels for the complete sample (see valuesCount
to get the upper bound). endIndex is inclusive. If you pass in an incorrect array (e.g. missing values) you'll get an error back.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
set_sample_structured_labels_request: edgeimpulse_api.models.set_sample_structured_labels_request.SetSampleStructuredLabelsRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Split sample into frames
Split a video sample into individual frames.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
split_sample_in_frames_request: edgeimpulse_api.models.split_sample_in_frames_request.SplitSampleInFramesRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Store the last segment length
When segmenting a sample into smaller segments, store the segment length to ensure uniform segment lengths.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
store_segment_length_request: edgeimpulse_api.models.store_segment_length_request.StoreSegmentLengthRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Track objects
Track objects between two samples. Source sample should have bounding boxes set.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
track_objects_request: edgeimpulse_api.models.track_objects_request.TrackObjectsRequest
**kwargs
Return
edgeimpulse_api.models.track_objects_response.TrackObjectsResponse
Upload a data explorer screenshot
Used internally (from a data pipeline) to upload a picture of the data explorer
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
image: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Delete theme by ID
Delete a theme given its unique identifier.
Parameters
self
theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get theme by ID
Get a theme given its unique identifier.
Parameters
self
theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_theme_response.GetThemeResponse
Get themes
Get all available Studio themes.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.get_themes_response.GetThemesResponse
Update theme colors
Update some or all theme colors.
Parameters
self
theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})]
update_theme_colors_request: edgeimpulse_api.models.update_theme_colors_request.UpdateThemeColorsRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update theme favicon
Update the theme favicon
Parameters
self
theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})]
image: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update theme logos
Update some or all theme logos.
Parameters
self
theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})]
update_theme_logos_request: edgeimpulse_api.models.update_theme_logos_request.UpdateThemeLogosRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Give access to project
Authorize a third party to access a project
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
auth_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Auth ID', extra={})]
next_url: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='The URL to redirect to after authorization is completed.', extra={})]
**kwargs
Return
None
Create third party auth
Create a new third party authentication partner
Parameters
self
create_third_party_auth_request: edgeimpulse_api.models.create_third_party_auth_request.CreateThirdPartyAuthRequest
**kwargs
Return
edgeimpulse_api.models.create_third_party_auth_response.CreateThirdPartyAuthResponse
Create or login a user
Login as a user as a third-party authentication provider. If the user does not exists, it's automatically created. You can only log in as users that were previously created by you.
Parameters
self
auth_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Auth ID', extra={})]
create_user_third_party_request: edgeimpulse_api.models.create_user_third_party_request.CreateUserThirdPartyRequest
**kwargs
Return
edgeimpulse_api.models.create_user_third_party_response.CreateUserThirdPartyResponse
Delete third party auth
Delete a third party authentication partner
Parameters
self
auth_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Auth ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get all third party auth
Get information about all third party authentication partners
Parameters
self
**kwargs
Return
edgeimpulse_api.models.get_all_third_party_auth_response.GetAllThirdPartyAuthResponse
Get third party auth
Get information about a third party authentication partner
Parameters
self
auth_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Auth ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_third_party_auth_response.GetThirdPartyAuthResponse
Update third party auth
Update a third party authentication partner
Parameters
self
auth_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Auth ID', extra={})]
update_third_party_auth_request: edgeimpulse_api.models.update_third_party_auth_request.UpdateThirdPartyAuthRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Create pre-signed S3 upload link
Creates a signed link to securely upload data to s3 bucket directly from the client.
Parameters
self
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
create_signed_upload_link_request: edgeimpulse_api.models.create_signed_upload_link_request.CreateSignedUploadLinkRequest
**kwargs
Return
edgeimpulse_api.models.create_signed_upload_link_response.CreateSignedUploadLinkResponse
Delete file from portal
Delete a file from an upload portal (requires JWT auth).
Parameters
self
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
delete_portal_file_request: edgeimpulse_api.models.delete_portal_file_request.DeletePortalFileRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Download file from portal
Download a file from an upload portal (requires JWT auth). Will return a signed URL to the bucket.
Parameters
self
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
download_portal_file_request: edgeimpulse_api.models.download_portal_file_request.DownloadPortalFileRequest
**kwargs
Return
edgeimpulse_api.models.download_portal_file_response.DownloadPortalFileResponse
Portal info
Get information about a portal
Parameters
self
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.portal_info_response.PortalInfoResponse
List files in portal
List all files and directories in specified prefix.
Parameters
self
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
list_portal_files_in_folder_request: edgeimpulse_api.models.list_portal_files_in_folder_request.ListPortalFilesInFolderRequest
**kwargs
Return
edgeimpulse_api.models.list_portal_files_in_folder_response.ListPortalFilesInFolderResponse
Rename file from portal
Rename a file on an upload portal (requires JWT auth).
Parameters
self
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
rename_portal_file_request: edgeimpulse_api.models.rename_portal_file_request.RenamePortalFileRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
View file from portal
View a file that's located in an upload portal (requires JWT auth). File might be converted (e.g. Parquet) or truncated (e.g. CSV).
Parameters
self
portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]
path: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Path to file in portal', extra={})]
**kwargs
Return
str
Parameters
api_client=None
Accept Terms of Service
Accept Terms of Service.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Activate current user
Activate the current user account (requires an activation code). This function is only available through a JWT token.
Parameters
self
activate_user_or_verify_email_request: edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Activate user
Activate a user account (requires an activation code). This function is only available through a JWT token.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
activate_user_or_verify_email_request: edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Activate user by third party activation code
Activate a user that was created by a third party. This function is only available through a JWT token.
Parameters
self
activate_user_by_third_party_activation_code_request: edgeimpulse_api.models.activate_user_by_third_party_activation_code_request.ActivateUserByThirdPartyActivationCodeRequest
**kwargs
Return
edgeimpulse_api.models.get_jwt_response.GetJWTResponse
Change password current user
Change the password for the current user account. This function is only available through a JWT token.
Parameters
self
change_password_request: edgeimpulse_api.models.change_password_request.ChangePasswordRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Change password
Change the password for a user account. This function is only available through a JWT token.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
change_password_request: edgeimpulse_api.models.change_password_request.ChangePasswordRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Convert current evaluation user
Convert current evaluation user account to regular account.
Parameters
self
convert_user_request: edgeimpulse_api.models.convert_user_request.ConvertUserRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Create developer profile
Create a developer profile for the current active user.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.create_developer_profile_response.CreateDeveloperProfileResponse
Create enterprise trial user
Creates an enterprise trial user and a new trial organization, and redirects the user to the new organization.
Parameters
self
create_enterprise_trial_user_request: typing_extensions.Annotated[edgeimpulse_api.models.create_enterprise_trial_user_request.CreateEnterpriseTrialUserRequest, FieldInfo(default=Ellipsis, description='Trial request', extra={})]
**kwargs
Return
edgeimpulse_api.models.create_enterprise_trial_response.CreateEnterpriseTrialResponse
Create evaluation user
Creates an evaluation user and a new project, and redirects the user to the new project.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.create_evaluation_user_response.CreateEvaluationUserResponse
Create Professional Tier user
Create a new user for the Professional Plan and a new project. Note that the Professional plan will not be enabled until the payment is successful.
Parameters
self
create_pro_tier_user_request: edgeimpulse_api.models.create_pro_tier_user_request.CreateProTierUserRequest
**kwargs
Return
edgeimpulse_api.models.create_user_response.CreateUserResponse
Create user
Create a new user and project
Parameters
self
create_user_request: edgeimpulse_api.models.create_user_request.CreateUserRequest
**kwargs
Return
edgeimpulse_api.models.create_user_response.CreateUserResponse
Delete current user
Delete a user. This function is only available through a JWT token, and can only remove the current user.
Parameters
self
delete_user_request: edgeimpulse_api.models.delete_user_request.DeleteUserRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete photo
Delete user profile photo. This function is only available through a JWT token.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete user
Delete a user. This function is only available through a JWT token, and can only remove the current user.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
delete_user_request: edgeimpulse_api.models.delete_user_request.DeleteUserRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get current user
Get information about the current user. This function is only available through a JWT token.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.get_user_response.GetUserResponse
Get user
Get information about a user. This function is only available through a JWT token.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_user_response.GetUserResponse
Get user by third party activation code
Get information about a user through an activation code. This function is only available through a JWT token.
Parameters
self
user_by_third_party_activation_request: edgeimpulse_api.models.user_by_third_party_activation_request.UserByThirdPartyActivationRequest
**kwargs
Return
edgeimpulse_api.models.get_user_response.GetUserResponse
Get user registration state
Tells whether a user is registered and whether it needs to set its password.
Parameters
self
username_or_email: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Username or email', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_user_need_to_set_password_response.GetUserNeedToSetPasswordResponse
List emails
Get a list of all emails sent by Edge Impulse to the current user. This function is only available through a JWT token, and is not available for all users.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.list_email_response.ListEmailResponse
List emails
Get a list of all emails sent by Edge Impulse to a user. This function is only available through a JWT token, and is not available for all users.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_email_response.ListEmailResponse
Get enterprise trials
Get a list of all enterprise trials for a user. This function is only available through a JWT token.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_enterprise_trials_response.ListEnterpriseTrialsResponse
Get buckets current user
List all organizational storage buckets that the current user has access to. This function is only available through a JWT token.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.list_organization_buckets_user_response.ListOrganizationBucketsUserResponse
Get buckets
List all organizational storage buckets that a user has access to. This function is only available through a JWT token.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_organization_buckets_user_response.ListOrganizationBucketsUserResponse
Get organizations
List all organizations that the current user is a member of. This function is only available through a JWT token.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.list_organizations_response.ListOrganizationsResponse
Get organizations
List all organizations for a user. This function is only available through a JWT token.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_organizations_response.ListOrganizationsResponse
Request activation code
Request a new activation code for the current user. This function is only available through a JWT token.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Request activation code
Request a new activation code. This function is only available through a JWT token.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Request reset password
Request a password reset link for a user.
Parameters
self
request_reset_password_request: edgeimpulse_api.models.request_reset_password_request.RequestResetPasswordRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Reset password
Reset the password for a user.
Parameters
self
reset_password_request: edgeimpulse_api.models.reset_password_request.ResetPasswordRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Send feedback
Send feedback to Edge Impulse or get in touch with sales.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
send_user_feedback_request: edgeimpulse_api.models.send_user_feedback_request.SendUserFeedbackRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Send upgrade request
Send an upgrade to Enterprise request to Edge Impulse.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
enterprise_upgrade_or_trial_extension_request: edgeimpulse_api.models.enterprise_upgrade_or_trial_extension_request.EnterpriseUpgradeOrTrialExtensionRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Set password for SSO user
Set the password for a new SSO user. This function is only available through an SSO access token.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
set_user_password_request: edgeimpulse_api.models.set_user_password_request.SetUserPasswordRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Start enterprise trial
Create an enterprise trial for the current user. Users can only go through a trial once.
Parameters
self
start_enterprise_trial_request: edgeimpulse_api.models.start_enterprise_trial_request.StartEnterpriseTrialRequest
**kwargs
Return
edgeimpulse_api.models.create_enterprise_trial_response.CreateEnterpriseTrialResponse
Update current user
Update user properties such as name. This function is only available through a JWT token.
Parameters
self
update_user_request: edgeimpulse_api.models.update_user_request.UpdateUserRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update user
Update user properties such as name. This function is only available through a JWT token.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
update_user_request: edgeimpulse_api.models.update_user_request.UpdateUserRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Upload photo
Upload a photo for the current user. This function is only available through a JWT token.
Parameters
self
photo: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.upload_user_photo_response.UploadUserPhotoResponse
Upload photo
Upload a photo for a user. This function is only available through a JWT token, and is not available for all users.
Parameters
self
user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]
photo: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.upload_user_photo_response.UploadUserPhotoResponse
Cancel subscription
Cancel the current subscription.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Remove TOTP MFA key
Disable MFA on this account using an TOTP token.
Parameters
self
user_delete_totp_mfa_key_request: edgeimpulse_api.models.user_delete_totp_mfa_key_request.UserDeleteTotpMfaKeyRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Dismiss a notification
Dismiss a notification
Parameters
self
user_dismiss_notification_request: edgeimpulse_api.models.user_dismiss_notification_request.UserDismissNotificationRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Generate a new TOTP MFA key
Creates a new MFA key, only allowed if the user has no MFA configured. TOTP tokens use SHA-1 algorithm.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.user_generate_new_mfa_key_response.UserGenerateNewMfaKeyResponse
Get user billable compute metrics
Get billable compute metrics for a user. This function is only available to users with an active subscription.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.user_subscription_metrics_response.UserSubscriptionMetricsResponse
Set TOTP MFA key
Enable MFA on this account using an TOTP token. First create a new key via userGenerateNewTotpMfaKey
.
Parameters
self
user_set_totp_mfa_key_request: edgeimpulse_api.models.user_set_totp_mfa_key_request.UserSetTotpMfaKeyRequest
**kwargs
Return
edgeimpulse_api.models.user_set_totp_mfa_key_response.UserSetTotpMfaKeyResponse
Undo subscription cancellation
Stop a pending cancellation. If you schedule a subscription to be canceled, and the subscription hasn't yet reached the end of the billing period, you can stop the cancellation. After a subscription has been canceled, you can't reactivate it.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Upgrade subscription
Upgrade the current subscription.
Parameters
self
upgrade_subscription_request: edgeimpulse_api.models.upgrade_subscription_request.UpgradeSubscriptionRequest
**kwargs
Return
None
Verify reset password code
Verify whether the reset password code for the user is valid.
Parameters
self
verify_reset_password_request: edgeimpulse_api.models.verify_reset_password_request.VerifyResetPasswordRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Parameters
api_client=None
Create a new white label
Create a new white label
Parameters
self
create_whitelabel_request: edgeimpulse_api.models.create_whitelabel_request.CreateWhitelabelRequest
**kwargs
Return
edgeimpulse_api.models.create_whitelabel_response.CreateWhitelabelResponse
Deletes a white label
Deletes the white label with the given id.
Parameters
self
whitelabel_identifier: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Whitelabel ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Get impulse blocks
Lists all possible DSP and ML blocks available for this white label.
Parameters
self
whitelabel_identifier: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Whitelabel ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_impulse_blocks_response.GetImpulseBlocksResponse
List the registered white labels
Retrieve the list of registered white labels.
Parameters
self
**kwargs
Return
edgeimpulse_api.models.get_all_whitelabels_response.GetAllWhitelabelsResponse
White label information
Retrieve all the information about this white label.
Parameters
self
whitelabel_identifier: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Whitelabel ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_whitelabel_response.GetWhitelabelResponse
Get white label domain
Get a white label domain given its unique identifier.
Parameters
self
whitelabel_identifier: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Whitelabel ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_whitelabel_domain_response.GetWhitelabelDomainResponse
Update deployment targets
Update some or all of the deployment targets enabled for this white label.
Parameters
self
whitelabel_identifier: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Whitelabel ID', extra={})]
update_whitelabel_deployment_targets_request: edgeimpulse_api.models.update_whitelabel_deployment_targets_request.UpdateWhitelabelDeploymentTargetsRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse