openapi: 3.2.0 info: description: Using Vision, you can upload images to detect and classify objects in them. If you have lots of images, you can process them in batch using asynchronous API endpoints. Vision's features are thematically split between Document AI for document-centric images, and Image Analysis for object and scene-based images. Pretrained models and custom models are supported. title: Vision AI Service Vision API version: '20220125' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/3d504bf6852838dd3bff5ec4bc3c280a9227d9addb79c06cfd74f8a57e149041.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Vision API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/3d504bf6852838dd3bff5ec4bc3c280a9227d9addb79c06cfd74f8a57e149041.yaml what: the harvested document for Vision API servers: - url: http://127.0.0.1/20220125 - url: https://127.0.0.1/20220125 tags: - name: AIServiceVision paths: /actions/analyzeDocument: post: description: 'Perform different types of image analysis. ' operationId: AnalyzeDocument parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The request was accepted and returned an analysis result. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AnalyzeDocumentResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 413: $ref: '#/components/responses/413' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Perform document analysis. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/AnalyzeDocumentResult' requestBody: content: application/json: schema: $ref: '#/components/schemas/AnalyzeDocumentDetails' description: The details of how to analyze a document. required: true /actions/analyzeImage: post: description: 'Perform different types of image analysis. ' operationId: AnalyzeImage parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The request was accepted and returned an analysis result. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AnalyzeImageResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 413: $ref: '#/components/responses/413' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Perform image analysis. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/AnalyzeImageResult' requestBody: content: application/json: schema: $ref: '#/components/schemas/AnalyzeImageDetails' description: Details about how to analyze an image. required: true /documentJobs: post: description: 'Create a document analysis batch job. ' operationId: CreateDocumentJob parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DocumentJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a batch document analysis job. tags: - AIServiceVision x-related-resource: '#/definitions/DocumentJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDocumentJobDetails' description: The details of the batch document analysis. required: true /documentJobs/{documentJobId}: get: description: 'Get details of a document batch job. ' operationId: GetDocumentJob parameters: - $ref: '#/components/parameters/DocumentJobIdParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The details of a batch document job with given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DocumentJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get details of a batch document job. tags: - AIServiceVision x-related-resource: '#/definitions/DocumentJob' /documentJobs/{documentJobId}/actions/cancel: post: description: 'Cancel a document batch job. ' operationId: CancelDocumentJob parameters: - $ref: '#/components/parameters/DocumentJobIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The job is accepted. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel a batch document job. tags: - AIServiceVision x-related-resource: '#/definitions/DocumentJob' /imageJobs: post: description: 'Create an image analysis batch job. ' operationId: CreateImageJob parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ImageJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a batch image analysis job. tags: - AIServiceVision x-related-resource: '#/definitions/ImageJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateImageJobDetails' description: The details of the batch image analysis. required: true /imageJobs/{imageJobId}: get: description: 'Get details of an image batch job. ' operationId: GetImageJob parameters: - $ref: '#/components/parameters/ImageJobIdParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The details of a batch image job with given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ImageJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get details of a batch image job. tags: - AIServiceVision x-related-resource: '#/definitions/ImageJob' /imageJobs/{imageJobId}/actions/cancel: post: description: 'Cancel an image batch job. ' operationId: CancelImageJob parameters: - $ref: '#/components/parameters/ImageJobIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel a batch image job. tags: - AIServiceVision x-related-resource: '#/definitions/ImageJob' /models: get: description: 'Returns a list of models in a compartment. ' operationId: ListModels parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProjectIdQueryParam' - $ref: '#/components/parameters/ModelLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ModelIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ModelSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ModelCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all models in a compartment tags: - AIServiceVision x-related-resource: '#/definitions/ModelCollection' post: description: 'Create a new model. ' operationId: CreateModel parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The request was successfully received, and the model creation is in progress. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Model' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new model . tags: - AIServiceVision requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateModelDetails' description: The metadata about the new model. required: true /models/{modelId}: delete: description: Delete a model by identifier. operationId: DeleteModel parameters: - $ref: '#/components/parameters/ModelIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request is accepted, and the model metadata is to be deleted. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a model. tags: - AIServiceVision x-related-resource: '#/definitions/Model' get: description: Get a model by identifier. operationId: GetModel parameters: - $ref: '#/components/parameters/ModelIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieved the model with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Model' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a model. tags: - AIServiceVision put: description: Updates the model metadata. operationId: UpdateModel parameters: - $ref: '#/components/parameters/ModelIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request is accepted, and the model metadata is to be updated. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the metadata about the model. tags: - AIServiceVision x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateModelDetails' description: The model metadata to be updated. required: true /models/{modelId}/actions/changeCompartment: post: description: Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource. operationId: ChangeModelCompartment parameters: - $ref: '#/components/parameters/ModelIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The model was successfully moved to the specified compartment. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a model into a different compartment. tags: - AIServiceVision x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeModelCompartmentDetails' description: The details of the move. required: true /projects: get: description: 'Returns a list of projects. ' operationId: ListProjects parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProjectLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ProjectSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProjectCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all the projects in a compartment. tags: - AIServiceVision x-related-resource: '#/definitions/ProjectCollection' post: description: 'Create a new project. ' operationId: CreateProject parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The request was successfully received and the project creation is in progress. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new project. tags: - AIServiceVision requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProjectDetails' description: The new Project's details. required: true /projects/{projectId}: delete: description: Delete a project by identifier. operationId: DeleteProject parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request is accepted and the Project is to be deleted. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a project. tags: - AIServiceVision x-related-resource: '#/definitions/Project' get: description: Get a project by identifier. operationId: GetProject parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieved the project with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a project. tags: - AIServiceVision put: description: Update the project metadata. operationId: UpdateProject parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request is accepted and the project is to be updated. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the metadata about the project. tags: - AIServiceVision x-related-resource: '#/definitions/Project' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProjectDetails' description: The project metadata to be updated. required: true /projects/{projectId}/actions/changeCompartment: post: description: Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource. operationId: ChangeProjectCompartment parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The project was moved successfully to the specified compartment. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Move a project into a different compartment. tags: - AIServiceVision x-related-resource: '#/definitions/Project' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeProjectCompartmentDetails' description: The deatils of the move. required: true /streamGroups: get: description: 'Gets a list of the streamGroups in the specified compartment. ' operationId: ListStreamGroups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/StreamGroupIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/StreamPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of the streamGroups. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamGroupCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: list streamGroups. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamGroupCollection' post: description: 'Registration of new streamGroup ' operationId: CreateStreamGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The request was successfully received and the streamGroup creation is in progress. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Register a new streamGroup. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStreamGroupDetails' description: Details about the streamGroup required: true /streamGroups/{streamGroupId}: delete: description: 'Delete a streamGroup ' operationId: DeleteStreamGroup parameters: - $ref: '#/components/parameters/StreamGroupIdParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a streamGroup. tags: - AIServiceVision x-related-resource: '#/definitions/StreamGroup' get: description: 'Get a streamGroup ' operationId: GetStreamGroup parameters: - $ref: '#/components/parameters/StreamGroupIdParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get streamGroup information. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamGroup' put: description: 'Update a streamGroup ' operationId: UpdateStreamGroup parameters: - $ref: '#/components/parameters/StreamGroupIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request is accepted and the streamGroup is to be updated. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update a streamGroup. tags: - AIServiceVision x-related-resource: '#/definitions/StreamGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateStreamGroupDetails' description: Details about the streamGroup required: true /streamGroups/{streamGroupId}/actions/changeCompartment: post: description: Move a streamGroup from one compartment to another. When provided, If-Match is checked against the ETag values of the resource. operationId: ChangeStreamGroupCompartment parameters: - $ref: '#/components/parameters/StreamGroupIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The streamGroup was moved successfully to the specified compartment. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Move a streamGroup into a different compartment. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeStreamGroupCompartmentDetails' description: The details of the move. required: true /streamJobs: get: description: 'Get list of stream jobs ' operationId: ListStreamJobs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/StreamJobLifecycleStateQueryParam' - $ref: '#/components/parameters/StreamJobIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/StreamPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Get list of stream jobs in a compartment headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamJobCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get list of stream Jobs tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamJobCollection' post: description: 'Create a stream analysis job with given inputs and features. ' operationId: CreateStreamJob parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The request was successfully received and the stream job creation is in progress. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a stream analysis job with given inputs and features. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStreamJobDetails' description: Details about the stream analysis. required: true /streamJobs/{streamJobId}: delete: description: 'Get details of a stream analysis job. ' operationId: DeleteStreamJob parameters: - $ref: '#/components/parameters/StreamJobIdParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Delete stream Job headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get details of a stream analysis job. tags: - AIServiceVision x-related-resource: '#/definitions/StreamJob' get: description: 'Get details of a stream analysis job. ' operationId: GetStreamJob parameters: - $ref: '#/components/parameters/StreamJobIdParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Details of a stream analysis job with given id. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get details of a stream analysis job. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamJob' put: description: 'Create a stream analysis job with given inputs and features. ' operationId: UpdateStreamJob parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/StreamJobIdParam' responses: 202: description: The request is accepted and the streamjob is to be updated. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a stream analysis job with given inputs and features. tags: - AIServiceVision x-related-resource: '#/definitions/StreamJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateStreamJobDetails' description: Details about the stream analysis. required: true /streamJobs/{streamJobId}/actions/changeCompartment: post: description: Move a streamJob from one compartment to another. When provided, If-Match is checked against the ETag values of the resource. operationId: ChangeStreamJobCompartment parameters: - $ref: '#/components/parameters/StreamJobIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The streamJob was moved successfully to the specified compartment. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Move a streamJob into a different compartment. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeStreamJobCompartmentDetails' description: The details of the move. required: true /streamJobs/{streamJobId}/actions/start: post: description: 'End a stream analysis Run. ' operationId: StartStreamJob parameters: - $ref: '#/components/parameters/StreamJobIdParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request to start stream job is accepted and start stream job is in progress headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: End a stream analysis job. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/StreamJob' /streamJobs/{streamJobId}/actions/stop: post: description: 'End a stream analysis Run. ' operationId: StopStreamJob parameters: - $ref: '#/components/parameters/StreamJobIdParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request to start stream job is accepted and start stream job is in progress. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 409: $ref: '#/components/responses/409' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: End a stream analysis Run. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/StreamJob' /streamSources: get: description: 'Gets a list of the streamSources in the specified compartment. ' operationId: ListStreamSources parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/StreamSourceLifecycleStateQueryParam' - $ref: '#/components/parameters/StreamSourceIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/StreamPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of the StreamSources. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamSourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: list streamSources. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamSourceCollection' post: description: 'Registration of new streamSource ' operationId: CreateStreamSource parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The request was successfully received and the streamSource creation is in progress. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamSource' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Register a new streamSource. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamSource' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStreamSourceDetails' description: Details about the StreamSource required: true /streamSources/{streamSourceId}: delete: description: 'Delete a streamSource ' operationId: DeleteStreamSource parameters: - $ref: '#/components/parameters/StreamSourceIdParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a streamSource. tags: - AIServiceVision x-related-resource: '#/definitions/StreamSource' get: description: 'Get a streamSource ' operationId: GetStreamSource parameters: - $ref: '#/components/parameters/StreamSourceIdParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamSource' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get streamSource information. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamSource' put: description: 'Update a streamSource ' operationId: UpdateStreamSource parameters: - $ref: '#/components/parameters/StreamSourceIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request is accepted and the streamSource is to be updated. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update a streamSource. tags: - AIServiceVision x-related-resource: '#/definitions/StreamSource' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateStreamSourceDetails' description: Details about the StreamSource required: true /streamSources/{streamSourceId}/actions/changeCompartment: post: description: Move a streamSource from one compartment to another. When provided, If-Match is checked against the ETag values of the resource. operationId: ChangeStreamSourceCompartment parameters: - $ref: '#/components/parameters/StreamSourceIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The streamSource was moved successfully to the specified compartment. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Move a streamSource into a different compartment. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/StreamSource' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeStreamSourceCompartmentDetails' description: The details of the move. required: true /videoJobs: post: description: 'Create a video analysis job with given inputs and features. ' operationId: CreateVideoJob parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VideoJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a video analysis job with given inputs and features. tags: - AIServiceVision x-related-resource: '#/definitions/VideoJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVideoJobDetails' description: Details about the video analysis. required: true /videoJobs/{videoJobId}: get: description: 'Get details of a video analysis job. ' operationId: GetVideoJob parameters: - $ref: '#/components/parameters/VideoJobIdParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Details of a video analysis job with given id. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VideoJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get details of a video analysis job. tags: - AIServiceVision x-related-resource: '#/definitions/VideoJob' /videoJobs/{videoJobId}/actions/cancel: post: description: 'Cancel a video analysis job. ' operationId: CancelVideoJob parameters: - $ref: '#/components/parameters/VideoJobIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: accepted. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel a video analysis job. tags: - AIServiceVision x-related-resource: '#/definitions/VideoJob' /visionPrivateEndpoints: get: description: 'Returns a list of visionPrivateEndpoints. ' operationId: ListVisionPrivateEndpoints parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VisionPrivateEndpointLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/VisionPrivateEndpointIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of VisionPrivateEndpointSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VisionPrivateEndpointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all the visionPrivateEndpoints in a compartment. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/VisionPrivateEndpointCollection' post: description: 'Create a new visionPrivateEndpoint. ' operationId: CreateVisionPrivateEndpoint parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The request was successfully received and the visionPrivateEndpoint creation is in progress. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VisionPrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new visionPrivateEndpoint. tags: - AIServiceVision x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVisionPrivateEndpointDetails' description: The new VisionPrivateEndpoint's details. required: true /visionPrivateEndpoints/{visionPrivateEndpointId}: delete: description: Delete a visionPrivateEndpoint by identifier. operationId: DeleteVisionPrivateEndpoint parameters: - $ref: '#/components/parameters/VisionPrivateEndpointIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request is accepted and the VisionPrivateEndpoint is to be deleted. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a visionPrivateEndpoint. tags: - AIServiceVision x-related-resource: '#/definitions/VisionPrivateEndpoint' get: description: Get a visionPrivateEndpoint by identifier. operationId: GetVisionPrivateEndpoint parameters: - $ref: '#/components/parameters/VisionPrivateEndpointIdParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieved the visionPrivateEndpoint with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VisionPrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a visionPrivateEndpoint. tags: - AIServiceVision x-obmcs-client-retries-enabled: true put: description: Update the visionPrivateEndpoint metadata. operationId: UpdateVisionPrivateEndpoint parameters: - $ref: '#/components/parameters/VisionPrivateEndpointIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request is accepted and the visionPrivateEndpoint is to be updated. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the metadata about the visionPrivateEndpoint. tags: - AIServiceVision x-related-resource: '#/definitions/VisionPrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVisionPrivateEndpointDetails' description: The visionPrivateEndpoint metadata to be updated. required: true /visionPrivateEndpoints/{visionPrivateEndpointId}/actions/changeCompartment: post: description: Move a visionPrivateEndpoint from one compartment to another. When provided, If-Match is checked against the ETag values of the resource. operationId: ChangeVisionPrivateEndpointCompartment parameters: - $ref: '#/components/parameters/VisionPrivateEndpointIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The visionPrivateEndpoint was moved successfully to the specified compartment. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Move a visionPrivateEndpoint into a different compartment. tags: - AIServiceVision x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/VisionPrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVisionPrivateEndpointCompartmentDetails' description: The deatils of the move. required: true /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: A list of work requests. tags: - AIServiceVision x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancel the work request with the given ID. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be cancelled. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel the work request. tags: - AIServiceVision x-related-resource: '#/definitions/WorkRequest' get: description: Gets the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The details of the work request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the work request status. tags: - AIServiceVision x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Returns a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request errors. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists the work request errors. tags: - AIServiceVision x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: A list of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs. tags: - AIServiceVision x-related-resource: '#/definitions/WorkRequestLogEntry' components: parameters: ProjectLifecycleStateQueryParam: description: The filter to match projects with the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Project/lifecycleState' schema: type: string StreamJobLifecycleStateQueryParam: description: The filter to match projects with the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/StreamJob/lifecycleState' schema: type: string ProjectIdQueryParam: description: The ID of the project for which to list the objects. in: query name: projectId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string DocumentJobIdParam: description: The document job ID. in: path name: documentJobId required: true schema: type: string maxLength: 255 minLength: 1 ModelLifecycleStateQueryParam: description: The filter to match models with the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Model/lifecycleState' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends on `sortBy`, and it is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC VisionPrivateEndpointLifecycleStateQueryParam: description: The filter to match projects with the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/VisionPrivateEndpoint/lifecycleState' schema: type: string ModelIdentifierQueryParam: description: The filter to find the model with the given identifier. in: query name: id x-default-description: 'null' schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string WorkRequestStatusQueryParam: description: A filter to return only resources whose lifecycleState matches the given OperationStatus. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED ProjectIdentifierPathParam: description: A unique project identifier. in: path name: projectId required: true schema: type: string VideoJobIdParam: description: Video job id. in: path name: videoJobId required: true schema: type: string maxLength: 255 minLength: 1 WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string StreamSourceIdParam: description: StreamSource Id. in: path name: streamSourceId required: true schema: type: string maxLength: 255 minLength: 1 StreamSourceIdQueryParam: description: The filter to find the device with the given identifier. in: query name: id x-default-description: 'null' schema: type: string ModelIdentifierPathParam: description: A unique model identifier. in: path name: modelId required: true schema: type: string StreamJobIdQueryParam: description: The filter to find the streamjob with the given identifier. in: query name: id x-default-description: 'null' schema: type: string ProjectIdentifierQueryParam: description: The filter to find the project with the given identifier. in: query name: id x-default-description: 'null' schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 StreamSourceLifecycleStateQueryParam: description: The filter to match projects with the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/StreamSource/lifecycleState' schema: type: string PaginationTokenQueryParam: description: The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 StreamJobIdParam: description: Stream job id. in: path name: streamJobId required: true schema: type: string maxLength: 255 minLength: 1 StreamGroupIdQueryParam: description: The filter to find the device with the given identifier. in: query name: id x-default-description: 'null' schema: type: string StreamPaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 30 minimum: 1 WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string ImageJobIdParam: description: The image job ID. in: path name: imageJobId required: true schema: type: string maxLength: 255 minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 StreamGroupIdParam: description: StreamGroup Id. in: path name: streamGroupId required: true schema: type: string maxLength: 255 minLength: 1 WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default order for timeAccepted is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted VisionPrivateEndpointIdParam: description: Vision private endpoint Id. in: path name: visionPrivateEndpointId required: true schema: type: string maxLength: 255 minLength: 1 VisionPrivateEndpointIdQueryParam: description: The filter to find the device with the given identifier. in: query name: id x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 schemas: UpdateProjectDetails: description: The metadata that can be edited after project creation. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: An optional description of the project. type: string displayName: description: A human-friendly name for the project, that can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object type: object Landmark: description: The landmark on the face. properties: type: description: The face landmark type enum: - LEFT_EYE - RIGHT_EYE - NOSE_TIP - LEFT_EDGE_OF_MOUTH - RIGHT_EDGE_OF_MOUTH type: string x: description: The X-axis normalized coordinate. format: float maximum: 1 minimum: 0 type: number y: description: The Y-axis normalized coordinate. format: float maximum: 1 minimum: 0 type: number required: - type - x - y type: object Error: description: Error Information. properties: code: description: A short error code for programmatic parsing. type: string message: description: A human-readable error message. type: string required: - code - message CreateVideoJobDetails: description: Details about the video analysis. properties: compartmentId: description: Compartment identifier from the requester. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Video job display name. maxLength: 255 minLength: 1 type: string features: description: a list of video analysis features. items: $ref: '#/components/schemas/VideoFeature' minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object inputLocation: $ref: '#/components/schemas/InputLocation' outputLocation: $ref: '#/components/schemas/OutputLocation' required: - inputLocation - features - outputLocation type: object TableRow: description: A single row in a table. properties: cells: description: The cells in the row. items: $ref: '#/components/schemas/Cell' type: array required: - cells ChangeProjectCompartmentDetails: description: Which compartment the project should be moved to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the project should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object StreamSource: description: Stream source information properties: compartmentId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the compartm. ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: display name. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamSource. ' type: string lifecycleState: description: The current state of the streamSource. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string streamSourceDetails: $ref: '#/components/schemas/StreamSourceDetails' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: When the streamSource was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the streamSource was updated, as an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - timeCreated - lifecycleState - streamSourceDetails type: object InputLocation: description: The location of the inputs. discriminator: propertyName: sourceType properties: sourceType: description: 'The type of input location. The allowed values are: - `OBJECT_LIST_INLINE_INPUT_LOCATION`: A list of object locations in Object Storage. ' enum: - OBJECT_LIST_INLINE_INPUT_LOCATION type: string required: - sourceType type: object CreateVisionPrivateEndpointDetails: description: The information needed to create a new visionPrivateEndpoint. properties: compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: default: The description of the visionPrivateEndpoint. description: An optional description of the visionPrivateEndpoint. type: string displayName: default: '' description: A human-friendly name for the visionPrivateEndpoint, that can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object subnetId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of subnet ' maxLength: 255 minLength: 1 type: string required: - compartmentId - subnetId type: object ImageText: description: The detected text. properties: lines: description: The lines of text recognized in an image. items: $ref: '#/components/schemas/Line' type: array words: description: The words recognized in an image. items: $ref: '#/components/schemas/Word' type: array required: - words - lines type: object UpdateStreamSourceDetails: description: The information needed to update stream source properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A human-friendly name for the streamSource, that can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object streamSourceDetails: $ref: '#/components/schemas/StreamSourceDetails' type: object Label: description: A label describing an image. Every label returned by the pre-deployed model is in English. example: confidence: 0.85 name: car properties: confidence: description: The confidence score between 0 and 1. format: float maximum: 1 minimum: 0 type: number name: description: The classification catagory label name. type: string required: - name - confidence type: object ModelCollection: description: The results of a model search. properties: items: description: A list of models. items: $ref: '#/components/schemas/ModelSummary' type: array required: - items type: object WorkRequestSummaryCollection: description: The results of a workRequest search. properties: items: description: The list of workRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object Model: description: Machine-learned Model. properties: averagePrecision: description: The mean average precision of the trained model. format: float type: number compartmentId: description: The compartment identifier. type: string confidenceThreshold: description: The intersection over the union threshold used for calculating precision and recall. format: float type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: An optional description of the model. maxLength: 400 minLength: 1 type: string displayName: description: A human-friendly name for the model, which can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string isQuickMode: default: false description: Set to true when experimenting with a new model type or dataset, so model training is quick, with a predefined low number of passes through the training data. type: boolean lifecycleDetails: description: A message describing the current state in more detail, that can provide actionable information if training failed. type: string lifecycleState: description: The current state of the model. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string maxTrainingDurationInHours: description: The maximum model training duration in hours, expressed as a decimal fraction. format: double type: number metrics: description: The complete set of per-label metrics for successfully trained models. type: string modelType: description: What type of Vision model this is. enum: - IMAGE_CLASSIFICATION - OBJECT_DETECTION type: string modelVersion: description: The version of the model. type: string precision: description: The precision of the trained model. format: float type: number projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model. maxLength: 255 minLength: 1 type: string recall: description: Recall of the trained model. format: float type: number systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object testImageCount: description: The number of images set aside for evaluating model performance metrics after training. type: integer testingDataset: $ref: '#/components/schemas/Dataset' timeCreated: description: When the model was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the model was updated, as an RFC3339 datetime string. format: date-time type: string totalImageCount: description: The number of images in the dataset used to train, validate, and test the model. type: integer trainedDurationInHours: description: The total hours actually used for model training. format: double type: number trainingDataset: $ref: '#/components/schemas/Dataset' validationDataset: $ref: '#/components/schemas/Dataset' required: - id - compartmentId - projectId - modelType - modelVersion - trainingDataset - timeCreated - lifecycleState type: object ModelSummary: description: The metadata about the model. properties: compartmentId: description: The compartment identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: An optional description of the model. maxLength: 400 minLength: 1 type: string displayName: description: A human-friendly name for the model, which can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail, that can provide actionable information if training failed. type: string lifecycleState: description: The current state of the model. type: string x-obmcs-enumref: '#/definitions/Model/lifecycleState' modelType: description: What type of Vision model this is. type: string x-obmcs-enumref: '#/definitions/Model/modelType' modelVersion: description: The version of the model. type: string precision: description: The precision of the trained model. format: float type: number projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object testingDataset: $ref: '#/components/schemas/Dataset' timeCreated: description: When the model was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the model was modified, as an RFC3339 datetime string. format: date-time type: string trainingDataset: $ref: '#/components/schemas/Dataset' validationDataset: $ref: '#/components/schemas/Dataset' required: - id - compartmentId - modelType - timeCreated - lifecycleState - projectId - modelVersion type: object WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment is used. ' type: string id: description: The ID of the work request. type: string operationType: description: The type of the work request. enum: - CREATE_PROJECT - UPDATE_PROJECT - DELETE_PROJECT - MOVE_PROJECT - CREATE_MODEL - UPDATE_MODEL - DELETE_MODEL - MOVE_MODEL - ADD_STREAM_SOURCE - UPDATE_STREAM_SOURCE - DELETE_STREAM_SOURCE - MOVE_STREAM_SOURCE - CREATE_STREAM_JOB - DELETE_STREAM_JOB - UPDATE_STREAM_JOB - START_STREAM_JOB - STOP_STREAM_JOB - MOVE_STREAM_JOB - ADD_STREAM_GROUP - UPDATE_STREAM_GROUP - DELETE_STREAM_GROUP - CREATE_VISION_PRIVATE_ENDPOINT - UPDATE_VISION_PRIVATE_ENDPOINT - DELETE_VISION_PRIVATE_ENDPOINT - MOVE_VISION_PRIVATE_ENDPOINT type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: The percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted StreamJobCollection: description: The results of a stream job search. properties: items: description: List of stream jobs. items: $ref: '#/components/schemas/StreamJobSummary' type: array required: - items type: object Dimensions: description: The width and height of a page. properties: height: description: The height of a page. format: double type: number unit: description: The unit of length. enum: - PIXEL - INCH type: string width: description: the width of a page. format: double type: number required: - width - height - unit type: object CreateImageJobDetails: description: The details of the batch image analysis. properties: compartmentId: description: The compartment identifier from the requester. maxLength: 255 minLength: 1 type: string displayName: description: The image job display name. maxLength: 255 minLength: 1 type: string features: description: The list of requested image analysis types. items: $ref: '#/components/schemas/ImageFeature' minItems: 1 type: array inputLocation: $ref: '#/components/schemas/InputLocation' isZipOutputEnabled: default: false description: Whether or not to generate a ZIP file containing the results. type: boolean outputLocation: $ref: '#/components/schemas/OutputLocation' required: - inputLocation - features - outputLocation type: object NormalizedVertex: description: 'An (x, y) coordinate in the image with dimensions normalized from zero to one. The origin is at top left, with the positive x-axis pointing right and the positive y-axis pointing down. The bottom right corner is at (1, 1). ' properties: x: description: The X-axis normalized coordinate. format: double maximum: 1 minimum: 0 type: number y: description: The Y-axis normalized coordinate. format: double maximum: 1 minimum: 0 type: number required: - x - y type: object ProjectCollection: description: The results of a project search. properties: items: description: List of projects. items: $ref: '#/components/schemas/ProjectSummary' type: array required: - items type: object Cell: description: A single cell in a table. properties: boundingPolygon: $ref: '#/components/schemas/BoundingPolygon' columnIndex: description: The index of the cell inside the column. type: integer confidence: description: The confidence score between 0 and 1. format: float maximum: 1 minimum: 0 type: number rowIndex: description: The index of the cell inside the row. type: integer text: description: The text recognized in the cell. type: string wordIndexes: description: The words detected in the cell. items: type: integer type: array required: - text - rowIndex - columnIndex - confidence - boundingPolygon - wordIndexes type: object ImageJob: description: The job details for a batch image analysis. properties: compartmentId: description: The OCID of the compartment that starts the job. type: string displayName: description: The image job display name. maxLength: 255 minLength: 1 type: string features: description: The list of requested document analysis types. items: $ref: '#/components/schemas/ImageFeature' minItems: 1 type: array id: description: The job id type: string inputLocation: $ref: '#/components/schemas/InputLocation' isZipOutputEnabled: default: false description: Whether or not to generate a ZIP file containing the results. type: boolean lifecycleDetails: description: The detailed status of FAILED state. enum: - PARTIALLY_SUCCEEDED - COMPLETELY_FAILED type: string lifecycleState: description: The current state of the batch image job. enum: - SUCCEEDED - FAILED - ACCEPTED - CANCELED - IN_PROGRESS - CANCELING type: string outputLocation: $ref: '#/components/schemas/OutputLocation' percentComplete: description: How much progress the operation has made, compared to the total amount of work to be performed. format: float maximum: 100 minimum: 0 type: number timeAccepted: description: The job acceptance time. format: date-time type: string timeFinished: description: The job finish time. format: date-time type: string timeStarted: description: The job start time. format: date-time type: string required: - id - compartmentId - features - timeAccepted - outputLocation - lifecycleState type: object OntologyClass: description: Images and ImageObjects can be labeled with an OntologyClass. example: name: Cat parents: - Pet - Mammal synonyms: - Feline properties: name: description: The label name. type: string parentNames: description: The label parents. items: type: string minItems: 0 type: array synonymNames: description: The label synonyms. items: type: string minItems: 0 type: array required: - name type: object DocumentDetails: description: The details of a document to analyze. discriminator: propertyName: source properties: source: description: 'The location of the document data. The allowed values are: - `INLINE`: The data is included directly in the request payload. - `OBJECT_STORAGE`: The document is in OCI Object Storage. ' enum: - INLINE - OBJECT_STORAGE type: string required: - source type: object ImageFeature: description: The type of image analysis. discriminator: propertyName: featureType properties: featureType: description: 'The type of image analysis requested. The allowed values are: - `IMAGE_CLASSIFICATION`: Label the image. - `OBJECT_DETECTION`: Identify objects in the image with bounding boxes. - `TEXT_DETECTION`: Recognize text at the word and line level. - `FACE_DETECTION`: Identify faces in the image with bounding boxes and face landmarks. ' enum: - IMAGE_CLASSIFICATION - OBJECT_DETECTION - TEXT_DETECTION - FACE_DETECTION type: string required: - featureType type: object CreateStreamGroupDetails: description: The information needed to create a stream group properties: compartmentId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A human-friendly name for the streamGroup. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object isEnabled: description: Stream type: boolean streamOverlaps: description: List of streamSource OCIDs where the streamSource overlaps in field of view. items: $ref: '#/components/schemas/StreamGroupOverlap' type: array streamSourceIds: description: List of streamSource OCIDs associated with the stream group items: type: string type: array required: - compartmentId type: object StreamSourceDetails: description: Details about a stream source discriminator: propertyName: sourceType properties: sourceType: description: 'Type of source Allowed values are: - RTSP ' enum: - RTSP type: string streamNetworkAccessDetails: $ref: '#/components/schemas/StreamNetworkAccessDetails' required: - sourceType - streamNetworkAccessDetails type: object UpdateStreamGroupDetails: description: The information needed to create a stream group properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A human-friendly name for the streamGroup. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object isEnabled: description: Stream type: boolean streamOverlaps: description: List of streamSource OCIDs where the streamSource overlaps in field of view. items: $ref: '#/components/schemas/StreamGroupOverlap' type: array streamSourceIds: description: List of streamSource OCIDs associated with the stream group items: type: string type: array type: object ProjectSummary: description: the metadata about the project. properties: compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A human-friendly name for the project, that can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail, that can provide actionable information if creation failed. type: string lifecycleState: description: The current state of the project. type: string x-obmcs-enumref: '#/definitions/Project/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: When the project was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the project was created, as an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - timeCreated - lifecycleState type: object DocumentFeature: description: The type of document analysis. discriminator: propertyName: featureType properties: featureType: description: 'The type of document analysis requested. The allowed values are: - `LANGUAGE_CLASSIFICATION`: Detect the language. - `TEXT_DETECTION`: Recognize text. - `TABLE_DETECTION`: Detect and extract data in tables. - `KEY_VALUE_DETECTION`: Extract form fields. - `DOCUMENT_CLASSIFICATION`: Identify the type of document. ' enum: - LANGUAGE_CLASSIFICATION - TEXT_DETECTION - TABLE_DETECTION - KEY_VALUE_DETECTION - DOCUMENT_CLASSIFICATION type: string required: - featureType type: object CreateStreamSourceDetails: description: The information needed to create stream source properties: compartmentId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A human-friendly name for the streamSource. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object streamSourceDetails: $ref: '#/components/schemas/StreamSourceDetails' required: - compartmentId - streamSourceDetails type: object StreamSourceCollection: description: The results of a streamSource search. properties: items: description: List of StreamSources. items: $ref: '#/components/schemas/StreamSourceSummary' type: array required: - items type: object DocumentField: description: Form field. properties: fieldLabel: $ref: '#/components/schemas/FieldLabel' fieldName: $ref: '#/components/schemas/FieldName' fieldType: description: The field type. enum: - LINE_ITEM_GROUP - LINE_ITEM - LINE_ITEM_FIELD - KEY_VALUE type: string fieldValue: $ref: '#/components/schemas/FieldValue' required: - fieldType - fieldValue ChangeStreamSourceCompartmentDetails: description: Which compartment the streamSource should be moved to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the streamSource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object StreamNetworkAccessDetails: description: Details about a stream Connection type discriminator: propertyName: streamAccessType properties: streamAccessType: description: 'Type of access Allowed values are: - PRIVATE ' enum: - PRIVATE type: string required: - streamAccessType type: object AnalyzeImageDetails: description: The details of how to analyze an image. properties: compartmentId: description: The OCID of the compartment that calls the API. maxLength: 255 minLength: 1 type: string features: description: The types of image analysis. items: $ref: '#/components/schemas/ImageFeature' minItems: 1 type: array image: $ref: '#/components/schemas/ImageDetails' required: - features - image type: object StreamGroupCollection: description: The results of a streamGroup search. properties: items: description: List of StreamGroups. items: $ref: '#/components/schemas/StreamGroupSummary' type: array required: - items type: object BoundingPolygon: description: The object-bounding polygon box. properties: normalizedVertices: description: 'An array of normalized points defining the polygon''s perimeter, with an implicit segment between subsequent points and between the first and last point. Rectangles are defined with four points. For example, `[{"x": 0, "y": 0}, {"x": 1, "y": 0}, {"x": 1, "y": 0.5}, {"x": 0, "y": 0.5}]` represents the top half of an image. ' items: $ref: '#/components/schemas/NormalizedVertex' type: array required: - normalizedVertices type: object DocumentJob: description: The job details for a batch document analysis. properties: compartmentId: description: The OCID of the compartment that starts the job. type: string displayName: description: The document job display name. maxLength: 255 minLength: 1 type: string documentType: description: The type of document. enum: - INVOICE - RECEIPT - RESUME - TAX_FORM - DRIVER_LICENSE - PASSPORT - BANK_STATEMENT - CHECK - PAYSLIP - OTHERS type: string x-obmcs-top-level-enum: '#/definitions/DocumentType' features: description: The list of requested document analysis types. items: $ref: '#/components/schemas/DocumentFeature' minItems: 1 type: array id: description: The job id. type: string inputLocation: $ref: '#/components/schemas/InputLocation' isZipOutputEnabled: default: false description: Whether or not to generate a ZIP file containing the results. type: boolean language: description: The document language, abbreviated according to ISO 639-2. enum: - ENG - CES - DAN - NLD - FIN - FRA - DEU - ELL - HUN - ITA - NOR - POL - POR - RON - RUS - SLK - SPA - SWE - TUR - ARA - CHI_SIM - HIN - JPN - KOR - OTHERS type: string x-obmcs-top-level-enum: '#/definitions/DocumentLanguage' lifecycleDetails: description: The detailed status of FAILED state. enum: - PARTIALLY_SUCCEEDED - COMPLETELY_FAILED type: string lifecycleState: description: The current state of the batch document job. enum: - SUCCEEDED - FAILED - ACCEPTED - CANCELED - IN_PROGRESS - CANCELING type: string outputLocation: $ref: '#/components/schemas/OutputLocation' percentComplete: description: How much progress the operation has made, compared to the total amount of work to be performed. format: float maximum: 100 minimum: 0 type: number timeAccepted: description: The job acceptance time. format: date-time type: string timeFinished: description: The job finish time. format: date-time type: string timeStarted: description: The job start time. format: date-time type: string required: - id - compartmentId - features - timeAccepted - outputLocation - lifecycleState type: object StreamJobSummary: description: Job details for a stream analysis. properties: compartmentId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Stream job display name. maxLength: 255 minLength: 1 type: string features: description: List of document analysis features. items: $ref: '#/components/schemas/VideoStreamFeature' maxItems: 10 minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamJob. ' type: string lifecycleDetails: description: Additional Details of the state of streamJob type: string lifecycleState: description: The current state of the Stream job. type: string x-obmcs-enumref: '#/definitions/StreamJob/lifecycleState' streamOutputLocation: $ref: '#/components/schemas/StreamOutputLocation' streamSourceId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamSource ' type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: When the streamJob was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the streamJob was updated, as an RFC3339 datetime string. format: date-time type: string required: - id - streamSourceId - features - lifecycleState - lifecycleDetails - timeCreated - compartmentId type: object ImageObject: description: The object detected in an image. properties: boundingPolygon: $ref: '#/components/schemas/BoundingPolygon' confidence: description: The confidence score, between 0 and 1. format: float maximum: 1 minimum: 0 type: number name: description: The object category name. Every value returned by the pre-deployed model is in English. maxLength: 255 minLength: 1 type: string required: - name - confidence - boundingPolygon type: object FieldValue: description: The value of a form field. discriminator: propertyName: valueType properties: boundingPolygon: $ref: '#/components/schemas/BoundingPolygon' confidence: description: The confidence score between 0 and 1. format: float maximum: 1 minimum: 0 type: number text: description: The detected text of a field. type: string valueType: description: 'The type of data detected. ' enum: - STRING - DATE - TIME - PHONE_NUMBER - NUMBER - INTEGER - ARRAY type: string wordIndexes: description: The indexes of the words in the field value. items: type: integer type: array required: - valueType - confidence - boundingPolygon - wordIndexes type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: A human-readable log message. type: string timestamp: description: When the log message was written, as an RFC3339 formatted datetime. format: date-time type: string required: - message - timestamp DetectedDocumentType: description: The detected document type. properties: confidence: description: The confidence score between 0 and 1. format: float maximum: 1 minimum: 0 type: number documentType: description: The document type. type: string required: - documentType - confidence type: object Dataset: description: The base entity which is the input for creating and training a model. discriminator: propertyName: datasetType properties: datasetType: description: The dataset type, based on where it is stored. enum: - DATA_SCIENCE_LABELING - OBJECT_STORAGE type: string required: - datasetType type: object StreamOutputLocation: description: Details about a where results will be Sent discriminator: propertyName: outputLocationType properties: outputLocationType: description: 'Type of output location Allowed values are: - OBJECT_STORAGE ' enum: - OBJECT_STORAGE type: string required: - outputLocationType type: object WorkRequest: description: The workrequest status details. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. ' type: string id: description: The ID of the work request. type: string operationType: description: The type of work request. enum: - CREATE_PROJECT - UPDATE_PROJECT - DELETE_PROJECT - MOVE_PROJECT - CREATE_MODEL - UPDATE_MODEL - DELETE_MODEL - MOVE_MODEL - ADD_STREAM_SOURCE - UPDATE_STREAM_SOURCE - DELETE_STREAM_SOURCE - MOVE_STREAM_SOURCE - CREATE_STREAM_JOB - DELETE_STREAM_JOB - UPDATE_STREAM_JOB - START_STREAM_JOB - STOP_STREAM_JOB - MOVE_STREAM_JOB - ADD_STREAM_GROUP - UPDATE_STREAM_GROUP - DELETE_STREAM_GROUP - CREATE_VISION_PRIVATE_ENDPOINT - UPDATE_VISION_PRIVATE_ENDPOINT - DELETE_VISION_PRIVATE_ENDPOINT - MOVE_VISION_PRIVATE_ENDPOINT type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: The percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted ProcessingError: description: The error in document processing. properties: code: description: The error code. type: string message: description: The error message. type: string required: - code - message type: object OutputLocation: description: The Object Storage Location. properties: bucketName: description: The Object Storage bucket name. maxLength: 255 minLength: 1 type: string namespaceName: description: The Object Storage namespace. maxLength: 255 minLength: 1 type: string prefix: description: The Object Storage folder name. maxLength: 1024 minLength: 0 type: string required: - namespaceName - bucketName - prefix type: object AnalyzeDocumentDetails: description: The details of how to analyze a document. properties: compartmentId: description: The OCID of the compartment that calls the API. maxLength: 255 minLength: 1 type: string document: $ref: '#/components/schemas/DocumentDetails' documentType: description: The document type. enum: - INVOICE - RECEIPT - RESUME - TAX_FORM - DRIVER_LICENSE - PASSPORT - BANK_STATEMENT - CHECK - PAYSLIP - OTHERS type: string x-obmcs-top-level-enum: '#/definitions/DocumentType' features: description: The types of document analysis requested. items: $ref: '#/components/schemas/DocumentFeature' type: array language: description: The document language, abbreviated according to ISO 639-2. enum: - ENG - CES - DAN - NLD - FIN - FRA - DEU - ELL - HUN - ITA - NOR - POL - POR - RON - RUS - SLK - SPA - SWE - TUR - ARA - CHI_SIM - HIN - JPN - KOR - OTHERS type: string x-obmcs-top-level-enum: '#/definitions/DocumentLanguage' outputLocation: $ref: '#/components/schemas/OutputLocation' required: - features - document type: object StreamGroup: description: Details for a Stream Group properties: compartmentId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A human-friendly name for the streamGroup. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamGroup. ' type: string isEnabled: description: Stream type: boolean lifecycleState: description: The current state of the streamGroup. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string streamOverlaps: description: List of streamSource OCIDs where the streamSource overlaps in field of view. items: $ref: '#/components/schemas/StreamGroupOverlap' type: array streamSourceIds: description: List of streamSource OCIDs associated with the stream group items: type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: When the streamGroup was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the streamGroup was updated, as an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId type: object Line: description: The line of text. properties: boundingPolygon: $ref: '#/components/schemas/BoundingPolygon' confidence: description: The confidence score between 0 and 1. format: float maximum: 1 minimum: 0 type: number text: description: The text recognized. type: string wordIndexes: description: The array of words. items: type: integer type: array required: - text - confidence - boundingPolygon - wordIndexes type: object CreateModelDetails: description: The information needed to create a new model. properties: compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: default: The description of the Model. description: An optional description of the model. maxLength: 400 minLength: 1 type: string displayName: default: '' description: A human-friendly name for the model, which can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object isQuickMode: default: false description: Set to true when experimenting with a new model type or dataset, so the model training is quick, with a predefined low number of passes through the training data. type: boolean maxTrainingDurationInHours: description: The maximum model training duration in hours, expressed as a decimal fraction. format: double type: number modelType: description: Which type of Vision model this is. type: string x-obmcs-enumref: '#/definitions/Model/modelType' modelVersion: description: The model version maxLength: 255 minLength: 1 type: string x-default-description: If not provided, a default one will be generated by the service. projectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model. maxLength: 255 minLength: 1 type: string testingDataset: $ref: '#/components/schemas/Dataset' trainingDataset: $ref: '#/components/schemas/Dataset' validationDataset: $ref: '#/components/schemas/Dataset' required: - modelType - compartmentId - projectId - trainingDataset type: object WorkRequestResource: description: A resource created, or operated on, by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until the work is complete for. At that point, it transitions to CREATED, UPDATED, or DELETED, as appropriate. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata. type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier UpdateModelDetails: description: The metadata which can be edited after model creation. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: An optional description of the model. maxLength: 400 minLength: 1 type: string displayName: description: A human-friendly name of the model, which can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object type: object ChangeStreamGroupCompartmentDetails: description: Which compartment the streamGroup should be moved to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the streamGroup should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object AnalyzeDocumentResult: description: The document analysis results. properties: detectedDocumentTypes: description: An array of detected document types. items: $ref: '#/components/schemas/DetectedDocumentType' type: array detectedLanguages: description: An array of detected languages. items: $ref: '#/components/schemas/DetectedLanguage' type: array documentClassificationModelVersion: description: The document classification model version. type: string documentMetadata: $ref: '#/components/schemas/DocumentMetadata' errors: description: The errors encountered during document analysis. items: $ref: '#/components/schemas/ProcessingError' type: array keyValueDetectionModelVersion: description: The document keyValue detection model version. type: string languageClassificationModelVersion: description: The document language classification model version. type: string pages: description: The array of a Page. items: $ref: '#/components/schemas/Page' type: array searchablePdf: description: The searchable PDF file that was generated. format: byte type: string tableDetectionModelVersion: description: The document table detection model version. type: string textDetectionModelVersion: description: The document text detection model version. type: string required: - documentMetadata - pages type: object Page: description: One page document analysis result. properties: detectedDocumentTypes: description: An array of detected document types. items: $ref: '#/components/schemas/DetectedDocumentType' type: array detectedLanguages: description: An array of detected languages. items: $ref: '#/components/schemas/DetectedLanguage' type: array dimensions: $ref: '#/components/schemas/Dimensions' documentFields: description: The form fields detected on the page. items: $ref: '#/components/schemas/DocumentField' type: array lines: description: The lines of text detected on the page. items: $ref: '#/components/schemas/Line' type: array pageNumber: description: The document page number. minimum: 1 type: integer tables: description: The tables detected on the page. items: $ref: '#/components/schemas/Table' type: array words: description: The words detected on the page. items: $ref: '#/components/schemas/Word' type: array required: - pageNumber type: object UpdateVisionPrivateEndpointDetails: description: The metadata that can be edited after visionPrivateEndpoint creation. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: An optional description of the visionPrivateEndpoint. type: string displayName: description: A human-friendly name for the visionPrivateEndpoint, that can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object type: object UpdateStreamJobDetails: description: The information needed to update streamjob properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Stream job display name. maxLength: 255 minLength: 1 type: string features: description: List of stream analysis features. items: $ref: '#/components/schemas/VideoStreamFeature' maxItems: 1 minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object streamOutputLocation: $ref: '#/components/schemas/StreamOutputLocation' streamSourceId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of streamSource ' type: string type: object FieldLabel: description: The label in a field. properties: confidence: description: The confidence score between 0 and 1. format: float maximum: 1 minimum: 0 type: number name: description: The name of the field label. maxLength: 255 minLength: 1 type: string required: - name type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable description of the issue encountered. type: string timestamp: description: When the error occured, as an RFC3339 formatted datetime. format: date-time type: string required: - code - message - timestamp CreateProjectDetails: description: The information needed to create a new project. properties: compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: default: The description of the project. description: An optional description of the project. type: string displayName: default: '' description: A human-friendly name for the project, that can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object required: - compartmentId type: object ImageDetails: description: The details of an image to analyze. discriminator: propertyName: source properties: source: description: 'The location of the image data. The allowed values are: - `INLINE`: The data is included directly in the request payload. - `OBJECT_STORAGE`: The image is in OCI Object Storage. ' enum: - INLINE - OBJECT_STORAGE type: string required: - source type: object StreamGroupOverlap: description: List of streamSource OCIDs that have overlapping fields of view properties: overlappingStreams: description: List of streamSource OCIDs. items: type: string type: array type: object VisionPrivateEndpointCollection: description: The results of a visionPrivateEndpoint search. properties: items: description: List of visionPrivateEndpoints. items: $ref: '#/components/schemas/VisionPrivateEndpointSummary' type: array required: - items type: object StreamGroupSummary: description: Summary for a Stream Group properties: compartmentId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A human-friendly name for the streamGroup. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamGroup. ' type: string isEnabled: description: Stream type: boolean lifecycleState: description: The current state of the streamGroup. type: string x-obmcs-enumref: '#/definitions/StreamGroup/lifecycleState' streamOverlaps: description: List of streamSource OCIDs where the streamSource overlaps in field of view. items: $ref: '#/components/schemas/StreamGroupOverlap' type: array streamSourceIds: description: List of streamSource OCIDs associated with the stream group items: type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: When the streamGroup was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the streamGroup was updated, as an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId type: object VisionPrivateEndpoint: description: Vision private endpoint. properties: compartmentId: description: A compartment identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: An optional description of the visionPrivateEndpoint. maxLength: 400 minLength: 1 type: string displayName: description: A human-friendly name for the visionPrivateEndpoint, which can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/Content/General/Concepts/identifiers.htm) of private endpoint ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail, that can provide actionable information if creation failed. type: string lifecycleState: description: The current state of the visionPrivateEndpoint. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string subnetId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of subnet ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: When the visionPrivateEndpoint was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the visionPrivateEndpoint was updated, as an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - timeCreated - lifecycleState - subnetId type: object StreamJob: description: Job details for a stream analysis. properties: agentParticipantId: description: participant id of agent where results need to be sent type: string compartmentId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Stream job display name. maxLength: 255 minLength: 1 type: string features: description: a list of document analysis features. items: $ref: '#/components/schemas/VideoStreamFeature' maxItems: 1 minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamJob. ' type: string lifecycleDetails: description: Additional details about current state of streamJob type: string lifecycleState: description: The current state of the Stream job. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - INACTIVE - NEEDS_ATTENTION type: string streamOutputLocation: $ref: '#/components/schemas/StreamOutputLocation' streamSourceId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamSource ' type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: When the streamJob was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the stream job was updated, as an RFC3339 datetime string. format: date-time type: string required: - id - streamSourceId - features - lifecycleState - timeCreated - compartmentId type: object DocumentMetadata: description: The document information. properties: mimeType: description: The result data format. type: string pageCount: description: Teh number of pages in the document. minimum: 1 type: integer required: - pageCount - mimeType type: object VideoJob: description: Job details for a video analysis. properties: compartmentId: description: The ocid of the compartment that starts the job. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Video job display name. maxLength: 255 minLength: 1 type: string features: description: a list of document analysis features. items: $ref: '#/components/schemas/VideoFeature' minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: Id of the job. type: string inputLocation: $ref: '#/components/schemas/InputLocation' lifecycleDetails: description: Detailed status of FAILED state. enum: - PARTIALLY_SUCCEEDED - COMPLETELY_FAILED type: string lifecycleState: description: The current state of the video job. enum: - SUCCEEDED - FAILED - ACCEPTED - CANCELED - IN_PROGRESS - CANCELING type: string outputLocation: $ref: '#/components/schemas/OutputLocation' percentComplete: description: How much progress the operation has made, vs the total amount of work that must be performed. format: float maximum: 100 minimum: 0 type: number systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeAccepted: description: Job accepted time. format: date-time type: string timeFinished: description: Job finished time. format: date-time type: string timeStarted: description: Job started time. format: date-time type: string required: - id - compartmentId - features - timeAccepted - outputLocation - lifecycleState type: object VideoStreamFeature: description: Details about a stream video feature request. discriminator: propertyName: featureType properties: featureType: description: 'The feature of video analysis. Allowed values are: - OBJECT_TRACKING: Object tracking feature(OT). - FACE_DETECTION: Face detection feature(FD). - OBJECT_DETECTION: Object detection feature(OD) ' enum: - OBJECT_TRACKING - FACE_DETECTION - OBJECT_DETECTION type: string required: - featureType type: object VisionPrivateEndpointSummary: description: the metadata about the visionPrivateEndpoint. properties: compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A human-friendly name for the visionPrivateEndpoint, that can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail, that can provide actionable information if creation failed. type: string lifecycleState: description: The current state of the visionPrivateEndpoint. type: string x-obmcs-enumref: '#/definitions/VisionPrivateEndpoint/lifecycleState' subnetId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of subnet ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: When the visionPrivateEndpoint was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the visionPrivateEndpoint was created, as an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - timeCreated - lifecycleState - subnetId type: object CreateStreamJobDetails: description: The information needed to create new Streamjob properties: compartmentId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the compartment ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Stream job display name. maxLength: 255 minLength: 1 type: string features: description: a list of stream analysis features. items: $ref: '#/components/schemas/VideoStreamFeature' maxItems: 1 minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object streamOutputLocation: $ref: '#/components/schemas/StreamOutputLocation' streamSourceId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of streamSource. ' type: string required: - streamSourceId - features - streamOutputLocation - compartmentId type: object AnalyzeImageResult: description: The image analysis results. properties: detectedFaces: description: The detected faces. items: $ref: '#/components/schemas/Face' maxItems: 1000 type: array errors: description: The errors encountered during image analysis. items: $ref: '#/components/schemas/ProcessingError' type: array faceDetectionModelVersion: description: The face detection model version. type: string imageClassificationModelVersion: description: The image classification model version. type: string imageObjects: description: The detected objects. items: $ref: '#/components/schemas/ImageObject' type: array imageText: $ref: '#/components/schemas/ImageText' labels: description: The image classification labels. items: $ref: '#/components/schemas/Label' type: array objectDetectionModelVersion: description: The object detection model version. type: string ontologyClasses: description: The ontologyClasses of image labels. items: $ref: '#/components/schemas/OntologyClass' type: array textDetectionModelVersion: description: The text detection model version. type: string type: object Face: description: The detected face. properties: boundingPolygon: $ref: '#/components/schemas/BoundingPolygon' confidence: description: The confidence score, between 0 and 1. format: float maximum: 1 minimum: 0 type: number landmarks: description: A point of interest within a face. items: $ref: '#/components/schemas/Landmark' maxItems: 1000 type: array qualityScore: description: The quality score of the face detected, between 0 and 1. format: float maximum: 1 minimum: 0 type: number required: - confidence - boundingPolygon - qualityScore type: object CreateDocumentJobDetails: description: The batch document analysis details. properties: compartmentId: description: The compartment identifier from the requester. maxLength: 255 minLength: 1 type: string displayName: description: The document job display name. maxLength: 255 minLength: 1 type: string documentType: description: The type of documents. enum: - INVOICE - RECEIPT - RESUME - TAX_FORM - DRIVER_LICENSE - PASSPORT - BANK_STATEMENT - CHECK - PAYSLIP - OTHERS type: string x-obmcs-top-level-enum: '#/definitions/DocumentType' features: description: The list of requested document analysis types. items: $ref: '#/components/schemas/DocumentFeature' minItems: 1 type: array inputLocation: $ref: '#/components/schemas/InputLocation' isZipOutputEnabled: default: false description: Whether or not to generate a ZIP file containing the results. type: boolean language: default: ENG description: The language of the document, abbreviated according to ISO 639-2. enum: - ENG - CES - DAN - NLD - FIN - FRA - DEU - ELL - HUN - ITA - NOR - POL - POR - RON - RUS - SLK - SPA - SWE - TUR - ARA - CHI_SIM - HIN - JPN - KOR - OTHERS type: string x-obmcs-top-level-enum: '#/definitions/DocumentLanguage' outputLocation: $ref: '#/components/schemas/OutputLocation' required: - inputLocation - features - outputLocation type: object ChangeVisionPrivateEndpointCompartmentDetails: description: Which compartment the visionPrivateEndpoint should be moved to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the visionPrivateEndpoint should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object Project: description: A Vision Project containing models. properties: compartmentId: description: A compartment identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: An optional description of the project. maxLength: 400 minLength: 1 type: string displayName: description: A human-friendly name for the project, which can be changed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier that is immutable after creation. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail, that can provide actionable information if creation failed. type: string lifecycleState: description: The current state of the project. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: When the project was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the project was updated, as an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - timeCreated - lifecycleState type: object DetectedLanguage: description: The language detected in a document. properties: confidence: description: The confidence score between 0 and 1. format: float maximum: 1 minimum: 0 type: number languageCode: description: The language of the document, abbreviated according to ISO 639-2. enum: - ENG - CES - DAN - NLD - FIN - FRA - DEU - ELL - HUN - ITA - NOR - POL - POR - RON - RUS - SLK - SPA - SWE - TUR - ARA - CHI_SIM - HIN - JPN - KOR - OTHERS type: string x-obmcs-top-level-enum: '#/definitions/DocumentLanguage' required: - languageCode - confidence type: object WorkRequestErrorCollection: description: The results of a workRequestError search. properties: items: description: the list of workRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object VideoFeature: description: Details about a video feature request. discriminator: propertyName: featureType properties: featureType: description: 'The feature of video analysis. Allowed values are: - LABEL_DETECTION: Label detection feature(IC). - OBJECT_DETECTION: Object detection feature(OD). - TEXT_DETECTION: Text detection feature(OCR). - FACE_DETECTION: Face detection feature(fd). - OBJECT_TRACKING: Object tracking feature(OT). ' enum: - LABEL_DETECTION - OBJECT_DETECTION - TEXT_DETECTION - FACE_DETECTION - OBJECT_TRACKING type: string required: - featureType type: object ChangeStreamJobCompartmentDetails: description: Which compartment the streamJob should be moved to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the streamJob should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangeModelCompartmentDetails: description: The compartment the model should be moved to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the model should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object StreamSourceSummary: description: Video stream analysis results. properties: compartmentId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the compartment. ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: StreamSource display name. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamSource. ' type: string lifecycleState: description: The current state of the streamSource. type: string x-obmcs-enumref: '#/definitions/StreamSource/lifecycleState' streamSourceDetails: $ref: '#/components/schemas/StreamSourceDetails' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: When the streamSource was created, as an RFC3339 datetime string. format: date-time type: string timeUpdated: description: When the streamSource was created, as an RFC3339 datetime string. format: date-time type: string required: - id - compartmentId - timeCreated - lifecycleState - streamSourceDetails type: object Word: description: A single word. properties: boundingPolygon: $ref: '#/components/schemas/BoundingPolygon' confidence: description: the confidence score between 0 and 1. format: float maximum: 1 minimum: 0 type: number text: description: The string of text characters in the word. minLength: 1 type: string required: - text - confidence - boundingPolygon type: object Table: description: The table extracted from a document. properties: bodyRows: description: The body rows. items: $ref: '#/components/schemas/TableRow' type: array boundingPolygon: $ref: '#/components/schemas/BoundingPolygon' columnCount: description: The number of columns. minimum: 0 type: integer confidence: description: The confidence score between 0 and 1. format: float maximum: 1 minimum: 0 type: number footerRows: description: the footer rows. items: $ref: '#/components/schemas/TableRow' type: array headerRows: description: The header rows. items: $ref: '#/components/schemas/TableRow' type: array rowCount: description: The number of rows. minimum: 0 type: integer required: - rowCount - columnCount - headerRows - bodyRows - footerRows - confidence - boundingPolygon type: object FieldName: description: The name of a form field. properties: boundingPolygon: $ref: '#/components/schemas/BoundingPolygon' confidence: description: The confidence score between 0 and 1. format: float maximum: 1 minimum: 0 type: number name: description: The name of the field. type: string wordIndexes: description: The indexes of the words in the field name. items: type: integer type: array required: - name type: object WorkRequestLogEntryCollection: description: The results of a workRequestLog search. properties: items: description: The list of workRequestLogEntries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object responses: default: description: Unknown Error. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.pic.ocas.vision