{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/dev-tools:microsoft-cognitiveservices-training/get-domains":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_domains","summary":"Get a list of the available domains.","description":"GET /domains","tags":["dev-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-domain":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_domain","summary":"Get information about a specific domain.","description":"GET /domains/{domainId}","tags":["dev-tools"],"parameters":[{"name":"domainId","in":"query","required":true,"description":"The id of the domain to get information about.","schema":{"type":"string","description":"The id of the domain to get information about."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-projects":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_projects","summary":"Get your projects.","description":"GET /projects","tags":["dev-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/create-project":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_create_project","summary":"Create a project.","description":"POST /projects","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the project."},"description":{"type":"string","description":"The description of the project."},"domainId":{"type":"string","description":"The id of the domain to use for this project. Defaults to General."},"classificationType":{"type":"string","enum":["Multiclass","Multilabel"],"description":"The type of classifier to create for this project."},"targetExportPlatforms":{"type":"array","description":"List of platforms the trained model is intending exporting to."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/import-project":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_import_project","summary":"Imports a project.","description":"POST /projects/import","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"Token generated from the export project call."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-project":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_project","summary":"Get a specific project.","description":"GET /projects/{projectId}","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The id of the project to get.","schema":{"type":"string","description":"The id of the project to get."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/update-project":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_update_project","summary":"Update a specific project.","description":"PATCH /projects/{projectId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","body"],"properties":{"projectId":{"type":"string","description":"The id of the project to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/delete-project":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_delete_project","summary":"Delete a specific project.","description":"DELETE /projects/{projectId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId"],"properties":{"projectId":{"type":"string","description":"The project id."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/export-project":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_export_project","summary":"Exports a project.","description":"GET /projects/{projectId}/export","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id of the project to export.","schema":{"type":"string","description":"The project id of the project to export."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/create-images-from-data":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_create_images_from_data","summary":"Add the provided images to the set of training images.","description":"POST /projects/{projectId}/images","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"tagIds":{"type":"array","description":"The tags ids with which to tag each image. Limited to 20."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/delete-images":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_delete_images","summary":"Delete images from the set of training images.","description":"DELETE /projects/{projectId}/images","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId"],"properties":{"projectId":{"type":"string","description":"The project id."},"imageIds":{"type":"array","description":"Ids of the images to be deleted. Limited to 256 images per batch."},"allImages":{"type":"boolean","description":"Flag to specify delete all images, specify this flag or a list of images. Using this flag will return a 202 response to indicate the…"},"allIterations":{"type":"boolean","description":"Removes these images from all iterations, not just the current workspace. Using this flag will return a 202 response to indicate the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/create-images-from-files":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_create_images_from_files","summary":"Add the provided batch of images to the set of training images.","description":"POST /projects/{projectId}/images/files","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-images-by-ids":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_images_by_ids","summary":"Get images by id for a given project iteration.","description":"GET /projects/{projectId}/images/id","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id.","schema":{"type":"string","description":"The project id."}},{"name":"imageIds","in":"query","required":false,"description":"The list of image ids to retrieve. Limited to 256.","schema":{"type":"array","description":"The list of image ids to retrieve. Limited to 256."}},{"name":"iterationId","in":"query","required":false,"description":"The iteration id. Defaults to workspace.","schema":{"type":"string","description":"The iteration id. Defaults to workspace."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/create-images-from-predictions":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_create_images_from_predictions","summary":"Add the specified predicted images to the set of training images.","description":"POST /projects/{projectId}/images/predictions","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/create-image-regions":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_create_image_regions","summary":"Create a set of image regions.","description":"POST /projects/{projectId}/images/regions","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/delete-image-regions":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_delete_image_regions","summary":"Delete a set of image regions.","description":"DELETE /projects/{projectId}/images/regions","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","regionIds"],"properties":{"projectId":{"type":"string","description":"The project id."},"regionIds":{"type":"array","description":"Regions to delete. Limited to 64."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/query-suggested-images":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_query_suggested_images","summary":"Get untagged images whose suggested tags match given tags. Returns empty array if no images are found.","description":"POST /projects/{projectId}/images/suggested","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","iterationId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"iterationId":{"type":"string","description":"IterationId to use for the suggested tags and regions."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/query-suggested-image-count":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_query_suggested_image_count","summary":"Get count of images whose suggested tags match given tags and their probabilities are greater than or equal…","description":"POST /projects/{projectId}/images/suggested/count","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","iterationId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"iterationId":{"type":"string","description":"IterationId to use for the suggested tags and regions."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-tagged-images":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_tagged_images","summary":"Get tagged images for a given project iteration.","description":"GET /projects/{projectId}/images/tagged","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id.","schema":{"type":"string","description":"The project id."}},{"name":"iterationId","in":"query","required":false,"description":"The iteration id. Defaults to workspace.","schema":{"type":"string","description":"The iteration id. Defaults to workspace."}},{"name":"tagIds","in":"query","required":false,"description":"A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.","schema":{"type":"array","description":"A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20."}},{"name":"orderBy","in":"query","required":false,"description":"The ordering. Defaults to newest.","schema":{"type":"string","enum":["Newest","Oldest"],"description":"The ordering. Defaults to newest."}},{"name":"take","in":"query","required":false,"description":"Maximum number of images to return. Defaults to 50, limited to 256.","schema":{"type":"integer","default":50,"description":"Maximum number of images to return. Defaults to 50, limited to 256."}},{"name":"skip","in":"query","required":false,"description":"Number of images to skip before beginning the image batch. Defaults to 0.","schema":{"type":"integer","default":0,"description":"Number of images to skip before beginning the image batch. Defaults to 0."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-tagged-image-count":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_tagged_image_count","summary":"Gets the number of images tagged with the provided {tagIds}.","description":"GET /projects/{projectId}/images/tagged/count","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id.","schema":{"type":"string","description":"The project id."}},{"name":"iterationId","in":"query","required":false,"description":"The iteration id. Defaults to workspace.","schema":{"type":"string","description":"The iteration id. Defaults to workspace."}},{"name":"tagIds","in":"query","required":false,"description":"A list of tags ids to filter the images to count. Defaults to all tags when null.","schema":{"type":"array","description":"A list of tags ids to filter the images to count. Defaults to all tags when null."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/create-image-tags":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_create_image_tags","summary":"Associate a set of images with a set of tags.","description":"POST /projects/{projectId}/images/tags","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/delete-image-tags":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_delete_image_tags","summary":"Remove a set of tags from a set of images.","description":"DELETE /projects/{projectId}/images/tags","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","imageIds","tagIds"],"properties":{"projectId":{"type":"string","description":"The project id."},"imageIds":{"type":"array","description":"Image ids. Limited to 64 images."},"tagIds":{"type":"array","description":"Tags to be deleted from the specified images. Limited to 20 tags."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-untagged-images":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_untagged_images","summary":"Get untagged images for a given project iteration.","description":"GET /projects/{projectId}/images/untagged","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id.","schema":{"type":"string","description":"The project id."}},{"name":"iterationId","in":"query","required":false,"description":"The iteration id. Defaults to workspace.","schema":{"type":"string","description":"The iteration id. Defaults to workspace."}},{"name":"orderBy","in":"query","required":false,"description":"The ordering. Defaults to newest.","schema":{"type":"string","enum":["Newest","Oldest"],"description":"The ordering. Defaults to newest."}},{"name":"take","in":"query","required":false,"description":"Maximum number of images to return. Defaults to 50, limited to 256.","schema":{"type":"integer","default":50,"description":"Maximum number of images to return. Defaults to 50, limited to 256."}},{"name":"skip","in":"query","required":false,"description":"Number of images to skip before beginning the image batch. Defaults to 0.","schema":{"type":"integer","default":0,"description":"Number of images to skip before beginning the image batch. Defaults to 0."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-untagged-image-count":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_untagged_image_count","summary":"Gets the number of untagged images.","description":"GET /projects/{projectId}/images/untagged/count","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id.","schema":{"type":"string","description":"The project id."}},{"name":"iterationId","in":"query","required":false,"description":"The iteration id. Defaults to workspace.","schema":{"type":"string","description":"The iteration id. Defaults to workspace."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/create-images-from-urls":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_create_images_from_urls","summary":"Add the provided images urls to the set of training images.","description":"POST /projects/{projectId}/images/urls","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-image-region-proposals":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_image_region_proposals","summary":"Get region proposals for an image. Returns empty array if no proposals are found.","description":"POST /projects/{projectId}/images/{imageId}/regionproposals","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","imageId"],"properties":{"projectId":{"type":"string","description":"The project id."},"imageId":{"type":"string","description":"The image id."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-iterations":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_iterations","summary":"Get iterations for the project.","description":"GET /projects/{projectId}/iterations","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id.","schema":{"type":"string","description":"The project id."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-iteration":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_iteration","summary":"Get a specific iteration.","description":"GET /projects/{projectId}/iterations/{iterationId}","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The id of the project the iteration belongs to.","schema":{"type":"string","description":"The id of the project the iteration belongs to."}},{"name":"iterationId","in":"query","required":true,"description":"The id of the iteration to get.","schema":{"type":"string","description":"The id of the iteration to get."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/update-iteration":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_update_iteration","summary":"Update a specific iteration.","description":"PATCH /projects/{projectId}/iterations/{iterationId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","iterationId","body"],"properties":{"projectId":{"type":"string","description":"Project id."},"iterationId":{"type":"string","description":"Iteration id."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/delete-iteration":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_delete_iteration","summary":"Delete a specific iteration of a project.","description":"DELETE /projects/{projectId}/iterations/{iterationId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","iterationId"],"properties":{"projectId":{"type":"string","description":"The project id."},"iterationId":{"type":"string","description":"The iteration id."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-exports":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_exports","summary":"Get the list of exports for a specific iteration.","description":"GET /projects/{projectId}/iterations/{iterationId}/export","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id.","schema":{"type":"string","description":"The project id."}},{"name":"iterationId","in":"query","required":true,"description":"The iteration id.","schema":{"type":"string","description":"The iteration id."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/export-iteration":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_export_iteration","summary":"Export a trained iteration.","description":"POST /projects/{projectId}/iterations/{iterationId}/export","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","iterationId","platform"],"properties":{"projectId":{"type":"string","description":"The project id."},"iterationId":{"type":"string","description":"The iteration id."},"platform":{"type":"string","enum":["CoreML","TensorFlow","DockerFile","ONNX","VAIDK"],"description":"The target platform."},"flavor":{"type":"string","enum":["Linux","Windows","ONNX10","ONNX12","ARM","TensorFlowNormal","TensorFlowLite"],"description":"The flavor of the target platform."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-iteration-performance":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_iteration_performance","summary":"Get detailed performance information about an iteration.","description":"GET /projects/{projectId}/iterations/{iterationId}/performance","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The id of the project the iteration belongs to.","schema":{"type":"string","description":"The id of the project the iteration belongs to."}},{"name":"iterationId","in":"query","required":true,"description":"The id of the iteration to get.","schema":{"type":"string","description":"The id of the iteration to get."}},{"name":"threshold","in":"query","required":false,"description":"The threshold used to determine true predictions.","schema":{"type":"number","description":"The threshold used to determine true predictions."}},{"name":"overlapThreshold","in":"query","required":false,"description":"If applicable, the bounding box overlap threshold used to determine true predictions.","schema":{"type":"number","description":"If applicable, the bounding box overlap threshold used to determine true predictions."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-image-performances":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_image_performances","summary":"Get image with its prediction for a given project iteration.","description":"GET /projects/{projectId}/iterations/{iterationId}/performance/images","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id.","schema":{"type":"string","description":"The project id."}},{"name":"iterationId","in":"query","required":true,"description":"The iteration id. Defaults to workspace.","schema":{"type":"string","description":"The iteration id. Defaults to workspace."}},{"name":"tagIds","in":"query","required":false,"description":"A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.","schema":{"type":"array","description":"A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20."}},{"name":"orderBy","in":"query","required":false,"description":"The ordering. Defaults to newest.","schema":{"type":"string","enum":["Newest","Oldest"],"description":"The ordering. Defaults to newest."}},{"name":"take","in":"query","required":false,"description":"Maximum number of images to return. Defaults to 50, limited to 256.","schema":{"type":"integer","default":50,"description":"Maximum number of images to return. Defaults to 50, limited to 256."}},{"name":"skip","in":"query","required":false,"description":"Number of images to skip before beginning the image batch. Defaults to 0.","schema":{"type":"integer","default":0,"description":"Number of images to skip before beginning the image batch. Defaults to 0."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-image-performance-count":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_image_performance_count","summary":"Gets the number of images tagged with the provided {tagIds} that have prediction results from training for…","description":"GET /projects/{projectId}/iterations/{iterationId}/performance/images/count","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id.","schema":{"type":"string","description":"The project id."}},{"name":"iterationId","in":"query","required":true,"description":"The iteration id. Defaults to workspace.","schema":{"type":"string","description":"The iteration id. Defaults to workspace."}},{"name":"tagIds","in":"query","required":false,"description":"A list of tags ids to filter the images to count. Defaults to all tags when null.","schema":{"type":"array","description":"A list of tags ids to filter the images to count. Defaults to all tags when null."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/publish-iteration":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_publish_iteration","summary":"Publish a specific iteration.","description":"POST /projects/{projectId}/iterations/{iterationId}/publish","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","iterationId","publishName","predictionId"],"properties":{"projectId":{"type":"string","description":"The project id."},"iterationId":{"type":"string","description":"The iteration id."},"publishName":{"type":"string","description":"The name to give the published iteration."},"predictionId":{"type":"string","description":"The id of the prediction resource to publish to."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/unpublish-iteration":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_unpublish_iteration","summary":"Unpublish a specific iteration.","description":"DELETE /projects/{projectId}/iterations/{iterationId}/publish","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","iterationId"],"properties":{"projectId":{"type":"string","description":"The project id."},"iterationId":{"type":"string","description":"The iteration id."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/delete-prediction":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_delete_prediction","summary":"Delete a set of predicted images and their associated prediction results.","description":"DELETE /projects/{projectId}/predictions","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","ids"],"properties":{"projectId":{"type":"string","description":"The project id."},"ids":{"type":"array","description":"The prediction ids. Limited to 64."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/query-predictions":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_query_predictions","summary":"Get images that were sent to your prediction endpoint.","description":"POST /projects/{projectId}/predictions/query","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/quick-test-image":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_quick_test_image","summary":"Quick test an image.","description":"POST /projects/{projectId}/quicktest/image","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"iterationId":{"type":"string","description":"Optional. Specifies the id of a particular iteration to evaluate against. The default iteration for the project will be used when not…"},"store":{"type":"boolean","default":true,"description":"Optional. Specifies whether or not to store the result of this prediction. The default is true, to store."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/quick-test-image-url":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_quick_test_image_url","summary":"Quick test an image url.","description":"POST /projects/{projectId}/quicktest/url","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","body"],"properties":{"projectId":{"type":"string","description":"The project to evaluate against."},"iterationId":{"type":"string","description":"Optional. Specifies the id of a particular iteration to evaluate against. The default iteration for the project will be used when not…"},"store":{"type":"boolean","default":true,"description":"Optional. Specifies whether or not to store the result of this prediction. The default is true, to store."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-tags":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_tags","summary":"Get the tags for a given project and iteration.","description":"GET /projects/{projectId}/tags","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project id.","schema":{"type":"string","description":"The project id."}},{"name":"iterationId","in":"query","required":false,"description":"The iteration id. Defaults to workspace.","schema":{"type":"string","description":"The iteration id. Defaults to workspace."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/create-tag":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_create_tag","summary":"Create a tag for the project.","description":"POST /projects/{projectId}/tags","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","name"],"properties":{"projectId":{"type":"string","description":"The project id."},"name":{"type":"string","description":"The tag name."},"description":{"type":"string","description":"Optional description for the tag."},"type":{"type":"string","enum":["Regular","Negative"],"description":"Optional type for the tag."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/get-tag":{"get":{"operationId":"dev_tools_microsoft_cognitiveservices_training_get_tag","summary":"Get information about a specific tag.","description":"GET /projects/{projectId}/tags/{tagId}","tags":["dev-tools"],"parameters":[{"name":"projectId","in":"query","required":true,"description":"The project this tag belongs to.","schema":{"type":"string","description":"The project this tag belongs to."}},{"name":"tagId","in":"query","required":true,"description":"The tag id.","schema":{"type":"string","description":"The tag id."}},{"name":"iterationId","in":"query","required":false,"description":"The iteration to retrieve this tag from. Optional, defaults to current training set.","schema":{"type":"string","description":"The iteration to retrieve this tag from. Optional, defaults to current training set."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/update-tag":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_update_tag","summary":"Update a tag.","description":"PATCH /projects/{projectId}/tags/{tagId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","tagId","body"],"properties":{"projectId":{"type":"string","description":"The project id."},"tagId":{"type":"string","description":"The id of the target tag."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/delete-tag":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_delete_tag","summary":"Delete a tag from the project.","description":"DELETE /projects/{projectId}/tags/{tagId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","tagId"],"properties":{"projectId":{"type":"string","description":"The project id."},"tagId":{"type":"string","description":"Id of the tag to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/suggest-tags-and-regions":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_suggest_tags_and_regions","summary":"Suggest tags and regions for an array/batch of untagged images. Returns empty array if no tags are found.","description":"POST /projects/{projectId}/tagsandregions/suggestions","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","iterationId","imageIds"],"properties":{"projectId":{"type":"string","description":"The project id."},"iterationId":{"type":"string","description":"IterationId to use for tag and region suggestion."},"imageIds":{"type":"array","description":"Array of image ids tag suggestion are needed for. Use GetUntaggedImages API to get imageIds."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:microsoft-cognitiveservices-training/train-project":{"post":{"operationId":"dev_tools_microsoft_cognitiveservices_training_train_project","summary":"Queues project for training.","description":"POST /projects/{projectId}/train","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId"],"properties":{"projectId":{"type":"string","description":"The project id."},"trainingType":{"type":"string","enum":["Regular","Advanced"],"description":"The type of training to use to train the project (default: Regular)."},"reservedBudgetInHours":{"type":"integer","default":0,"description":"The number of hours reserved as budget for training (if applicable)."},"forceTrain":{"type":"boolean","default":false,"description":"Whether to force train even if dataset and configuration does not change (default: false)."},"notificationEmailAddress":{"type":"string","description":"The email address to send notification to when training finishes (default: null)."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}