{
  "opencollection": "1.0.0",
  "info": {
    "name": "Document Understanding AI Service Document API",
    "version": "20221109"
  },
  "items": [
    {
      "info": {
        "name": "AIServiceDocument",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Perform document analysis.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/actions/analyzeDocument",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Perform different types of document analysis.\n"
        },
        {
          "info": {
            "name": "Retrieves model information like versions and capabilities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20221109/modelTypes/:modelType",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "modelType",
                "value": "",
                "type": "path",
                "description": "The type of the Document model."
              },
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "modelSubType",
                "value": "",
                "type": "query",
                "description": "The sub type based upon model selected."
              }
            ]
          },
          "docs": "Gets model capabilities"
        },
        {
          "info": {
            "name": "Gets a list of all models in a compartment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20221109/models",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "projectId",
                "value": "",
                "type": "query",
                "description": "The ID of the project for which to list the objects."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "The filter to match models with the given lifecycleState."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "The filter to find the model with the given identifier."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              }
            ]
          },
          "docs": "Returns a list of models in a compartment.\n"
        },
        {
          "info": {
            "name": "Creates a new model .",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/models",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new model.\n"
        },
        {
          "info": {
            "name": "Get a model.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20221109/models/:modelId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "A unique model identifier."
              }
            ]
          },
          "docs": "Get a model by identifier."
        },
        {
          "info": {
            "name": "Update the metadata about the model.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20221109/models/:modelId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "A unique model identifier."
              },
              {
                "name": "isLockOverride",
                "value": "",
                "type": "query",
                "description": "Whether to override locks (if any exist)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the model metadata."
        },
        {
          "info": {
            "name": "Updates the model metadata only selected path parameter.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://127.0.0.1/20221109/models/:modelId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "A unique model identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the model metadata only selected path parameter."
        },
        {
          "info": {
            "name": "Delete a model.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20221109/models/:modelId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "A unique model identifier."
              },
              {
                "name": "isLockOverride",
                "value": "",
                "type": "query",
                "description": "Whether to override locks (if any exist)."
              }
            ]
          },
          "docs": "Delete a model by identifier."
        },
        {
          "info": {
            "name": "Adds a lock to a resource.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/models/:modelId/actions/addLock",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "A unique model identifier."
              },
              {
                "name": "isLockOverride",
                "value": "",
                "type": "query",
                "description": "Whether to override locks (if any exist)."
              }
            ]
          },
          "docs": "Adds a lock to a resource."
        },
        {
          "info": {
            "name": "Moves a model into a different compartment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/models/:modelId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "A unique model identifier."
              },
              {
                "name": "isLockOverride",
                "value": "",
                "type": "query",
                "description": "Whether to override locks (if any exist)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource."
        },
        {
          "info": {
            "name": "Remove a lock from a resource.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/models/:modelId/actions/removeLock",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "A unique model identifier."
              },
              {
                "name": "isLockOverride",
                "value": "",
                "type": "query",
                "description": "Whether to override locks (if any exist)."
              }
            ]
          },
          "docs": "Remove a lock from a resource."
        },
        {
          "info": {
            "name": "Create a processor job for document analysis.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/processorJobs",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a processor job for document analysis.\n"
        },
        {
          "info": {
            "name": "Get the details of a processor job.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20221109/processorJobs/:processorJobId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "processorJobId",
                "value": "",
                "type": "path",
                "description": "Processor job id."
              }
            ]
          },
          "docs": "Get the details of a processor job.\n"
        },
        {
          "info": {
            "name": "Cancel a processor job.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/processorJobs/:processorJobId/actions/cancel",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "processorJobId",
                "value": "",
                "type": "path",
                "description": "Processor job id."
              }
            ]
          },
          "docs": "Cancel a processor job.\n"
        },
        {
          "info": {
            "name": "Gets a list of all the projects in a compartment.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20221109/projects",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "The filter to match projects with the given lifecycleState."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "The filter to find the project with the given identifier."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              }
            ]
          },
          "docs": "Returns a list of projects.\n"
        },
        {
          "info": {
            "name": "Creates a new project.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/projects",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new project.\n"
        },
        {
          "info": {
            "name": "Get a project.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20221109/projects/:projectId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "A unique project identifier."
              }
            ]
          },
          "docs": "Get a project by identifier."
        },
        {
          "info": {
            "name": "Update the metadata about the project.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20221109/projects/:projectId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "A unique project identifier."
              },
              {
                "name": "isLockOverride",
                "value": "",
                "type": "query",
                "description": "Whether to override locks (if any exist)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the project metadata."
        },
        {
          "info": {
            "name": "Delete a project.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20221109/projects/:projectId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "A unique project identifier."
              },
              {
                "name": "isLockOverride",
                "value": "",
                "type": "query",
                "description": "Whether to override locks (if any exist)."
              }
            ]
          },
          "docs": "Delete a project by identifier."
        },
        {
          "info": {
            "name": "Adds a lock to a resource.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/projects/:projectId/actions/addLock",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "A unique project identifier."
              },
              {
                "name": "isLockOverride",
                "value": "",
                "type": "query",
                "description": "Whether to override locks (if any exist)."
              }
            ]
          },
          "docs": "Adds a lock to a resource."
        },
        {
          "info": {
            "name": "Move a project into a different compartment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/projects/:projectId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "A unique project identifier."
              },
              {
                "name": "isLockOverride",
                "value": "",
                "type": "query",
                "description": "Whether to override locks (if any exist)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource."
        },
        {
          "info": {
            "name": "Remove a lock from a resource.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20221109/projects/:projectId/actions/removeLock",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "A unique project identifier."
              },
              {
                "name": "isLockOverride",
                "value": "",
                "type": "query",
                "description": "Whether to override locks (if any exist)."
              }
            ]
          },
          "docs": "Remove a lock from a resource."
        },
        {
          "info": {
            "name": "A list of work requests.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20221109/workRequests",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "workRequestId",
                "value": "",
                "type": "query",
                "description": "The ID of the asynchronous work request."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources whose lifecycleState matches the given OperationStatus."
              },
              {
                "name": "resourceId",
                "value": "",
                "type": "query",
                "description": "The ID of the resource affected by the work request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. The default order for timeAccepted is descending.\n"
              }
            ]
          },
          "docs": "Lists the work requests in a compartment.\n"
        },
        {
          "info": {
            "name": "Get the work request status.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20221109/workRequests/:workRequestId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              }
            ]
          },
          "docs": "Gets the status of the work request with the given ID."
        },
        {
          "info": {
            "name": "Cancel the work request.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20221109/workRequests/:workRequestId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              }
            ]
          },
          "docs": "Cancel the work request with the given ID."
        },
        {
          "info": {
            "name": "Lists the work request errors.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20221109/workRequests/:workRequestId/errors",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. The default order for timeAccepted is descending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              }
            ]
          },
          "docs": "Returns a (paginated) list of errors for a given work request.\n"
        },
        {
          "info": {
            "name": "Lists work request logs.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20221109/workRequests/:workRequestId/logs",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. The default order for timeAccepted is descending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              }
            ]
          },
          "docs": "Return a (paginated) list of logs for a given work request.\n"
        }
      ]
    }
  ],
  "bundled": true
}