edgeimpulse_api.api.raw_data_api.list_samples(
self,
project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})],
limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
exclude_sensors: Annotated[pydantic.types.StrictBool | None, 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: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None,
filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None,
max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None,
min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None,
min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None,
max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None,
signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None,
include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None,
min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None,
max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None,
search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None,
proposed_actions_job_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.', extra={})] = None,
truncate_structured_labels: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='If true, only a slice of labels will be returned for samples with multiple labels.', extra={})] = None,
sort_by: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='If not specified, "id-desc" is used.', extra={})] = None,
data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Include only samples with a particular data type', extra={})] = None,
min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Include only samples with an ID >= this value', extra={})] = None,
max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Include only samples with an ID < this value', extra={})] = None,
metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { "no_metadata": true }. ', extra={})] = None,
min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='Only include samples that where added after the date given', extra={})] = None,
max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='Only include samples that were added before the date given', extra={})] = None,
**kwargs
) ‑> edgeimpulse_api.models.list_samples_response.ListSamplesResponse