import {z} from 'zod' export type RawDataFilterCategory = 'training' | 'testing' | 'validation' | 'post-processing' | 'all'; export type GetApiApiProjectIdRawDataArgs = {projectId: number, category: RawDataFilterCategory, limit?: number | undefined, offset?: number | undefined, excludeSensors?: boolean | undefined, labels?: string | undefined, filename?: string | undefined, maxLength?: number | undefined, minLength?: number | undefined, minFrequency?: number | undefined, maxFrequency?: number | undefined, signatureValidity?: ('both' | 'valid' | 'invalid') | undefined, includeDisabled?: ('both' | 'enabled' | 'disabled') | undefined, minLabel?: number | undefined, maxLabel?: number | undefined, search?: string | undefined, proposedActionsJobId?: number | undefined, truncateStructuredLabels?: boolean | undefined, sortBy?: ('id-desc' | 'random') | undefined, dataType?: ('audio' | 'image') | undefined, minId?: number | undefined, maxId?: number | undefined, metadata?: string | undefined, minDate?: string | undefined, maxDate?: string | undefined, datasetVersionId?: number | undefined}; export type GetApiApiProjectIdRawDataOptions = {baseUrl?: string | undefined, ApiKeyAuthentication?: string | undefined, fetch?: typeof fetch | undefined}; export const rawDataCategory = z.enum(["training", "testing", "validation", "post-processing"]); export const sensor = z.object({index: z.number().int(), name: z.string(), units: z.string()}); export const boundingBox = z.object({label: z.string(), x: z.number().int(), y: z.number().int(), width: z.number().int(), height: z.number().int()}); export const projectLabelingMethod = z.enum(["single_label", "object_detection", "label_map"]); export const sampleLabelMapLabels = z.object({type: z.literal("key-values"), labels: z.record(z.string(), z.string())}); export const structuredLabel = z.object({startIndex: z.number().int(), endIndex: z.number().int(), label: z.string(), labelMap: sampleLabelMapLabels.optional()}); export const lastUpdatedByUser = z.object({type: z.literal("user"), id: z.number().int()}); export const lastUpdatedByProjectApiKey = z.object({type: z.literal("projectApiKey"), id: z.number().int()}); export const lastUpdatedByOAuthClient = z.object({type: z.literal("oauthClient"), oauthClientId: z.string(), userId: z.number().int().optional()}); export const lastUpdatedByDatasetVersionRestore = z.object({type: z.literal("datasetVersionRestore"), datasetVersionId: z.number().int(), groupKey: z.string(), actor: z.union([z.object({type: z.literal("user"), id: z.number().int()}), z.object({type: z.literal("projectApiKey"), id: z.number().int()}), z.object({type: z.literal("oauthClient"), oauthClientId: z.string(), userId: z.number().int().optional()})]).optional()}); export const sampleDatastream = z.object({index: z.number().int(), chartType: z.enum(["chart", "image", "video", "table"]), intervalMs: z.number(), frequencyHz: z.number(), sensors: z.array(sensor), valuesCount: z.number().int(), imageDimensions: z.object({width: z.number().int(), height: z.number().int()}).optional(), totalLengthMs: z.number()}); export const sample = z.object({id: z.number().int(), filename: z.string(), signatureValidate: z.boolean(), signatureMethod: z.string().optional(), signatureKey: z.string().optional(), created: z.string(), lastModified: z.string(), category: rawDataCategory, coldstorageFilename: z.string(), label: z.string(), intervalMs: z.number(), frequency: z.number(), originalIntervalMs: z.number(), originalFrequency: z.number(), deviceName: z.string().optional(), deviceType: z.string(), sensors: z.array(sensor), valuesCount: z.number().int(), totalLengthMs: z.number().optional(), added: z.string(), boundingBoxes: z.array(boundingBox), boundingBoxesType: z.enum(["object_detection", "constrained_object_detection"]), chartType: z.enum(["chart", "image", "video", "table"]), thumbnailVideo: z.string().optional(), thumbnailVideoFull: z.string().optional(), isDisabled: z.boolean(), isProcessing: z.boolean(), processingJobId: z.number().int().optional(), processingError: z.boolean(), processingErrorString: z.string().optional(), isCropped: z.boolean(), metadata: z.record(z.string(), z.string()).optional(), projectId: z.number().int(), projectOwnerName: z.string().optional(), projectName: z.string().optional(), projectLabelingMethod: projectLabelingMethod.optional(), sha256Hash: z.string(), structuredLabels: z.array(structuredLabel).optional(), structuredLabelsList: z.array(z.string()).optional(), createdBySyntheticDataJobId: z.number().int().optional(), imageDimensions: z.object({width: z.number().int(), height: z.number().int()}).optional(), videoUrl: z.string().optional(), videoUrlFull: z.string().optional(), labelMap: sampleLabelMapLabels.optional(), lastUpdatedBy: z.discriminatedUnion("type", [lastUpdatedByUser, lastUpdatedByProjectApiKey, lastUpdatedByOAuthClient, lastUpdatedByDatasetVersionRestore]).optional(), datastreams: z.array(sampleDatastream)}); export const listSamplesResponse = z.object({success: z.boolean(), error: z.string().optional(), samples: z.array(sample), totalCount: z.number().int()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * List samples * * GET /api/{projectId}/raw-data * * Also accepts auth: JWTAuthentication, JWTHttpHeaderAuthentication, OAuth2 */ export const getApiApiProjectIdRawData = async (args: GetApiApiProjectIdRawDataArgs, options?: GetApiApiProjectIdRawDataOptions) => { const {baseUrl = "https://studio.edgeimpulse.com/v1", fetch: fetchFn = fetch, ApiKeyAuthentication} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.category != null) query.append("category", String(args.category)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.excludeSensors != null) query.append("excludeSensors", String(args.excludeSensors)) if (args.labels != null) query.append("labels", String(args.labels)) if (args.filename != null) query.append("filename", String(args.filename)) if (args.maxLength != null) query.append("maxLength", String(args.maxLength)) if (args.minLength != null) query.append("minLength", String(args.minLength)) if (args.minFrequency != null) query.append("minFrequency", String(args.minFrequency)) if (args.maxFrequency != null) query.append("maxFrequency", String(args.maxFrequency)) if (args.signatureValidity != null) query.append("signatureValidity", String(args.signatureValidity)) if (args.includeDisabled != null) query.append("includeDisabled", String(args.includeDisabled)) if (args.minLabel != null) query.append("minLabel", String(args.minLabel)) if (args.maxLabel != null) query.append("maxLabel", String(args.maxLabel)) if (args.search != null) query.append("search", String(args.search)) if (args.proposedActionsJobId != null) query.append("proposedActionsJobId", String(args.proposedActionsJobId)) if (args.truncateStructuredLabels != null) query.append("truncateStructuredLabels", String(args.truncateStructuredLabels)) if (args.sortBy != null) query.append("sortBy", String(args.sortBy)) if (args.dataType != null) query.append("dataType", String(args.dataType)) if (args.minId != null) query.append("minId", String(args.minId)) if (args.maxId != null) query.append("maxId", String(args.maxId)) if (args.metadata != null) query.append("metadata", String(args.metadata)) if (args.minDate != null) query.append("minDate", String(args.minDate)) if (args.maxDate != null) query.append("maxDate", String(args.maxDate)) if (args.datasetVersionId != null) query.append("datasetVersionId", String(args.datasetVersionId)) if (ApiKeyAuthentication !== undefined) headers.set("x-api-key", ApiKeyAuthentication) const url = `${baseUrl.replace(/\/+$/, '')}/api/${encodeURIComponent(String(args.projectId))}/raw-data${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(listSamplesResponse, await res.json()) };