openapi: 3.2.0 info: description: Document AI helps customers perform various analysis on their documents. If a customer has lots of documents, they can process them in batch using asynchronous API endpoints. title: Document Understanding AI Service Document API version: '20221109' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/4131808fd66c893ddb009ad5c727048fe81e9aa7a2cf208257100cad4a7846a0.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Document Understanding 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/4131808fd66c893ddb009ad5c727048fe81e9aa7a2cf208257100cad4a7846a0.yaml what: the harvested document for Document Understanding API servers: - url: http://127.0.0.1/20221109 - url: https://127.0.0.1/20221109 tags: - name: AIServiceDocument paths: /actions/analyzeDocument: post: description: 'Perform different types of document analysis. ' operationId: AnalyzeDocument parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The request was accepted and returned an analysis result. headers: Content-Location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference 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' 412: $ref: '#/components/responses/412' 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: - AIServiceDocument 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 /modelTypes/{modelType}: get: description: Gets model capabilities operationId: GetModelType parameters: - $ref: '#/components/parameters/ModelTypePathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ModelSubTypeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Model versions along with their capabilities 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/ModelTypeInfo' 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: Retrieves model information like versions and capabilities tags: - AIServiceDocument x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ModelTypeInfo' /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: - AIServiceDocument x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Model' 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: Content-Location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference 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: - AIServiceDocument x-obmcs-client-retries-enabled: true 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' - $ref: '#/components/parameters/OverrideLocksQueryParameter' 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: - AIServiceDocument 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: - AIServiceDocument x-obmcs-client-retries-enabled: true patch: description: Updates the model metadata only selected path parameter. operationId: PatchModel 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: 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/PatchResponseMessage' 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: Updates the model metadata only selected path parameter. tags: - AIServiceDocument x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchModelDetails' description: The model metadata to be updated. required: true put: description: Updates the model metadata. operationId: UpdateModel parameters: - $ref: '#/components/parameters/ModelIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideLocksQueryParameter' 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: - AIServiceDocument 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/addLock: post: description: Adds a lock to a resource. operationId: AddModelLock parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ModelIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AddModelLockDetailsParam' - $ref: '#/components/parameters/OverrideLocksQueryParameter' responses: 200: description: Lock is removed. 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' 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: Adds a lock to a resource. tags: - AIServiceDocument x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/Model' /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' - $ref: '#/components/parameters/OverrideLocksQueryParameter' 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: - AIServiceDocument x-related-resource: '#/definitions/Model' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeModelCompartmentDetails' description: The details of the move. required: true /models/{modelId}/actions/removeLock: post: description: Remove a lock from a resource. operationId: RemoveModelLock parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ModelIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RemoveModelLockDetailsParam' - $ref: '#/components/parameters/OverrideLocksQueryParameter' responses: 200: description: Lock is removed. 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' 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: Remove a lock from a resource. tags: - AIServiceDocument x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/Model' /processorJobs: post: description: 'Create a processor job for document analysis. ' operationId: CreateProcessorJob parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The request has been accepted. 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/ProcessorJob' 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 processor job for document analysis. tags: - AIServiceDocument x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ProcessorJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProcessorJobDetails' description: The details for creating the processor job. required: true /processorJobs/{processorJobId}: get: description: 'Get the details of a processor job. ' operationId: GetProcessorJob parameters: - $ref: '#/components/parameters/ProcessorJobIdParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The details of a processor 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/ProcessorJob' 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 details of a processor job. tags: - AIServiceDocument x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ProcessorJob' /processorJobs/{processorJobId}/actions/cancel: post: description: 'Cancel a processor job. ' operationId: CancelProcessorJob parameters: - $ref: '#/components/parameters/ProcessorJobIdParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request 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 processor job. tags: - AIServiceDocument x-related-resource: '#/definitions/ProcessorJob' /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: - AIServiceDocument x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Project' 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: Content-Location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference 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: - AIServiceDocument x-obmcs-client-retries-enabled: true 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' - $ref: '#/components/parameters/OverrideLocksQueryParameter' 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: - AIServiceDocument 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: - AIServiceDocument x-obmcs-client-retries-enabled: true put: description: Update the project metadata. operationId: UpdateProject parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideLocksQueryParameter' 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: - AIServiceDocument 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/addLock: post: description: Adds a lock to a resource. operationId: AddProjectLock parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AddProjectLockDetailsParam' - $ref: '#/components/parameters/OverrideLocksQueryParameter' responses: 200: description: Lock is removed. 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' 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: Adds a lock to a resource. tags: - AIServiceDocument x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/Project' /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' - $ref: '#/components/parameters/OverrideLocksQueryParameter' 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: - AIServiceDocument x-related-resource: '#/definitions/Project' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeProjectCompartmentDetails' description: The deatils of the move. required: true /projects/{projectId}/actions/removeLock: post: description: Remove a lock from a resource. operationId: RemoveProjectLock parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RemoveProjectLockDetailsParam' - $ref: '#/components/parameters/OverrideLocksQueryParameter' responses: 200: description: Lock is removed. 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' 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: Remove a lock from a resource. tags: - AIServiceDocument x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/Project' /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: - AIServiceDocument x-obmcs-client-retries-enabled: true 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: - AIServiceDocument 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: - AIServiceDocument x-obmcs-client-retries-enabled: true 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: - AIServiceDocument x-obmcs-client-retries-enabled: true 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: - AIServiceDocument x-obmcs-client-retries-enabled: true 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 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 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 ModelIdentifierQueryParam: description: The filter to find the model with the given identifier. in: query name: id x-default-description: 'null' schema: type: string ModelSubTypeQueryParam: description: The sub type based upon model selected. in: query name: modelSubType 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 WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string AddProjectLockDetailsParam: description: 'Request payload to add lock to the resource. ' in: body name: AddProjectLockDetails required: true schema: $ref: '#/components/schemas/AddProjectLockDetails' ModelIdentifierPathParam: description: A unique model identifier. in: path name: modelId required: true 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 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 WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string RemoveModelLockDetailsParam: description: 'Request payload to remove lock to the resource. ' in: body name: RemoveModelLockDetails required: true schema: $ref: '#/components/schemas/RemoveModelLockDetails' ModelTypePathParam: description: The type of the Document model. in: path name: modelType required: true schema: type: string 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 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 RemoveProjectLockDetailsParam: description: 'Request payload to remove lock to the resource. ' in: body name: RemoveProjectLockDetails required: true schema: $ref: '#/components/schemas/RemoveProjectLockDetails' ProcessorJobIdParam: description: Processor job id. in: path name: processorJobId required: true schema: type: string maxLength: 255 minLength: 1 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 AddModelLockDetailsParam: description: 'Request payload to add lock to the resource. ' in: body name: AddModelLockDetails required: true schema: $ref: '#/components/schemas/AddModelLockDetails' OverrideLocksQueryParameter: description: Whether to override locks (if any exist). in: query name: isLockOverride schema: type: boolean default: false 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 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 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 compartment identifier. maxLength: 255 minLength: 1 type: string required: - compartmentId 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_STORAGE_LOCATIONS`: A list of object locations in Object Storage. - `INLINE_DOCUMENT_CONTENT`: The content of an inline document. ' enum: - OBJECT_STORAGE_LOCATIONS - INLINE_DOCUMENT_CONTENT type: string required: - sourceType 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 ProcessorJob: description: Details of a processor job. properties: compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string displayName: description: The display name of the processor job. maxLength: 255 minLength: 1 type: string id: description: The id of the processor job. maxLength: 255 minLength: 1 type: string inputLocation: $ref: '#/components/schemas/InputLocation' lifecycleDetails: description: The detailed status of FAILED state. enum: - PARTIALLY_SUCCEEDED - COMPLETELY_FAILED type: string lifecycleState: description: The current state of the processor 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 processorConfig: $ref: '#/components/schemas/ProcessorConfig' 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 - processorConfig - timeAccepted - outputLocation - lifecycleState type: object Model: description: Machine-learned Model. properties: aliasName: description: the alias name of the model. type: string compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string componentModels: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) collection of active custom Key Value models that need to be composed. items: $ref: '#/components/schemas/ComponentModel' maxItems: 100 minItems: 2 type: array 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 inferenceUnits: description: Number of replicas required for this model. maximum: 10 minimum: 1 type: integer x-default-description: When unspecified, the number of replicas for the model will be set to 1 isComposedModel: default: false description: Set to true when the model is created by using multiple key value extraction models. type: boolean 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 labels: description: The collection of labels used to train the custom model. items: type: string type: array language: default: ENG description: The document language for model training, abbreviated according to the BCP 47 syntax. format: x-obmcs-human-language maxLength: 50 type: string x-default-description: when unspecified, the document language will be english 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 locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' type: array maxTrainingTimeInHours: description: The maximum model training time in hours, expressed as a decimal fraction. format: double type: number metrics: $ref: '#/components/schemas/ModelMetrics' modelSubType: $ref: '#/components/schemas/ModelSubType' description: Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION. type: object modelType: description: The type of the Document model. enum: - KEY_VALUE_EXTRACTION - DOCUMENT_CLASSIFICATION - PRE_TRAINED_TEXT_EXTRACTION - PRE_TRAINED_TABLE_EXTRACTION - PRE_TRAINED_KEY_VALUE_EXTRACTION - PRE_TRAINED_DOCUMENT_CLASSIFICATION - PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION type: string modelVersion: description: The version of the model. type: string 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 tenancyId: description: The tenancy id of the model. type: string 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 trainedTimeInHours: 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 - timeCreated - lifecycleState type: object ModelSummary: description: The metadata about the model. properties: aliasName: description: the alias name of the model. type: string compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string componentModels: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) list of active custom Key Value models that need to be composed. items: $ref: '#/components/schemas/ComponentModel' maxItems: 100 minItems: 2 type: array 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 inferenceUnits: description: Number of replicas required for this model. maximum: 10 minimum: 1 type: integer x-default-description: When unspecified, the number of replicas for the model will be set to 1 isComposedModel: default: false description: Set to true when the model is created by using multiple key value extraction models. 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. type: string x-obmcs-enumref: '#/definitions/Model/lifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' type: array modelType: description: The type of the Document model. 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 tenancyId: description: The tenancy id of the model. type: string 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 compartment identifier. maxLength: 255 minLength: 1 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 - COMPOSE_MODEL 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 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 ModelTypeInfo: description: Model information like versions and capabilities properties: capabilities: additionalProperties: $ref: '#/components/schemas/Capabilities' description: Model information capabilities related to version type: object versions: description: Model versions available for this model and submodel type items: maxLength: 100 minLength: 1 type: string maxItems: 100 minItems: 1 type: array required: - capabilities type: object CreateProcessorJobDetails: description: The details used to create a processor job. properties: compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string displayName: description: The display name of the processor job. maxLength: 255 minLength: 1 type: string inputLocation: $ref: '#/components/schemas/InputLocation' outputLocation: $ref: '#/components/schemas/OutputLocation' processorConfig: $ref: '#/components/schemas/ProcessorConfig' required: - inputLocation - outputLocation - processorConfig - compartmentId 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 ComponentModel: description: The custom model selected for Composition. properties: modelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of active custom Key Value model that need to be composed. type: string 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 AddProjectLockDetails: description: Request payload to add lock to the resource. properties: message: description: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. type: string relatedResourceId: description: The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type type: object Capabilities: description: Capabilities supported properties: capability: additionalProperties: $ref: '#/components/schemas/Capability' description: Model information capabilities related to version type: object type: object PatchModelOperation: description: The metadata which can be edited after model creation. properties: operation: description: The value of the parameter to be updated. enum: - DELETE - ADD - REPLACE maxLength: 400 minLength: 1 type: string path: description: The parameter of the resource to be changed. maxLength: 255 minLength: 1 type: string value: description: The value of the parameter to be updated. maxLength: 400 minLength: 1 type: string 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 ModelSubType: description: Sub type model based on the model type. discriminator: propertyName: modelType properties: modelType: description: 'Sub type model based on the model type. The allowed values are: - `PRE_TRAINED_KEY_VALUE_EXTRACTION` - `PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION` ' enum: - PRE_TRAINED_KEY_VALUE_EXTRACTION - PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION type: string required: - modelType 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 description: description: An optional description of the project. maxLength: 400 minLength: 1 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 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_EXTRACTION`: Recognize text. - `TABLE_EXTRACTION`: Detect and extract data in tables. - `KEY_VALUE_EXTRACTION`: Extract form fields. - `DOCUMENT_CLASSIFICATION`: Identify the type of document. ' enum: - LANGUAGE_CLASSIFICATION - TEXT_EXTRACTION - TABLE_EXTRACTION - KEY_VALUE_EXTRACTION - DOCUMENT_CLASSIFICATION type: string required: - featureType 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 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 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 documentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Key-Value Extraction model that was used to extract the key-value pairs. type: string 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 WorkRequest: description: The workrequest status details. properties: compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 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 - COMPOSE_MODEL 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 RemoveModelLockDetails: description: Request payload to remove lock to the resource. properties: type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type type: object OutputLocation: description: The object storage location where to store analysis results. 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 compartment identifier. 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-default-description: when unspecified, the document type will be detected by document classification model x-obmcs-top-level-enum: '#/definitions/DocumentType' features: description: The types of document analysis requested. items: $ref: '#/components/schemas/DocumentFeature' maxItems: 5 minItems: 1 type: array language: description: The document language, abbreviated according to the BCP 47 syntax. format: x-obmcs-human-language maxLength: 50 type: string x-default-description: when unspecified, the document language will be detected by language model ocrData: $ref: '#/components/schemas/AnalyzeDocumentResult' outputLocation: $ref: '#/components/schemas/OutputLocation' required: - features - document type: object ProcessorConfig: description: The configuration of a processor. discriminator: propertyName: processorType properties: processorType: description: The type of the processor. enum: - GENERAL type: string x-obmcs-top-level-enum: '#/definitions/ProcessorType' required: - processorType type: object PatchModelDetails: description: The model parameters to be updated using patch operation. properties: operations: description: A list of patch operations for model. items: $ref: '#/components/schemas/PatchModelOperation' type: array 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: aliasName: description: the alias name of the model. type: string compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string componentModels: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) list of active custom Key Value models that need to be composed. items: $ref: '#/components/schemas/ComponentModel' maxItems: 100 minItems: 2 type: array 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: The display name of the model. 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 inferenceUnits: description: Number of replicas required for this model. maximum: 10 minimum: 1 type: integer x-default-description: When unspecified, the number of replicas for the model will be set to 1 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 language: default: ENG description: The document language for model training, abbreviated according to the BCP 47 syntax. format: x-obmcs-human-language maxLength: 50 type: string x-default-description: when unspecified, the document language will be english maxTrainingTimeInHours: description: The maximum model training time in hours, expressed as a decimal fraction. format: double type: number modelSubType: $ref: '#/components/schemas/ModelSubType' description: Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION. type: object modelType: description: The type of the Document model. 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 type: object Capability: description: Capability supported properties: details: description: values items: maxLength: 100 minLength: 1 type: string maxItems: 500 minItems: 1 type: array 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 metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN - DISPLAY_NAME type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' 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 inferenceUnits: description: Number of replicas required for this model. maximum: 10 minimum: 1 type: integer x-default-description: When unspecified, the number of replicas for the model will be set to 1 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 keyValueExtractionModelVersion: description: The document keyValue extraction 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 tableExtractionModelVersion: description: The document table extraction model version. type: string textExtractionModelVersion: description: The document text extraction 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 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: The display name of the Project. 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 RemoveProjectLockDetails: description: Request payload to remove lock to the resource. properties: type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type 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 ResourceLock: description: 'Resource locks prevent certain APIs from being called for the resource. A full lock prevents both updating and deleting the resource. A lock delete prevents deleting the resource. ' properties: compartmentId: description: The lock compartment ID. type: string message: description: 'A message added by the lock creator. The message typically gives an indication of why the resource is locked. ' type: string relatedResourceId: description: 'The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. ' type: string timeCreated: description: Indicates when the lock was created, in the format defined by RFC 3339. format: date-time type: string type: description: Lock type. enum: - FULL - DELETE type: string required: - type - compartmentId type: object DatasetSummary: description: Summary of count of samples used during model training. properties: testSampleCount: description: Number of samples used for testing the model. type: integer trainingSampleCount: description: Number of samples used for training the model. type: integer validationSampleCount: description: Number of samples used for validating the model. type: integer type: object Project: description: A Document Project containing models. 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: 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 locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' 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 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 PatchResponseMessage: description: The response containing the details of the patch operation status. properties: compartmentId: description: Compartment ID representing the conflicting Model Compartment. maxLength: 255 minLength: 1 type: string message: description: The response message containing details of operation. maxLength: 255 minLength: 1 type: string modelId: description: Model ID representing the conflicting patch operation. maxLength: 255 minLength: 1 type: string required: - message 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 language: description: The document language, abbreviated according to the BCP 47 syntax. format: x-obmcs-human-language type: string required: - language - 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 ChangeModelCompartmentDetails: description: The compartment the model should be moved to. properties: compartmentId: description: The compartment identifier. maxLength: 255 minLength: 1 type: string required: - compartmentId 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 AddModelLockDetails: description: Request payload to add lock to the resource. properties: message: description: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. type: string relatedResourceId: description: The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type 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 ModelMetrics: description: Trained Model Metrics. discriminator: propertyName: modelType properties: datasetSummary: $ref: '#/components/schemas/DatasetSummary' modelType: description: The type of custom model trained. enum: - KEY_VALUE_EXTRACTION - DOCUMENT_CLASSIFICATION - PRE_TRAINED_TEXT_EXTRACTION - PRE_TRAINED_TABLE_EXTRACTION - PRE_TRAINED_KEY_VALUE_EXTRACTION - PRE_TRAINED_DOCUMENT_CLASSIFICATION - PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION type: string required: - modelType 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: 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 f1Score: description: f1Score under the threshold format: float type: number 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 label: description: Label name type: string location: description: 'The full URI of the resource related to the request ' format: uri-reference type: string meanAveragePrecision: description: Mean average precision under different thresholds format: float type: number precision: description: Precision under the threshold format: float type: number recall: description: Recall under the threshold 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 threshold: description: Threshold used to calculate precision and recall. format: float type: number x-oracle-package: com.oracle.pic.ocas.document