basePath: /20220125
definitions:
  ActionType:
    description: Possible types of actions.
    enum: &id008
    - CREATED
    - UPDATED
    - DELETED
    - IN_PROGRESS
    - RELATED
    - FAILED
    type: string
  AnalyzeDocumentDetails:
    description: The details of how to analyze a document.
    properties:
      compartmentId:
        description: The OCID of the compartment that calls the API.
        maxLength: 255
        minLength: 1
        type: string
      document:
        $ref: '#/definitions/DocumentDetails'
      documentType:
        description: The document type.
        enum: &id001
        - INVOICE
        - RECEIPT
        - RESUME
        - TAX_FORM
        - DRIVER_LICENSE
        - PASSPORT
        - BANK_STATEMENT
        - CHECK
        - PAYSLIP
        - OTHERS
        type: string
        x-obmcs-top-level-enum: '#/definitions/DocumentType'
      features:
        description: The types of document analysis requested.
        items:
          $ref: '#/definitions/DocumentFeature'
        type: array
      language:
        description: The document language, abbreviated according to ISO 639-2.
        enum: &id002
        - ENG
        - CES
        - DAN
        - NLD
        - FIN
        - FRA
        - DEU
        - ELL
        - HUN
        - ITA
        - NOR
        - POL
        - POR
        - RON
        - RUS
        - SLK
        - SPA
        - SWE
        - TUR
        - ARA
        - CHI_SIM
        - HIN
        - JPN
        - KOR
        - OTHERS
        type: string
        x-obmcs-top-level-enum: '#/definitions/DocumentLanguage'
      outputLocation:
        $ref: '#/definitions/OutputLocation'
    required:
    - features
    - document
    type: object
  AnalyzeDocumentResult:
    description: The document analysis results.
    properties:
      detectedDocumentTypes:
        description: An array of detected document types.
        items:
          $ref: '#/definitions/DetectedDocumentType'
        type: array
      detectedLanguages:
        description: An array of detected languages.
        items:
          $ref: '#/definitions/DetectedLanguage'
        type: array
      documentClassificationModelVersion:
        description: The document classification model version.
        type: string
      documentMetadata:
        $ref: '#/definitions/DocumentMetadata'
      errors:
        description: The errors encountered during document analysis.
        items:
          $ref: '#/definitions/ProcessingError'
        type: array
      keyValueDetectionModelVersion:
        description: The document keyValue detection model version.
        type: string
      languageClassificationModelVersion:
        description: The document language classification model version.
        type: string
      pages:
        description: The array of a Page.
        items:
          $ref: '#/definitions/Page'
        type: array
      searchablePdf:
        description: The searchable PDF file that was generated.
        format: byte
        type: string
      tableDetectionModelVersion:
        description: The document table detection model version.
        type: string
      textDetectionModelVersion:
        description: The document text detection model version.
        type: string
    required:
    - documentMetadata
    - pages
    type: object
  AnalyzeImageDetails:
    description: The details of how to analyze an image.
    properties:
      compartmentId:
        description: The OCID of the compartment that calls the API.
        maxLength: 255
        minLength: 1
        type: string
      features:
        description: The types of image analysis.
        items:
          $ref: '#/definitions/ImageFeature'
        minItems: 1
        type: array
      image:
        $ref: '#/definitions/ImageDetails'
    required:
    - features
    - image
    type: object
  AnalyzeImageResult:
    description: The image analysis results.
    properties:
      detectedFaces:
        description: The detected faces.
        items:
          $ref: '#/definitions/Face'
        maxItems: 1000
        type: array
      errors:
        description: The errors encountered during image analysis.
        items:
          $ref: '#/definitions/ProcessingError'
        type: array
      faceDetectionModelVersion:
        description: The face detection model version.
        type: string
      imageClassificationModelVersion:
        description: The image classification model version.
        type: string
      imageObjects:
        description: The detected objects.
        items:
          $ref: '#/definitions/ImageObject'
        type: array
      imageText:
        $ref: '#/definitions/ImageText'
      labels:
        description: The image classification labels.
        items:
          $ref: '#/definitions/Label'
        type: array
      objectDetectionModelVersion:
        description: The object detection model version.
        type: string
      ontologyClasses:
        description: The ontologyClasses of image labels.
        items:
          $ref: '#/definitions/OntologyClass'
        type: array
      textDetectionModelVersion:
        description: The text detection model version.
        type: string
    type: object
  AnalyzeVideoResult:
    description: Video analysis results.
    properties:
      errors:
        description: Array of possible errors.
        items:
          $ref: '#/definitions/ProcessingError'
        type: array
      faceDetectionModelVersion:
        description: Face Detection model version.
        type: string
      labelDetectionModelVersion:
        description: Label Detection model version.
        type: string
      objectDetectionModelVersion:
        description: Object Detection model version.
        type: string
      objectTrackingModelVersion:
        description: Object Tracking model version.
        type: string
      ontologyClasses:
        description: The ontologyClasses of video labels.
        items:
          $ref: '#/definitions/OntologyClass'
        type: array
      textDetectionModelVersion:
        description: Text Detection model version.
        type: string
      videoFaces:
        description: Detected faces in a video.
        items:
          $ref: '#/definitions/VideoFace'
        type: array
      videoLabels:
        description: Detected labels in a video.
        items:
          $ref: '#/definitions/VideoLabel'
        type: array
      videoMetadata:
        $ref: '#/definitions/VideoMetadata'
      videoObjects:
        description: Detected objects in a video.
        items:
          $ref: '#/definitions/VideoObject'
        type: array
      videoText:
        description: Detected text in a video.
        items:
          $ref: '#/definitions/VideoText'
        type: array
      videoTrackedObjects:
        description: Tracked objects in a video.
        items:
          $ref: '#/definitions/VideoTrackedObject'
        type: array
    required:
    - videoMetadata
    type: object
  AnalyzeVideoStreamResult:
    description: Video stream analysis results.
    properties:
      errors:
        description: Array of possible errors.
        items:
          $ref: '#/definitions/ProcessingError'
        type: array
      imageData:
        description: Base 64 encoded frame
        type: string
      objectDetectionModelVersions:
        description: List of Object Detection model versions.
        items:
          $ref: '#/definitions/ModelVersionDetails'
        maxItems: 20
        minItems: 0
        type: array
      objectTrackingModelVersions:
        description: List of Object Tracking model versions.
        items:
          $ref: '#/definitions/ModelVersionDetails'
        maxItems: 20
        minItems: 0
        type: array
      ontologyClasses:
        $ref: '#/definitions/OntologyClass'
      streamJobId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of streamJob.

          '
        type: string
      streamSourceId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of StreamSource.

          '
        type: string
      timestamp:
        description: time stamp of frame in utc.
        type: string
      videoStreamMetadata:
        $ref: '#/definitions/VideoStreamMetadata'
      videoStreamObjects:
        description: Tracked objects in a video stream.
        items:
          $ref: '#/definitions/VideoStreamObject'
        type: array
    required:
    - timestamp
    - streamJobId
    - streamSourceId
    - videoStreamMetadata
    type: object
  BoundingPolygon:
    description: The object-bounding polygon box.
    properties:
      normalizedVertices:
        description: 'An array of normalized points defining the polygon''s perimeter,
          with an implicit segment between subsequent points and between the first
          and last point.

          Rectangles are defined with four points. For example, `[{"x": 0, "y": 0},
          {"x": 1, "y": 0}, {"x": 1, "y": 0.5}, {"x": 0, "y": 0.5}]` represents the
          top half of an image.

          '
        items:
          $ref: '#/definitions/NormalizedVertex'
        type: array
    required:
    - normalizedVertices
    type: object
  Cell:
    description: A single cell in a table.
    properties:
      boundingPolygon:
        $ref: '#/definitions/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
  ChangeModelCompartmentDetails:
    description: The compartment the model should be moved to.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment

          into which the model should be moved.

          '
        maxLength: 255
        minLength: 1
        type: string
    required:
    - compartmentId
    type: object
  ChangeProjectCompartmentDetails:
    description: Which compartment the project should be moved to.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment

          into which the project should be moved.

          '
        maxLength: 255
        minLength: 1
        type: string
    required:
    - compartmentId
    type: object
  ChangeStreamGroupCompartmentDetails:
    description: Which compartment the streamGroup should be moved to.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment

          into which the streamGroup should be moved.

          '
        maxLength: 255
        minLength: 1
        type: string
    required:
    - compartmentId
    type: object
  ChangeStreamJobCompartmentDetails:
    description: Which compartment the streamJob should be moved to.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment

          into which the streamJob should be moved.

          '
        maxLength: 255
        minLength: 1
        type: string
    required:
    - compartmentId
    type: object
  ChangeStreamSourceCompartmentDetails:
    description: Which compartment the streamSource should be moved to.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment

          into which the streamSource should be moved.

          '
        maxLength: 255
        minLength: 1
        type: string
    required:
    - compartmentId
    type: object
  ChangeVisionPrivateEndpointCompartmentDetails:
    description: Which compartment the visionPrivateEndpoint should be moved to.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment

          into which the visionPrivateEndpoint should be moved.

          '
        maxLength: 255
        minLength: 1
        type: string
    required:
    - compartmentId
    type: object
  CreateDocumentJobDetails:
    description: The batch document analysis details.
    properties:
      compartmentId:
        description: The compartment identifier from the requester.
        maxLength: 255
        minLength: 1
        type: string
      displayName:
        description: The document job display name.
        maxLength: 255
        minLength: 1
        type: string
      documentType:
        description: The type of documents.
        enum: *id001
        type: string
        x-obmcs-top-level-enum: '#/definitions/DocumentType'
      features:
        description: The list of requested document analysis types.
        items:
          $ref: '#/definitions/DocumentFeature'
        minItems: 1
        type: array
      inputLocation:
        $ref: '#/definitions/InputLocation'
      isZipOutputEnabled:
        default: false
        description: Whether or not to generate a ZIP file containing the results.
        type: boolean
      language:
        default: ENG
        description: The language of the document, abbreviated according to ISO 639-2.
        enum: *id002
        type: string
        x-obmcs-top-level-enum: '#/definitions/DocumentLanguage'
      outputLocation:
        $ref: '#/definitions/OutputLocation'
    required:
    - inputLocation
    - features
    - outputLocation
    type: object
  CreateImageJobDetails:
    description: The details of the batch image analysis.
    properties:
      compartmentId:
        description: The compartment identifier from the requester.
        maxLength: 255
        minLength: 1
        type: string
      displayName:
        description: The image job display name.
        maxLength: 255
        minLength: 1
        type: string
      features:
        description: The list of requested image analysis types.
        items:
          $ref: '#/definitions/ImageFeature'
        minItems: 1
        type: array
      inputLocation:
        $ref: '#/definitions/InputLocation'
      isZipOutputEnabled:
        default: false
        description: Whether or not to generate a ZIP file containing the results.
        type: boolean
      outputLocation:
        $ref: '#/definitions/OutputLocation'
    required:
    - inputLocation
    - features
    - outputLocation
    type: object
  CreateModelDetails:
    description: The information needed to create a new model.
    properties:
      compartmentId:
        description: The compartment identifier.
        maxLength: 255
        minLength: 1
        type: string
      definedTags: &id003
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only string, integer, and boolean
              types are supported.

              '
            type: object
          description: 'A key-value pair representing predefined tags'' keys and values
            scoped to a namespace.

            For example: `{"bar-key": "value"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace.

          For example: `{"foo-namespace": {"bar-key": "value"}}`

          '
        type: object
      description:
        default: The description of the Model.
        description: An optional description of the model.
        maxLength: 400
        minLength: 1
        type: string
      displayName:
        default: ''
        description: A human-friendly name for the model, which can be changed.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: &id004
        additionalProperties:
          type: string
        description: 'A simple key-value pair that is applied without any predefined
          name, type, or scope. It exists for cross-compatibility only.

          For example: `{"bar-key": "value"}`

          '
        type: object
      isQuickMode:
        default: false
        description: Set to true when experimenting with a new model type or dataset,
          so the model training is quick, with a predefined low number of passes through
          the training data.
        type: boolean
      maxTrainingDurationInHours:
        description: The maximum model training duration in hours, expressed as a
          decimal fraction.
        format: double
        type: number
      modelType:
        description: Which type of Vision model this is.
        type: string
        x-obmcs-enumref: '#/definitions/Model/modelType'
      modelVersion:
        description: The model version
        maxLength: 255
        minLength: 1
        type: string
        x-default-description: If not provided, a default one will be generated by
          the service.
      projectId:
        description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of
          the project that contains the model.
        maxLength: 255
        minLength: 1
        type: string
      testingDataset:
        $ref: '#/definitions/Dataset'
      trainingDataset:
        $ref: '#/definitions/Dataset'
      validationDataset:
        $ref: '#/definitions/Dataset'
    required:
    - modelType
    - compartmentId
    - projectId
    - trainingDataset
    type: object
  CreateProjectDetails:
    description: The information needed to create a new project.
    properties:
      compartmentId:
        description: The compartment identifier.
        maxLength: 255
        minLength: 1
        type: string
      definedTags: *id003
      description:
        default: The description of the project.
        description: An optional description of the project.
        type: string
      displayName:
        default: ''
        description: A human-friendly name for the project, that can be changed.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
    required:
    - compartmentId
    type: object
  CreateStreamGroupDetails:
    description: The information needed to create a stream group
    properties:
      compartmentId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment

          '
        type: string
      definedTags: *id003
      displayName:
        description: A human-friendly name for the streamGroup.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      isEnabled:
        description: Stream
        type: boolean
      streamOverlaps:
        description: List of streamSource OCIDs where the streamSource overlaps in
          field of view.
        items:
          $ref: '#/definitions/StreamGroupOverlap'
        type: array
      streamSourceIds:
        description: List of streamSource OCIDs associated with the stream group
        items:
          type: string
        type: array
    required:
    - compartmentId
    type: object
  CreateStreamJobDetails:
    description: The information needed to create new Streamjob
    properties:
      compartmentId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the compartment

          '
        maxLength: 255
        minLength: 1
        type: string
      definedTags: *id003
      displayName:
        description: Stream job display name.
        maxLength: 255
        minLength: 1
        type: string
      features:
        description: a list of stream analysis features.
        items:
          $ref: '#/definitions/VideoStreamFeature'
        maxItems: 1
        minItems: 1
        type: array
      freeformTags: *id004
      streamOutputLocation:
        $ref: '#/definitions/StreamOutputLocation'
      streamSourceId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of streamSource.

          '
        type: string
    required:
    - streamSourceId
    - features
    - streamOutputLocation
    - compartmentId
    type: object
  CreateStreamSourceDetails:
    description: The information needed to create stream source
    properties:
      compartmentId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment

          '
        type: string
      definedTags: *id003
      displayName:
        description: A human-friendly name for the streamSource.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      streamSourceDetails:
        $ref: '#/definitions/StreamSourceDetails'
    required:
    - compartmentId
    - streamSourceDetails
    type: object
  CreateVideoJobDetails:
    description: Details about the video analysis.
    properties:
      compartmentId:
        description: Compartment identifier from the requester.
        maxLength: 255
        minLength: 1
        type: string
      definedTags: *id003
      displayName:
        description: Video job display name.
        maxLength: 255
        minLength: 1
        type: string
      features:
        description: a list of video analysis features.
        items:
          $ref: '#/definitions/VideoFeature'
        minItems: 1
        type: array
      freeformTags: *id004
      inputLocation:
        $ref: '#/definitions/InputLocation'
      outputLocation:
        $ref: '#/definitions/OutputLocation'
    required:
    - inputLocation
    - features
    - outputLocation
    type: object
  CreateVisionPrivateEndpointDetails:
    description: The information needed to create a new visionPrivateEndpoint.
    properties:
      compartmentId:
        description: The compartment identifier.
        maxLength: 255
        minLength: 1
        type: string
      definedTags: *id003
      description:
        default: The description of the visionPrivateEndpoint.
        description: An optional description of the visionPrivateEndpoint.
        type: string
      displayName:
        default: ''
        description: A human-friendly name for the visionPrivateEndpoint, that can
          be changed.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      subnetId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of subnet

          '
        maxLength: 255
        minLength: 1
        type: string
    required:
    - compartmentId
    - subnetId
    type: object
  DataScienceLabelingDataset:
    allOf:
    - $ref: '#/definitions/Dataset'
    - discriminator: DATA_SCIENCE_LABELING
      properties:
        datasetId:
          description: OCID of the Data Labeling dataset.
          type: string
      required:
      - datasetId
    description: The dataset created by the Data Labeling Service.
  Dataset:
    description: The base entity which is the input for creating and training a model.
    discriminator: 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
  DetectedDocumentType:
    description: The detected document type.
    properties:
      confidence:
        description: The confidence score between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      documentType:
        description: The document type.
        type: string
    required:
    - documentType
    - confidence
    type: object
  DetectedLanguage:
    description: The language detected in a document.
    properties:
      confidence:
        description: The confidence score between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      languageCode:
        description: The language of the document, abbreviated according to ISO 639-2.
        enum: *id002
        type: string
        x-obmcs-top-level-enum: '#/definitions/DocumentLanguage'
    required:
    - languageCode
    - confidence
    type: object
  Dimensions:
    description: The width and height of a page.
    properties:
      height:
        description: The height of a page.
        format: double
        type: number
      unit:
        description: The unit of length.
        enum:
        - PIXEL
        - INCH
        type: string
      width:
        description: the width of a page.
        format: double
        type: number
    required:
    - width
    - height
    - unit
    type: object
  DocumentClassificationFeature:
    allOf:
    - $ref: '#/definitions/DocumentFeature'
    - discriminator: DOCUMENT_CLASSIFICATION
      properties:
        maxResults:
          default: 5
          description: The maximum number of results to return.
          type: integer
        modelId:
          description: The custom model ID.
          type: string
          x-default-description: when null or absent, the pre-deployed model will
            be used
    description: Identifying the document type.
  DocumentDetails:
    description: The details of a document to analyze.
    discriminator: 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
  DocumentFeature:
    description: The type of document analysis.
    discriminator: featureType
    properties:
      featureType:
        description: 'The type of document analysis requested.

          The allowed values are:

          - `LANGUAGE_CLASSIFICATION`: Detect the language.

          - `TEXT_DETECTION`: Recognize text.

          - `TABLE_DETECTION`: Detect and extract data in tables.

          - `KEY_VALUE_DETECTION`: Extract form fields.

          - `DOCUMENT_CLASSIFICATION`: Identify the type of document.

          '
        enum:
        - LANGUAGE_CLASSIFICATION
        - TEXT_DETECTION
        - TABLE_DETECTION
        - KEY_VALUE_DETECTION
        - DOCUMENT_CLASSIFICATION
        type: string
    required:
    - featureType
    type: object
  DocumentField:
    description: Form field.
    properties:
      fieldLabel:
        $ref: '#/definitions/FieldLabel'
      fieldName:
        $ref: '#/definitions/FieldName'
      fieldType:
        description: The field type.
        enum:
        - LINE_ITEM_GROUP
        - LINE_ITEM
        - LINE_ITEM_FIELD
        - KEY_VALUE
        type: string
      fieldValue:
        $ref: '#/definitions/FieldValue'
    required:
    - fieldType
    - fieldValue
  DocumentJob:
    description: The job details for a batch document analysis.
    properties:
      compartmentId:
        description: The OCID of the compartment that starts the job.
        type: string
      displayName:
        description: The document job display name.
        maxLength: 255
        minLength: 1
        type: string
      documentType:
        description: The type of document.
        enum: *id001
        type: string
        x-obmcs-top-level-enum: '#/definitions/DocumentType'
      features:
        description: The list of requested document analysis types.
        items:
          $ref: '#/definitions/DocumentFeature'
        minItems: 1
        type: array
      id:
        description: The job id.
        type: string
      inputLocation:
        $ref: '#/definitions/InputLocation'
      isZipOutputEnabled:
        default: false
        description: Whether or not to generate a ZIP file containing the results.
        type: boolean
      language:
        description: The document language, abbreviated according to ISO 639-2.
        enum: *id002
        type: string
        x-obmcs-top-level-enum: '#/definitions/DocumentLanguage'
      lifecycleDetails:
        description: The detailed status of FAILED state.
        enum:
        - PARTIALLY_SUCCEEDED
        - COMPLETELY_FAILED
        type: string
      lifecycleState:
        description: The current state of the batch document job.
        enum:
        - SUCCEEDED
        - FAILED
        - ACCEPTED
        - CANCELED
        - IN_PROGRESS
        - CANCELING
        type: string
      outputLocation:
        $ref: '#/definitions/OutputLocation'
      percentComplete:
        description: How much progress the operation has made, compared to the total
          amount of work to be performed.
        format: float
        maximum: 100
        minimum: 0
        type: number
      timeAccepted:
        description: The job acceptance time.
        format: date-time
        type: string
      timeFinished:
        description: The job finish time.
        format: date-time
        type: string
      timeStarted:
        description: The job start time.
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    - features
    - timeAccepted
    - outputLocation
    - lifecycleState
    type: object
  DocumentKeyValueDetectionFeature:
    allOf:
    - $ref: '#/definitions/DocumentFeature'
    - discriminator: KEY_VALUE_DETECTION
    description: Extracting form fields.
  DocumentLanguage:
    description: The language of the document, abbreviated according to ISO 639-2.
    enum: *id002
    type: string
  DocumentLanguageClassificationFeature:
    allOf:
    - $ref: '#/definitions/DocumentFeature'
    - discriminator: LANGUAGE_CLASSIFICATION
      properties:
        maxResults:
          default: 5
          description: The maximum number of results to return.
          type: integer
    description: Detecting the language of the document.
  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
  DocumentTableDetectionFeature:
    allOf:
    - $ref: '#/definitions/DocumentFeature'
    - discriminator: TABLE_DETECTION
    description: Detecting and extracting data in tables.
  DocumentTextDetectionFeature:
    allOf:
    - $ref: '#/definitions/DocumentFeature'
    - discriminator: TEXT_DETECTION
      properties:
        generateSearchablePdf:
          default: false
          description: Whether or not to generate a searchable PDF file.
          type: boolean
    description: Text recognition
  DocumentType:
    description: The type of document.
    enum: *id001
    type: string
  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
  Face:
    description: The detected face.
    properties:
      boundingPolygon:
        $ref: '#/definitions/BoundingPolygon'
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      landmarks:
        description: A point of interest within a face.
        items:
          $ref: '#/definitions/Landmark'
        maxItems: 1000
        type: array
      qualityScore:
        description: The quality score of the face detected, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
    required:
    - confidence
    - boundingPolygon
    - qualityScore
    type: object
  FaceDetectionFeature:
    allOf:
    - $ref: '#/definitions/ImageFeature'
    - discriminator: FACE_DETECTION
      properties:
        maxResults:
          default: 50
          description: The maximum number of results to return.
          type: integer
        shouldReturnLandmarks:
          default: false
          description: Whether or not return face landmarks.
          type: boolean
    description: The face detection parameters.
  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
  FieldName:
    description: The name of a form field.
    properties:
      boundingPolygon:
        $ref: '#/definitions/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
  FieldValue:
    description: The value of a form field.
    discriminator: valueType
    properties:
      boundingPolygon:
        $ref: '#/definitions/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
  ImageClassificationFeature:
    allOf:
    - $ref: '#/definitions/ImageFeature'
    - discriminator: IMAGE_CLASSIFICATION
      properties:
        maxResults:
          default: 5
          description: The maximum number of results to return.
          type: integer
        modelId:
          description: The custom model ID.
          type: string
          x-default-description: when null or absent, the default generic model will
            be used
    description: The image classification parameters.
  ImageDetails:
    description: The details of an image to analyze.
    discriminator: source
    properties:
      source:
        description: 'The location of the image data.

          The allowed values are:

          - `INLINE`: The data is included directly in the request payload.

          - `OBJECT_STORAGE`: The image is in OCI Object Storage.

          '
        enum:
        - INLINE
        - OBJECT_STORAGE
        type: string
    required:
    - source
    type: object
  ImageFeature:
    description: The type of image analysis.
    discriminator: featureType
    properties:
      featureType:
        description: 'The type of image analysis requested.

          The allowed values are:

          - `IMAGE_CLASSIFICATION`: Label the image.

          - `OBJECT_DETECTION`: Identify objects in the image with bounding boxes.

          - `TEXT_DETECTION`: Recognize text at the word and line level.

          - `FACE_DETECTION`: Identify faces in the image with bounding boxes and
          face landmarks.

          '
        enum:
        - IMAGE_CLASSIFICATION
        - OBJECT_DETECTION
        - TEXT_DETECTION
        - FACE_DETECTION
        type: string
    required:
    - featureType
    type: object
  ImageJob:
    description: The job details for a batch image analysis.
    properties:
      compartmentId:
        description: The OCID of the compartment that starts the job.
        type: string
      displayName:
        description: The image job display name.
        maxLength: 255
        minLength: 1
        type: string
      features:
        description: The list of requested document analysis types.
        items:
          $ref: '#/definitions/ImageFeature'
        minItems: 1
        type: array
      id:
        description: The job id
        type: string
      inputLocation:
        $ref: '#/definitions/InputLocation'
      isZipOutputEnabled:
        default: false
        description: Whether or not to generate a ZIP file containing the results.
        type: boolean
      lifecycleDetails:
        description: The detailed status of FAILED state.
        enum:
        - PARTIALLY_SUCCEEDED
        - COMPLETELY_FAILED
        type: string
      lifecycleState:
        description: The current state of the batch image job.
        enum:
        - SUCCEEDED
        - FAILED
        - ACCEPTED
        - CANCELED
        - IN_PROGRESS
        - CANCELING
        type: string
      outputLocation:
        $ref: '#/definitions/OutputLocation'
      percentComplete:
        description: How much progress the operation has made, compared to the total
          amount of work to be performed.
        format: float
        maximum: 100
        minimum: 0
        type: number
      timeAccepted:
        description: The job acceptance time.
        format: date-time
        type: string
      timeFinished:
        description: The job finish time.
        format: date-time
        type: string
      timeStarted:
        description: The job start time.
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    - features
    - timeAccepted
    - outputLocation
    - lifecycleState
    type: object
  ImageObject:
    description: The object detected in an image.
    properties:
      boundingPolygon:
        $ref: '#/definitions/BoundingPolygon'
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      name:
        description: The object category name. Every value returned by the pre-deployed
          model is in English.
        maxLength: 255
        minLength: 1
        type: string
    required:
    - name
    - confidence
    - boundingPolygon
    type: object
  ImageObjectDetectionFeature:
    allOf:
    - $ref: '#/definitions/ImageFeature'
    - discriminator: OBJECT_DETECTION
      properties:
        maxResults:
          default: 5
          description: The maximum number of results to return.
          type: integer
        modelId:
          description: The custom model ID.
          type: string
          x-default-description: when null or absent, the default generic model will
            be used
    description: The object detection parameters.
  ImageText:
    description: The detected text.
    properties:
      lines:
        description: The lines of text recognized in an image.
        items:
          $ref: '#/definitions/Line'
        type: array
      words:
        description: The words recognized in an image.
        items:
          $ref: '#/definitions/Word'
        type: array
    required:
    - words
    - lines
    type: object
  ImageTextDetectionFeature:
    allOf:
    - $ref: '#/definitions/ImageFeature'
    - discriminator: TEXT_DETECTION
      properties:
        language:
          description: The language of the document image, abbreviated according to
            ISO 639-2.
          enum: *id002
          type: string
          x-obmcs-top-level-enum: '#/definitions/DocumentLanguage'
    description: The text detection parameters.
  InlineDocumentDetails:
    allOf:
    - $ref: '#/definitions/DocumentDetails'
    - discriminator: INLINE
      properties:
        data:
          description: Raw document data.
          format: byte
          maxLength: 11534336
          type: string
      required:
      - data
    description: The document incorporated in the request payload.
  InlineImageDetails:
    allOf:
    - $ref: '#/definitions/ImageDetails'
    - discriminator: INLINE
      properties:
        data:
          description: Raw image data.
          format: byte
          maxLength: 11534336
          type: string
      required:
      - data
    description: The image incorporated in the request payload.
  InputLocation:
    description: The location of the inputs.
    discriminator: sourceType
    properties:
      sourceType:
        description: 'The type of input location.

          The allowed values are:

          - `OBJECT_LIST_INLINE_INPUT_LOCATION`: A list of object locations in Object
          Storage.

          '
        enum:
        - OBJECT_LIST_INLINE_INPUT_LOCATION
        type: string
    required:
    - sourceType
    type: object
  Label:
    description: A label describing an image. Every label returned by the pre-deployed
      model is in English.
    example:
      confidence: 0.85
      name: car
    properties:
      confidence:
        description: The confidence score between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      name:
        description: The classification catagory label name.
        type: string
    required:
    - name
    - confidence
    type: object
  Landmark:
    description: The landmark on the face.
    properties:
      type:
        description: The face landmark type
        enum:
        - LEFT_EYE
        - RIGHT_EYE
        - NOSE_TIP
        - LEFT_EDGE_OF_MOUTH
        - RIGHT_EDGE_OF_MOUTH
        type: string
      x:
        description: The X-axis normalized coordinate.
        format: float
        maximum: 1
        minimum: 0
        type: number
      y:
        description: The Y-axis normalized coordinate.
        format: float
        maximum: 1
        minimum: 0
        type: number
    required:
    - type
    - x
    - y
    type: object
  Line:
    description: The line of text.
    properties:
      boundingPolygon:
        $ref: '#/definitions/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
  Model:
    description: Machine-learned Model.
    properties:
      averagePrecision:
        description: The mean average precision of the trained model.
        format: float
        type: number
      compartmentId:
        description: The compartment identifier.
        type: string
      confidenceThreshold:
        description: The intersection over the union threshold used for calculating
          precision and recall.
        format: float
        type: number
      definedTags: *id003
      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: *id004
      id:
        description: A unique identifier that is immutable after creation.
        maxLength: 255
        minLength: 1
        type: string
      isQuickMode:
        default: false
        description: Set to true when experimenting with a new model type or dataset,
          so model training is quick, with a predefined low number of passes through
          the training data.
        type: boolean
      lifecycleDetails:
        description: A message describing the current state in more detail, that can
          provide actionable information if training failed.
        type: string
      lifecycleState:
        description: The current state of the model.
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        type: string
      maxTrainingDurationInHours:
        description: The maximum model training duration in hours, expressed as a
          decimal fraction.
        format: double
        type: number
      metrics:
        description: The complete set of per-label metrics for successfully trained
          models.
        type: string
      modelType:
        description: What type of Vision model this is.
        enum:
        - IMAGE_CLASSIFICATION
        - OBJECT_DETECTION
        type: string
      modelVersion:
        description: The version of the model.
        type: string
      precision:
        description: The precision of the trained model.
        format: float
        type: number
      projectId:
        description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of
          the project that contains the model.
        maxLength: 255
        minLength: 1
        type: string
      recall:
        description: Recall of the trained model.
        format: float
        type: number
      systemTags: &id005
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only string, integer, and boolean
              types are supported.

              '
            type: object
          description: 'A key-value pair representing system tags'' keys and values
            scoped to a namespace.

            For example: `{"bar-key": "value"}`

            '
          type: object
        description: 'Usage of system tag keys. These predefined keys are scoped to
          namespaces.

          For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

          '
        type: object
      testImageCount:
        description: The number of images set aside for evaluating model performance
          metrics after training.
        type: integer
      testingDataset:
        $ref: '#/definitions/Dataset'
      timeCreated:
        description: When the model was created, as an RFC3339 datetime string.
        format: date-time
        type: string
      timeUpdated:
        description: When the model was updated, as an RFC3339 datetime string.
        format: date-time
        type: string
      totalImageCount:
        description: The number of images in the dataset used to train, validate,
          and test the model.
        type: integer
      trainedDurationInHours:
        description: The total hours actually used for model training.
        format: double
        type: number
      trainingDataset:
        $ref: '#/definitions/Dataset'
      validationDataset:
        $ref: '#/definitions/Dataset'
    required:
    - id
    - compartmentId
    - projectId
    - modelType
    - modelVersion
    - trainingDataset
    - timeCreated
    - lifecycleState
    type: object
  ModelCollection:
    description: The results of a model search.
    properties:
      items:
        description: A list of models.
        items:
          $ref: '#/definitions/ModelSummary'
        type: array
    required:
    - items
    type: object
  ModelSummary:
    description: The metadata about the model.
    properties:
      compartmentId:
        description: The compartment identifier.
        type: string
      definedTags: *id003
      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: *id004
      id:
        description: A unique identifier that is immutable after creation.
        maxLength: 255
        minLength: 1
        type: string
      lifecycleDetails:
        description: A message describing the current state in more detail, that can
          provide actionable information if training failed.
        type: string
      lifecycleState:
        description: The current state of the model.
        type: string
        x-obmcs-enumref: '#/definitions/Model/lifecycleState'
      modelType:
        description: What type of Vision model this is.
        type: string
        x-obmcs-enumref: '#/definitions/Model/modelType'
      modelVersion:
        description: The version of the model.
        type: string
      precision:
        description: The precision of the trained model.
        format: float
        type: number
      projectId:
        description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of
          the project that contains the model.
        maxLength: 255
        minLength: 1
        type: string
      systemTags: *id005
      testingDataset:
        $ref: '#/definitions/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: '#/definitions/Dataset'
      validationDataset:
        $ref: '#/definitions/Dataset'
    required:
    - id
    - compartmentId
    - modelType
    - timeCreated
    - lifecycleState
    - projectId
    - modelVersion
    type: object
  ModelVersionDetails:
    description: Model version for object detection/tracking.
    properties:
      modelVersion:
        description: Model version or ocid
        type: string
      objects:
        description: List of the object category labels.
        items:
          type: string
        minLength: 1
        type: array
    required:
    - objects
    - modelVersion
    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
  ObjectListInlineInputLocation:
    allOf:
    - $ref: '#/definitions/InputLocation'
    - discriminator: OBJECT_LIST_INLINE_INPUT_LOCATION
      properties:
        objectLocations:
          description: The list of ObjectLocations.
          items:
            $ref: '#/definitions/ObjectLocation'
          maxItems: 2000
          minItems: 1
          type: array
      required:
      - objectLocations
    description: A list of object locations in Object Storage.
  ObjectLocation:
    description: A location in Object Storage that is uniquely identified by namespace
      name, bucket name and object name.
    properties:
      bucketName:
        description: The Object Storage bucket name.
        maxLength: 1024
        minLength: 1
        type: string
      namespaceName:
        description: The Object Storage namespace name.
        maxLength: 1024
        minLength: 1
        type: string
      objectName:
        description: The Object Storage object name.
        maxLength: 1024
        minLength: 1
        type: string
    required:
    - namespaceName
    - bucketName
    - objectName
    type: object
  ObjectProperties:
    description: Properties associated with the object.
    properties:
      embeddings:
        description: The facial feature vectors of detected faces.
        items:
          format: float
          type: number
        maxItems: 1000
        type: array
      landmarks:
        description: Face landmarks.
        items:
          $ref: '#/definitions/Landmark'
        type: array
      qualityScore:
        description: The quality score of the face detected, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
    type: object
  ObjectProperty:
    description: A property of a tracked object in a frame.
    properties:
      boundingPolygon:
        $ref: '#/definitions/BoundingPolygon'
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      name:
        description: Property name
        minLength: 1
        type: string
    required:
    - name
    - confidence
    - boundingPolygon
    type: object
  ObjectStorageDataset:
    allOf:
    - $ref: '#/definitions/Dataset'
    - discriminator: OBJECT_STORAGE
      properties:
        bucketName:
          description: The name of the Object Storage bucket that contains the input
            data file.
          type: string
        namespaceName:
          description: The namespace name of the Object Storage bucket that contains
            the input data file.
          type: string
        objectName:
          description: The object name of the input data file.
          type: string
      required:
      - namespaceName
      - bucketName
      - objectName
    description: The dataset that resides in Object Storage.
  ObjectStorageDocumentDetails:
    allOf:
    - $ref: '#/definitions/DocumentDetails'
    - discriminator: OBJECT_STORAGE
      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
        objectName:
          description: The Object Storage object name.
          maxLength: 1024
          minLength: 1
          type: string
      required:
      - namespaceName
      - bucketName
      - objectName
    description: A document in OCI Object Storage.
  ObjectStorageImageDetails:
    allOf:
    - $ref: '#/definitions/ImageDetails'
    - discriminator: OBJECT_STORAGE
      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
        objectName:
          description: The Object Storage object name.
          type: string
      required:
      - namespaceName
      - bucketName
      - objectName
    description: The image residing in OCI Object Storage.
  ObjectStorageOutputLocation:
    allOf:
    - $ref: '#/definitions/StreamOutputLocation'
    - discriminator: OBJECT_STORAGE
      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
    description: The Object Storage Location.
  OntologyClass:
    description: Images and ImageObjects can be labeled with an OntologyClass.
    example:
      name: Cat
      parents:
      - Pet
      - Mammal
      synonyms:
      - Feline
    properties:
      name:
        description: The label name.
        type: string
      parentNames:
        description: The label parents.
        items:
          type: string
        minItems: 0
        type: array
      synonymNames:
        description: The label synonyms.
        items:
          type: string
        minItems: 0
        type: array
    required:
    - name
    type: object
  OperationStatus:
    description: Possible operation statuses.
    enum: &id007
    - ACCEPTED
    - IN_PROGRESS
    - WAITING
    - FAILED
    - SUCCEEDED
    - CANCELING
    - CANCELED
    type: string
  OperationType:
    description: Possible operation types.
    enum: &id006
    - CREATE_PROJECT
    - UPDATE_PROJECT
    - DELETE_PROJECT
    - MOVE_PROJECT
    - CREATE_MODEL
    - UPDATE_MODEL
    - DELETE_MODEL
    - MOVE_MODEL
    - ADD_STREAM_SOURCE
    - UPDATE_STREAM_SOURCE
    - DELETE_STREAM_SOURCE
    - MOVE_STREAM_SOURCE
    - CREATE_STREAM_JOB
    - DELETE_STREAM_JOB
    - UPDATE_STREAM_JOB
    - START_STREAM_JOB
    - STOP_STREAM_JOB
    - MOVE_STREAM_JOB
    - ADD_STREAM_GROUP
    - UPDATE_STREAM_GROUP
    - DELETE_STREAM_GROUP
    - CREATE_VISION_PRIVATE_ENDPOINT
    - UPDATE_VISION_PRIVATE_ENDPOINT
    - DELETE_VISION_PRIVATE_ENDPOINT
    - MOVE_VISION_PRIVATE_ENDPOINT
    type: string
  OutputLocation:
    description: The Object Storage Location.
    properties:
      bucketName:
        description: The Object Storage bucket name.
        maxLength: 255
        minLength: 1
        type: string
      namespaceName:
        description: The Object Storage namespace.
        maxLength: 255
        minLength: 1
        type: string
      prefix:
        description: The Object Storage folder name.
        maxLength: 1024
        minLength: 0
        type: string
    required:
    - namespaceName
    - bucketName
    - prefix
    type: object
  Page:
    description: One page document analysis result.
    properties:
      detectedDocumentTypes:
        description: An array of detected document types.
        items:
          $ref: '#/definitions/DetectedDocumentType'
        type: array
      detectedLanguages:
        description: An array of detected languages.
        items:
          $ref: '#/definitions/DetectedLanguage'
        type: array
      dimensions:
        $ref: '#/definitions/Dimensions'
      documentFields:
        description: The form fields detected on the page.
        items:
          $ref: '#/definitions/DocumentField'
        type: array
      lines:
        description: The lines of text detected on the page.
        items:
          $ref: '#/definitions/Line'
        type: array
      pageNumber:
        description: The document page number.
        minimum: 1
        type: integer
      tables:
        description: The tables detected on the page.
        items:
          $ref: '#/definitions/Table'
        type: array
      words:
        description: The words detected on the page.
        items:
          $ref: '#/definitions/Word'
        type: array
    required:
    - pageNumber
    type: object
  PrivateStreamNetworkAccessDetails:
    allOf:
    - $ref: '#/definitions/StreamNetworkAccessDetails'
    - discriminator: PRIVATE
      properties:
        privateEndpointId:
          description: '[OCID](/Content/General/Concepts/identifiers.htm) of the private
            Endpoint

            '
          type: string
      required:
      - privateEndpointId
    description: Details of private endpoint to connect to stream
  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
  Project:
    description: A Vision Project containing models.
    properties:
      compartmentId:
        description: A compartment identifier.
        type: string
      definedTags: *id003
      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: *id004
      id:
        description: A unique identifier that is immutable after creation.
        maxLength: 255
        minLength: 1
        type: string
      lifecycleDetails:
        description: A message describing the current state in more detail, that can
          provide actionable information if creation failed.
        type: string
      lifecycleState:
        description: The current state of the project.
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        type: string
      systemTags: *id005
      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
  ProjectCollection:
    description: The results of a project search.
    properties:
      items:
        description: List of projects.
        items:
          $ref: '#/definitions/ProjectSummary'
        type: array
    required:
    - items
    type: object
  ProjectSummary:
    description: the metadata about the project.
    properties:
      compartmentId:
        description: The compartment identifier.
        maxLength: 255
        minLength: 1
        type: string
      definedTags: *id003
      displayName:
        description: A human-friendly name for the project, that can be changed.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      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: *id005
      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
  RtspSourceDetails:
    allOf:
    - $ref: '#/definitions/StreamSourceDetails'
    - discriminator: RTSP
      properties:
        cameraUrl:
          description: url of camera
          maxLength: 1000
          minLength: 1
          type: string
        secretId:
          description: '[OCID](/Content/General/Concepts/identifiers.htm) of secret
            where credentials are stored in username:password format.

            '
          type: string
      required:
      - cameraUrl
    description: Details of RtspDevice
  SortOrder:
    description: Sort order.
    enum: &id009
    - ASC
    - DESC
    type: string
  StreamGroup:
    description: Details for a Stream Group
    properties:
      compartmentId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment

          '
        type: string
      definedTags: *id003
      displayName:
        description: A human-friendly name for the streamGroup.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      id:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamGroup.

          '
        type: string
      isEnabled:
        description: Stream
        type: boolean
      lifecycleState:
        description: The current state of the streamGroup.
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        type: string
      streamOverlaps:
        description: List of streamSource OCIDs where the streamSource overlaps in
          field of view.
        items:
          $ref: '#/definitions/StreamGroupOverlap'
        type: array
      streamSourceIds:
        description: List of streamSource OCIDs associated with the stream group
        items:
          type: string
        type: array
      systemTags: *id005
      timeCreated:
        description: When the streamGroup was created, as an RFC3339 datetime string.
        format: date-time
        type: string
      timeUpdated:
        description: When the streamGroup was updated, as an RFC3339 datetime string.
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    type: object
  StreamGroupCollection:
    description: The results of a streamGroup search.
    properties:
      items:
        description: List of StreamGroups.
        items:
          $ref: '#/definitions/StreamGroupSummary'
        type: array
    required:
    - items
    type: object
  StreamGroupOverlap:
    description: List of streamSource OCIDs that have overlapping fields of view
    properties:
      overlappingStreams:
        description: List of streamSource OCIDs.
        items:
          type: string
        type: array
    type: object
  StreamGroupSummary:
    description: Summary for a Stream Group
    properties:
      compartmentId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment

          '
        type: string
      definedTags: *id003
      displayName:
        description: A human-friendly name for the streamGroup.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      id:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamGroup.

          '
        type: string
      isEnabled:
        description: Stream
        type: boolean
      lifecycleState:
        description: The current state of the streamGroup.
        type: string
        x-obmcs-enumref: '#/definitions/StreamGroup/lifecycleState'
      streamOverlaps:
        description: List of streamSource OCIDs where the streamSource overlaps in
          field of view.
        items:
          $ref: '#/definitions/StreamGroupOverlap'
        type: array
      streamSourceIds:
        description: List of streamSource OCIDs associated with the stream group
        items:
          type: string
        type: array
      systemTags: *id005
      timeCreated:
        description: When the streamGroup was created, as an RFC3339 datetime string.
        format: date-time
        type: string
      timeUpdated:
        description: When the streamGroup was updated, as an RFC3339 datetime string.
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    type: object
  StreamJob:
    description: Job details for a stream analysis.
    properties:
      agentParticipantId:
        description: participant id of agent where results need to be sent
        type: string
      compartmentId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment

          '
        type: string
      definedTags: *id003
      displayName:
        description: Stream job display name.
        maxLength: 255
        minLength: 1
        type: string
      features:
        description: a list of document analysis features.
        items:
          $ref: '#/definitions/VideoStreamFeature'
        maxItems: 1
        minItems: 1
        type: array
      freeformTags: *id004
      id:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamJob.

          '
        type: string
      lifecycleDetails:
        description: Additional details about current state of streamJob
        type: string
      lifecycleState:
        description: The current state of the Stream job.
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        - INACTIVE
        - NEEDS_ATTENTION
        type: string
      streamOutputLocation:
        $ref: '#/definitions/StreamOutputLocation'
      streamSourceId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamSource

          '
        type: string
      systemTags: *id005
      timeCreated:
        description: When the streamJob was created, as an RFC3339 datetime string.
        format: date-time
        type: string
      timeUpdated:
        description: When the stream job was updated, as an RFC3339 datetime string.
        format: date-time
        type: string
    required:
    - id
    - streamSourceId
    - features
    - lifecycleState
    - timeCreated
    - compartmentId
    type: object
  StreamJobCollection:
    description: The results of a stream job search.
    properties:
      items:
        description: List of stream jobs.
        items:
          $ref: '#/definitions/StreamJobSummary'
        type: array
    required:
    - items
    type: object
  StreamJobSummary:
    description: Job details for a stream analysis.
    properties:
      compartmentId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of compartment

          '
        type: string
      definedTags: *id003
      displayName:
        description: Stream job display name.
        maxLength: 255
        minLength: 1
        type: string
      features:
        description: List of document analysis features.
        items:
          $ref: '#/definitions/VideoStreamFeature'
        maxItems: 10
        minItems: 1
        type: array
      freeformTags: *id004
      id:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamJob.

          '
        type: string
      lifecycleDetails:
        description: Additional Details of the state of streamJob
        type: string
      lifecycleState:
        description: The current state of the Stream job.
        type: string
        x-obmcs-enumref: '#/definitions/StreamJob/lifecycleState'
      streamOutputLocation:
        $ref: '#/definitions/StreamOutputLocation'
      streamSourceId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamSource

          '
        type: string
      systemTags: *id005
      timeCreated:
        description: When the streamJob was created, as an RFC3339 datetime string.
        format: date-time
        type: string
      timeUpdated:
        description: When the streamJob was updated, as an RFC3339 datetime string.
        format: date-time
        type: string
    required:
    - id
    - streamSourceId
    - features
    - lifecycleState
    - lifecycleDetails
    - timeCreated
    - compartmentId
    type: object
  StreamNetworkAccessDetails:
    description: Details about a stream Connection type
    discriminator: streamAccessType
    properties:
      streamAccessType:
        description: 'Type of access

          Allowed values are:

          - PRIVATE

          '
        enum:
        - PRIVATE
        type: string
    required:
    - streamAccessType
    type: object
  StreamOutputLocation:
    description: Details about a where results will be Sent
    discriminator: outputLocationType
    properties:
      outputLocationType:
        description: 'Type of output location

          Allowed values are:

          - OBJECT_STORAGE

          '
        enum:
        - OBJECT_STORAGE
        type: string
    required:
    - outputLocationType
    type: object
  StreamSource:
    description: Stream source information
    properties:
      compartmentId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the compartm.

          '
        type: string
      definedTags: *id003
      displayName:
        description: display name.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      id:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamSource.

          '
        type: string
      lifecycleState:
        description: The current state of the streamSource.
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        type: string
      streamSourceDetails:
        $ref: '#/definitions/StreamSourceDetails'
      systemTags: *id005
      timeCreated:
        description: When the streamSource was created, as an RFC3339 datetime string.
        format: date-time
        type: string
      timeUpdated:
        description: When the streamSource was updated, as an RFC3339 datetime string.
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    - timeCreated
    - lifecycleState
    - streamSourceDetails
    type: object
  StreamSourceCollection:
    description: The results of a streamSource search.
    properties:
      items:
        description: List of StreamSources.
        items:
          $ref: '#/definitions/StreamSourceSummary'
        type: array
    required:
    - items
    type: object
  StreamSourceDetails:
    description: Details about a stream source
    discriminator: sourceType
    properties:
      sourceType:
        description: 'Type of source

          Allowed values are:

          - RTSP

          '
        enum:
        - RTSP
        type: string
      streamNetworkAccessDetails:
        $ref: '#/definitions/StreamNetworkAccessDetails'
    required:
    - sourceType
    - streamNetworkAccessDetails
    type: object
  StreamSourceSummary:
    description: Video stream analysis results.
    properties:
      compartmentId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the compartment.

          '
        type: string
      definedTags: *id003
      displayName:
        description: StreamSource  display name.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      id:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of the streamSource.

          '
        type: string
      lifecycleState:
        description: The current state of the streamSource.
        type: string
        x-obmcs-enumref: '#/definitions/StreamSource/lifecycleState'
      streamSourceDetails:
        $ref: '#/definitions/StreamSourceDetails'
      systemTags: *id005
      timeCreated:
        description: When the streamSource was created, as an RFC3339 datetime string.
        format: date-time
        type: string
      timeUpdated:
        description: When the streamSource was created, as an RFC3339 datetime string.
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    - timeCreated
    - lifecycleState
    - streamSourceDetails
    type: object
  Table:
    description: The table extracted from a document.
    properties:
      bodyRows:
        description: The body rows.
        items:
          $ref: '#/definitions/TableRow'
        type: array
      boundingPolygon:
        $ref: '#/definitions/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: '#/definitions/TableRow'
        type: array
      headerRows:
        description: The header rows.
        items:
          $ref: '#/definitions/TableRow'
        type: array
      rowCount:
        description: The number of rows.
        minimum: 0
        type: integer
    required:
    - rowCount
    - columnCount
    - headerRows
    - bodyRows
    - footerRows
    - confidence
    - boundingPolygon
    type: object
  TableRow:
    description: A single row in a table.
    properties:
      cells:
        description: The cells in the row.
        items:
          $ref: '#/definitions/Cell'
        type: array
    required:
    - cells
  TrackingType:
    description: Details of what to track.
    properties:
      detectionModelId:
        description: The detection model OCID.
        type: string
      maxResults:
        default: 50
        description: The maximum number of results to return.
        type: integer
      objects:
        description: List of the objects to be tracked.
        items:
          type: string
        maxLength: 100
        minLength: 1
        type: array
      shouldReturnLandmarks:
        default: false
        description: Whether or not return face landmarks.
        type: boolean
      trackingModelId:
        description: The tracking model OCID.
        type: string
    required:
    - objects
    type: object
  UpdateModelDetails:
    description: The metadata which can be edited after model creation.
    properties:
      definedTags: *id003
      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: *id004
    type: object
  UpdateProjectDetails:
    description: The metadata that can be edited after project creation.
    properties:
      definedTags: *id003
      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: *id004
    type: object
  UpdateStreamGroupDetails:
    description: The information needed to create a stream group
    properties:
      definedTags: *id003
      displayName:
        description: A human-friendly name for the streamGroup.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      isEnabled:
        description: Stream
        type: boolean
      streamOverlaps:
        description: List of streamSource OCIDs where the streamSource overlaps in
          field of view.
        items:
          $ref: '#/definitions/StreamGroupOverlap'
        type: array
      streamSourceIds:
        description: List of streamSource OCIDs associated with the stream group
        items:
          type: string
        type: array
    type: object
  UpdateStreamJobDetails:
    description: The information needed to update streamjob
    properties:
      definedTags: *id003
      displayName:
        description: Stream job display name.
        maxLength: 255
        minLength: 1
        type: string
      features:
        description: List of stream analysis features.
        items:
          $ref: '#/definitions/VideoStreamFeature'
        maxItems: 1
        minItems: 1
        type: array
      freeformTags: *id004
      streamOutputLocation:
        $ref: '#/definitions/StreamOutputLocation'
      streamSourceId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of streamSource

          '
        type: string
    type: object
  UpdateStreamSourceDetails:
    description: The information needed to update stream source
    properties:
      definedTags: *id003
      displayName:
        description: A human-friendly name for the streamSource, that can be changed.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      streamSourceDetails:
        $ref: '#/definitions/StreamSourceDetails'
    type: object
  UpdateVisionPrivateEndpointDetails:
    description: The metadata that can be edited after visionPrivateEndpoint creation.
    properties:
      definedTags: *id003
      description:
        description: An optional description of the visionPrivateEndpoint.
        type: string
      displayName:
        description: A human-friendly name for the visionPrivateEndpoint, that can
          be changed.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
    type: object
  ValueArray:
    allOf:
    - $ref: '#/definitions/FieldValue'
    - discriminator: ARRAY
      properties:
        items:
          items:
            $ref: '#/definitions/DocumentField'
          type: array
      required:
      - items
    description: The array of field values.
  ValueDate:
    allOf:
    - $ref: '#/definitions/FieldValue'
    - discriminator: DATE
      properties:
        value:
          description: The date field value as yyyy-mm-dd.
          format: date-time
          type: string
      required:
      - value
    description: The date field value.
  ValueInteger:
    allOf:
    - $ref: '#/definitions/FieldValue'
    - discriminator: INTEGER
      properties:
        value:
          description: The integer value.
          type: integer
      required:
      - value
    description: The integer field value.
  ValueNumber:
    allOf:
    - $ref: '#/definitions/FieldValue'
    - discriminator: NUMBER
      properties:
        value:
          description: The number value.
          format: float
          type: number
      required:
      - value
    description: The floating point number field value.
  ValuePhoneNumber:
    allOf:
    - $ref: '#/definitions/FieldValue'
    - discriminator: PHONE_NUMBER
      properties:
        value:
          description: The phone number field value.
          maxLength: 20
          minLength: 1
          type: string
      required:
      - value
    description: The phone number field value.
  ValueString:
    allOf:
    - $ref: '#/definitions/FieldValue'
    - discriminator: STRING
      properties:
        value:
          description: The string text.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - value
    description: The string field value.
  ValueTime:
    allOf:
    - $ref: '#/definitions/FieldValue'
    - discriminator: TIME
      properties:
        value:
          description: The time field value as yyyy-mm-dd hh-mm-ss.
          format: date-time
          type: string
      required:
      - value
    description: The time field value.
  VideoFace:
    description: Detected face in a video.
    properties:
      segments:
        description: Face segments in a video.
        items:
          $ref: '#/definitions/VideoFaceSegment'
        type: array
    required:
    - segments
    type: object
  VideoFaceDetectionFeature:
    allOf:
    - $ref: '#/definitions/VideoFeature'
    - discriminator: FACE_DETECTION
      properties:
        isLandmarkRequired:
          default: false
          description: Whether or not return face landmarks.
          type: boolean
        maxResults:
          default: 50
          description: The maximum number of results per frame to return.
          type: integer
        minConfidence:
          description: 'The minimum confidence score, between 0 and 1,

            when the value is set, results with lower confidence will not be returned.

            '
          format: float
          maximum: 1
          minimum: 0
          type: number
    description: Video face detection feature
  VideoFaceFrame:
    description: A face frame.
    properties:
      boundingPolygon:
        $ref: '#/definitions/BoundingPolygon'
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      landmarks:
        description: Face landmarks.
        items:
          $ref: '#/definitions/Landmark'
        type: array
      qualityScore:
        description: The quality score of the face detected, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      timeOffsetMs:
        description: Time offset(Milliseconds) in the video.
        minimum: 0
        type: integer
    required:
    - timeOffsetMs
    - confidence
    - qualityScore
    - boundingPolygon
    type: object
  VideoFaceSegment:
    description: A face segment in a video.
    properties:
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      frames:
        description: Face frames in a segment.
        items:
          $ref: '#/definitions/VideoFaceFrame'
        type: array
      videoSegment:
        $ref: '#/definitions/VideoSegment'
    required:
    - videoSegment
    - confidence
    - frames
    type: object
  VideoFeature:
    description: Details about a video feature request.
    discriminator: featureType
    properties:
      featureType:
        description: 'The feature of video analysis.

          Allowed values are:

          - LABEL_DETECTION: Label detection feature(IC).

          - OBJECT_DETECTION: Object detection feature(OD).

          - TEXT_DETECTION: Text detection feature(OCR).

          - FACE_DETECTION: Face detection feature(fd).

          - OBJECT_TRACKING: Object tracking feature(OT).

          '
        enum:
        - LABEL_DETECTION
        - OBJECT_DETECTION
        - TEXT_DETECTION
        - FACE_DETECTION
        - OBJECT_TRACKING
        type: string
    required:
    - featureType
    type: object
  VideoJob:
    description: Job details for a video analysis.
    properties:
      compartmentId:
        description: The ocid of the compartment that starts the job.
        type: string
      definedTags: *id003
      displayName:
        description: Video job display name.
        maxLength: 255
        minLength: 1
        type: string
      features:
        description: a list of document analysis features.
        items:
          $ref: '#/definitions/VideoFeature'
        minItems: 1
        type: array
      freeformTags: *id004
      id:
        description: Id of the job.
        type: string
      inputLocation:
        $ref: '#/definitions/InputLocation'
      lifecycleDetails:
        description: Detailed status of FAILED state.
        enum:
        - PARTIALLY_SUCCEEDED
        - COMPLETELY_FAILED
        type: string
      lifecycleState:
        description: The current state of the video job.
        enum:
        - SUCCEEDED
        - FAILED
        - ACCEPTED
        - CANCELED
        - IN_PROGRESS
        - CANCELING
        type: string
      outputLocation:
        $ref: '#/definitions/OutputLocation'
      percentComplete:
        description: How much progress the operation has made, vs the total amount
          of work that must be performed.
        format: float
        maximum: 100
        minimum: 0
        type: number
      systemTags: *id005
      timeAccepted:
        description: Job accepted time.
        format: date-time
        type: string
      timeFinished:
        description: Job finished time.
        format: date-time
        type: string
      timeStarted:
        description: Job started time.
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    - features
    - timeAccepted
    - outputLocation
    - lifecycleState
    type: object
  VideoLabel:
    description: Detected label in a video.
    properties:
      name:
        description: Detected label name.
        minLength: 1
        type: string
      segments:
        description: Label segments in a video.
        items:
          $ref: '#/definitions/VideoLabelSegment'
        type: array
    required:
    - name
    - segments
    type: object
  VideoLabelDetectionFeature:
    allOf:
    - $ref: '#/definitions/VideoFeature'
    - discriminator: LABEL_DETECTION
      properties:
        maxResults:
          default: 5
          description: The maximum number of results per video frame to return.
          type: integer
        minConfidence:
          description: 'The minimum confidence score, between 0 and 1,

            when the value is set, results with lower confidence will not be returned.

            '
          format: float
          maximum: 1
          minimum: 0
          type: number
        modelId:
          description: The custom model ID.
          type: string
          x-default-description: when null or absent, the default generic model will
            be used
    description: Video label detection feature
  VideoLabelSegment:
    description: A label segment in a video.
    properties:
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      videoSegment:
        $ref: '#/definitions/VideoSegment'
    required:
    - videoSegment
    - confidence
    type: object
  VideoMetadata:
    description: Video information.
    properties:
      frameCount:
        description: Total number of frames.
        minimum: 1
        type: integer
      frameHeight:
        description: Height of each frame.
        minimum: 1
        type: integer
      frameRate:
        description: Video framerate.
        format: float
        minimum: 0
        type: number
      frameWidth:
        description: Width of each frame.
        minimum: 1
        type: integer
    required:
    - frameCount
    - frameRate
    - frameWidth
    - frameHeight
    type: object
  VideoObject:
    description: Detected object in a video.
    properties:
      name:
        description: Detected object name.
        minLength: 1
        type: string
      segments:
        description: Object segments in a video.
        items:
          $ref: '#/definitions/VideoObjectSegment'
        type: array
    required:
    - name
    - segments
    type: object
  VideoObjectDetectionFeature:
    allOf:
    - $ref: '#/definitions/VideoFeature'
    - discriminator: OBJECT_DETECTION
      properties:
        maxResults:
          default: 20
          description: The maximum number of results per frame to return.
          type: integer
        minConfidence:
          description: 'The minimum confidence score, between 0 and 1,

            when the value is set, results with lower confidence will not be returned.

            '
          format: float
          maximum: 1
          minimum: 0
          type: number
        modelId:
          description: The custom model ID.
          type: string
          x-default-description: when null or absent, the default generic model will
            be used
    description: Video object detection feature
  VideoObjectFrame:
    description: An object frame.
    properties:
      boundingPolygon:
        $ref: '#/definitions/BoundingPolygon'
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      timeOffsetMs:
        description: Time offset(Milliseconds) in the video.
        minimum: 0
        type: integer
    required:
    - timeOffsetMs
    - confidence
    - boundingPolygon
    type: object
  VideoObjectSegment:
    description: An object segment in a video.
    properties:
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      frames:
        description: Object frame in a segment.
        items:
          $ref: '#/definitions/VideoObjectFrame'
        type: array
      videoSegment:
        $ref: '#/definitions/VideoSegment'
    required:
    - videoSegment
    - confidence
    - frames
    type: object
  VideoObjectTrackingFeature:
    allOf:
    - $ref: '#/definitions/VideoFeature'
    - discriminator: OBJECT_TRACKING
      properties:
        maxResults:
          default: 20
          description: The maximum number of results per frame to return.
          type: integer
        minConfidence:
          description: 'The minimum confidence score, between 0 and 1,

            when the value is set, results with lower confidence will not be returned.

            '
          format: float
          maximum: 1
          minimum: 0
          type: number
        modelId:
          description: The custom model ID.
          type: string
          x-default-description: when null or absent, the default generic model will
            be used
    description: Video object tracking feature
  VideoSegment:
    description: A sequence of frames that was (or appears to be) continuously captured
      for a label/object/text?.
    properties:
      endTimeOffsetMs:
        description: Video end time offset(Milliseconds).
        minimum: 0
        type: integer
      startTimeOffsetMs:
        description: Video start time offset(Milliseconds).
        minimum: 0
        type: integer
    required:
    - startTimeOffsetMs
    - endTimeOffsetMs
    type: object
  VideoStreamFaceDetectionFeature:
    allOf:
    - $ref: '#/definitions/VideoStreamFeature'
    - discriminator: FACE_DETECTION
      properties:
        maxResults:
          default: 50
          description: The maximum number of results to return.
          type: integer
        minConfidence:
          description: 'The minimum confidence score, between 0 and 1,

            when the value is set, results with lower confidence will not be returned.

            '
          format: float
          maximum: 1
          minimum: 0
          type: number
        shouldReturnLandmarks:
          default: false
          description: Whether or not return face landmarks.
          type: boolean
    description: Video stream face detection feature
  VideoStreamFeature:
    description: Details about a stream video feature request.
    discriminator: featureType
    properties:
      featureType:
        description: 'The feature of video analysis.

          Allowed values are:

          - OBJECT_TRACKING: Object tracking feature(OT).

          - FACE_DETECTION: Face detection feature(FD).

          - OBJECT_DETECTION: Object detection feature(OD)

          '
        enum:
        - OBJECT_TRACKING
        - FACE_DETECTION
        - OBJECT_DETECTION
        type: string
    required:
    - featureType
    type: object
  VideoStreamMetadata:
    description: Video information.
    properties:
      frameHeight:
        description: Height of each frame.
        minimum: 1
        type: integer
      frameRate:
        description: Video framerate.
        format: float
        minimum: 0
        type: number
      frameWidth:
        description: Width of each frame.
        minimum: 1
        type: integer
    required:
    - frameRate
    - frameWidth
    - frameHeight
    type: object
  VideoStreamObject:
    description: Tracked object in a video stream.
    properties:
      boundingPolygon:
        $ref: '#/definitions/BoundingPolygon'
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      name:
        description: Name of the object category label.
        minLength: 1
        type: string
      objectId:
        description: Unique identifier for the object.
        minimum: 0
        type: integer
      properties:
        $ref: '#/definitions/ObjectProperties'
    required:
    - name
    - confidence
    - boundingPolygon
    type: object
  VideoStreamObjectDetectionFeature:
    allOf:
    - $ref: '#/definitions/VideoStreamFeature'
    - discriminator: OBJECT_DETECTION
      properties:
        maxResults:
          default: 20
          description: The maximum number of results per frame to return.
          type: integer
        minConfidence:
          description: 'The minimum confidence score, between 0 and 1,

            when the value is set, results with lower confidence will not be returned.

            '
          format: float
          maximum: 1
          minimum: 0
          type: number
    description: Video stream object detection feature
  VideoStreamObjectTrackingFeature:
    allOf:
    - $ref: '#/definitions/VideoStreamFeature'
    - discriminator: OBJECT_TRACKING
      properties:
        trackingTypes:
          description: List of details of what to track.
          items:
            $ref: '#/definitions/TrackingType'
          type: array
      required:
      - trackingTypes
    description: Video stream object tracking feature
  VideoText:
    description: Detected text in a video.
    properties:
      segments:
        description: Text segments in a video.
        items:
          $ref: '#/definitions/VideoTextSegment'
        type: array
      text:
        description: Detected text.
        minLength: 1
        type: string
    required:
    - text
    - segments
    type: object
  VideoTextDetectionFeature:
    allOf:
    - $ref: '#/definitions/VideoFeature'
    - discriminator: TEXT_DETECTION
      properties:
        minConfidence:
          description: 'The minimum confidence score, between 0 and 1,

            when the value is set, results with lower confidence will not be returned.

            '
          format: float
          maximum: 1
          minimum: 0
          type: number
    description: Video text detection feature
  VideoTextFrame:
    description: A text frame.
    properties:
      boundingPolygon:
        $ref: '#/definitions/BoundingPolygon'
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      timeOffsetMs:
        description: Time offset(Milliseconds) in the video.
        minimum: 0
        type: integer
    required:
    - timeOffsetMs
    - confidence
    - boundingPolygon
    type: object
  VideoTextSegment:
    description: A text segment in a video.
    properties:
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      frames:
        description: Text frame in a segment.
        items:
          $ref: '#/definitions/VideoTextFrame'
        type: array
      videoSegment:
        $ref: '#/definitions/VideoSegment'
    required:
    - videoSegment
    - confidence
    - frames
    type: object
  VideoTrackedObject:
    description: Tracked object in a video.
    properties:
      name:
        description: Name of the object category label.
        minLength: 1
        type: string
      objectId:
        description: Unique identifier for the object.
        minimum: 0
        type: integer
      properties:
        $ref: '#/definitions/VideoTrackedObjectProperties'
      segments:
        description: Segments for the tracked object.
        items:
          $ref: '#/definitions/VideoTrackedObjectSegment'
        type: array
    required:
    - name
    - objectId
    - segments
    type: object
  VideoTrackedObjectProperties:
    description: Properties of a tracked object in a video.
    properties:
      axleCount:
        description: The axle count value of a tracked vehicle.
        minimum: 0
        type: integer
      trailerIds:
        description: Object IDs of the trailers associated with the tracked vehicle.
        items:
          type: integer
        type: array
    type: object
  VideoTrackedObjectSegment:
    description: A segment of a tracked object in a video.
    properties:
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      frames:
        description: Frames within the segment.
        items:
          $ref: '#/definitions/VideoTrackingFrame'
        type: array
      videoSegment:
        $ref: '#/definitions/VideoSegment'
    required:
    - videoSegment
    - confidence
    - frames
    type: object
  VideoTrackingFrame:
    description: A frame capturing a tracked object.
    properties:
      boundingPolygon:
        $ref: '#/definitions/BoundingPolygon'
      confidence:
        description: The confidence score, between 0 and 1.
        format: float
        maximum: 1
        minimum: 0
        type: number
      properties:
        description: Properties associated with the tracked object in the frame.
        items:
          $ref: '#/definitions/ObjectProperty'
        type: array
      timeOffsetMs:
        description: Time offset(Milliseconds) of the frame.
        minimum: 0
        type: integer
    required:
    - timeOffsetMs
    - confidence
    - boundingPolygon
    type: object
  VisionPrivateEndpoint:
    description: Vision private endpoint.
    properties:
      compartmentId:
        description: A compartment identifier.
        type: string
      definedTags: *id003
      description:
        description: An optional description of the visionPrivateEndpoint.
        maxLength: 400
        minLength: 1
        type: string
      displayName:
        description: A human-friendly name for the visionPrivateEndpoint, which can
          be changed.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      id:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of private
          endpoint

          '
        maxLength: 255
        minLength: 1
        type: string
      lifecycleDetails:
        description: A message describing the current state in more detail, that can
          provide actionable information if creation failed.
        type: string
      lifecycleState:
        description: The current state of the visionPrivateEndpoint.
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        type: string
      subnetId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of subnet

          '
        maxLength: 255
        minLength: 1
        type: string
      systemTags: *id005
      timeCreated:
        description: When the visionPrivateEndpoint was created, as an RFC3339 datetime
          string.
        format: date-time
        type: string
      timeUpdated:
        description: When the visionPrivateEndpoint was updated, as an RFC3339 datetime
          string.
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    - timeCreated
    - lifecycleState
    - subnetId
    type: object
  VisionPrivateEndpointCollection:
    description: The results of a visionPrivateEndpoint search.
    properties:
      items:
        description: List of visionPrivateEndpoints.
        items:
          $ref: '#/definitions/VisionPrivateEndpointSummary'
        type: array
    required:
    - items
    type: object
  VisionPrivateEndpointSummary:
    description: the metadata about the visionPrivateEndpoint.
    properties:
      compartmentId:
        description: The compartment identifier.
        maxLength: 255
        minLength: 1
        type: string
      definedTags: *id003
      displayName:
        description: A human-friendly name for the visionPrivateEndpoint, that can
          be changed.
        maxLength: 255
        minLength: 1
        type: string
      freeformTags: *id004
      id:
        description: A unique identifier that is immutable after creation.
        maxLength: 255
        minLength: 1
        type: string
      lifecycleDetails:
        description: A message describing the current state in more detail, that can
          provide actionable information if creation failed.
        type: string
      lifecycleState:
        description: The current state of the visionPrivateEndpoint.
        type: string
        x-obmcs-enumref: '#/definitions/VisionPrivateEndpoint/lifecycleState'
      subnetId:
        description: '[OCID](/Content/General/Concepts/identifiers.htm) of subnet

          '
        maxLength: 255
        minLength: 1
        type: string
      systemTags: *id005
      timeCreated:
        description: When the visionPrivateEndpoint was created, as an RFC3339 datetime
          string.
        format: date-time
        type: string
      timeUpdated:
        description: When the visionPrivateEndpoint was created, as an RFC3339 datetime
          string.
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    - timeCreated
    - lifecycleState
    - subnetId
    type: object
  Word:
    description: A single word.
    properties:
      boundingPolygon:
        $ref: '#/definitions/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
  WorkRequest:
    description: The workrequest status details.
    properties:
      compartmentId:
        description: 'The OCID of the compartment that contains the work request.
          Work requests should be scoped to

          the same compartment as the resource the work request affects.

          '
        type: string
      id:
        description: The ID of the work request.
        type: string
      operationType:
        description: The type of work request.
        enum: *id006
        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: '#/definitions/WorkRequestResource'
        type: array
      status:
        description: The status of the current work request.
        enum: *id007
        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
  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
  WorkRequestErrorCollection:
    description: The results of a workRequestError search.
    properties:
      items:
        description: the list of workRequestError objects.
        items:
          $ref: '#/definitions/WorkRequestError'
        type: array
    required:
    - items
    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
  WorkRequestLogEntryCollection:
    description: The results of a workRequestLog search.
    properties:
      items:
        description: The list of workRequestLogEntries.
        items:
          $ref: '#/definitions/WorkRequestLogEntry'
        type: array
    required:
    - items
    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: *id008
        type: string
        x-obmcs-top-level-enum: '#/definitions/ActionType'
      entityType:
        description: The resource type the work request affects.
        type: string
      entityUri:
        description: The URI path that the user can do a GET on to access the resource
          metadata.
        type: string
      identifier:
        description: The identifier of the resource the work request affects.
        type: string
    required:
    - actionType
    - entityType
    - identifier
  WorkRequestSummary:
    description: A summary of the status of a work request.
    properties:
      compartmentId:
        description: 'The OCID of the compartment that contains the work request.
          Work requests should be scoped to

          the same compartment as the resource the work request affects. If the work
          request affects multiple resources,

          and those resources are not in the same compartment, it is up to the service
          team to pick the primary

          resource whose compartment is used.

          '
        type: string
      id:
        description: The ID of the work request.
        type: string
      operationType:
        description: The type of the work request.
        enum: *id006
        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: '#/definitions/WorkRequestResource'
        type: array
      status:
        description: The status of the current work request.
        enum: *id007
        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
  WorkRequestSummaryCollection:
    description: The results of a workRequest search.
    properties:
      items:
        description: The list of workRequestSummary objects.
        items:
          $ref: '#/definitions/WorkRequestSummary'
        type: array
    required:
    - items
    type: object
host: 127.0.0.1
info:
  description: Using Vision, you can upload images to detect and classify objects
    in them. If you have lots of images, you can process them in batch using asynchronous
    API endpoints. Vision's features are thematically split between Document AI for
    document-centric images, and Image Analysis for object and scene-based images.
    Pretrained models and custom models are supported.
  title: Vision API
  version: '20220125'
parameters:
  CompartmentIdQueryParam:
    description: The ID of the compartment in which to list resources.
    in: query
    name: compartmentId
    type: string
    x-default-description: 'null'
  DisplayNameQueryParam:
    description: A filter to return only resources that match the entire display name
      given.
    in: query
    maxLength: 255
    minLength: 1
    name: displayName
    type: string
    x-default-description: 'null'
  DocumentJobIdParam:
    description: The document job ID.
    in: path
    maxLength: 255
    minLength: 1
    name: documentJobId
    required: true
    type: string
  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
    type: string
  ImageJobIdParam:
    description: The image job ID.
    in: path
    maxLength: 255
    minLength: 1
    name: imageJobId
    required: true
    type: string
  ModelIdentifierPathParam:
    description: A unique model identifier.
    in: path
    name: modelId
    required: true
    type: string
  ModelIdentifierQueryParam:
    description: The filter to find the model with the given identifier.
    in: query
    name: id
    type: string
    x-default-description: 'null'
  ModelLifecycleStateQueryParam:
    description: The filter to match models with the given lifecycleState.
    in: query
    name: lifecycleState
    required: false
    type: string
    x-default-description: 'null'
    x-obmcs-enumref: '#/definitions/Model/lifecycleState'
  PaginationLimitQueryParam:
    default: 10
    description: The maximum number of items to return.
    in: query
    maximum: 1000
    minimum: 1
    name: limit
    type: integer
  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
    minLength: 1
    name: page
    type: string
    x-default-description: 'null'
  ProjectIdQueryParam:
    description: The ID of the project for which to list the objects.
    in: query
    maxLength: 255
    minLength: 1
    name: projectId
    type: string
    x-default-description: 'null'
  ProjectIdentifierPathParam:
    description: A unique project identifier.
    in: path
    name: projectId
    required: true
    type: string
  ProjectIdentifierQueryParam:
    description: The filter to find the project with the given identifier.
    in: query
    name: id
    type: string
    x-default-description: 'null'
  ProjectLifecycleStateQueryParam:
    description: The filter to match projects with the given lifecycleState.
    in: query
    name: lifecycleState
    required: false
    type: string
    x-default-description: 'null'
    x-obmcs-enumref: '#/definitions/Project/lifecycleState'
  RequestIdHeader:
    description: The client request ID for tracing.
    in: header
    name: opc-request-id
    type: string
  ResourceIdentifierQueryParam:
    description: The ID of the resource affected by the work request.
    in: query
    name: resourceId
    type: string
    x-default-description: 'null'
  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
    maxLength: 64
    minLength: 1
    name: opc-retry-token
    required: false
    type: string
  SortByQueryParam:
    default: timeCreated
    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.

      '
    enum:
    - timeCreated
    - displayName
    in: query
    name: sortBy
    type: string
  SortOrderQueryParam:
    description: The sort order to use, either 'ASC' or 'DESC'.
    enum: *id009
    in: query
    name: sortOrder
    type: string
    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'
  StreamGroupIdParam:
    description: StreamGroup Id.
    in: path
    maxLength: 255
    minLength: 1
    name: streamGroupId
    required: true
    type: string
  StreamGroupIdQueryParam:
    description: The filter to find the device with the given identifier.
    in: query
    name: id
    type: string
    x-default-description: 'null'
  StreamJobIdParam:
    description: Stream job id.
    in: path
    maxLength: 255
    minLength: 1
    name: streamJobId
    required: true
    type: string
  StreamJobIdQueryParam:
    description: The filter to find the streamjob with the given identifier.
    in: query
    name: id
    type: string
    x-default-description: 'null'
  StreamJobLifecycleStateQueryParam:
    description: The filter to match projects with the given lifecycleState.
    in: query
    name: lifecycleState
    required: false
    type: string
    x-default-description: 'null'
    x-obmcs-enumref: '#/definitions/StreamJob/lifecycleState'
  StreamPaginationLimitQueryParam:
    default: 10
    description: The maximum number of items to return.
    in: query
    maximum: 30
    minimum: 1
    name: limit
    type: integer
  StreamSourceIdParam:
    description: StreamSource Id.
    in: path
    maxLength: 255
    minLength: 1
    name: streamSourceId
    required: true
    type: string
  StreamSourceIdQueryParam:
    description: The filter to find the device with the given identifier.
    in: query
    name: id
    type: string
    x-default-description: 'null'
  StreamSourceLifecycleStateQueryParam:
    description: The filter to match projects with the given lifecycleState.
    in: query
    name: lifecycleState
    required: false
    type: string
    x-default-description: 'null'
    x-obmcs-enumref: '#/definitions/StreamSource/lifecycleState'
  VideoJobIdParam:
    description: Video job id.
    in: path
    maxLength: 255
    minLength: 1
    name: videoJobId
    required: true
    type: string
  VisionPrivateEndpointIdParam:
    description: Vision private endpoint Id.
    in: path
    maxLength: 255
    minLength: 1
    name: visionPrivateEndpointId
    required: true
    type: string
  VisionPrivateEndpointIdQueryParam:
    description: The filter to find the device with the given identifier.
    in: query
    name: id
    type: string
    x-default-description: 'null'
  VisionPrivateEndpointLifecycleStateQueryParam:
    description: The filter to match projects with the given lifecycleState.
    in: query
    name: lifecycleState
    required: false
    type: string
    x-default-description: 'null'
    x-obmcs-enumref: '#/definitions/VisionPrivateEndpoint/lifecycleState'
  WorkRequestIdPathParam:
    description: The ID of the asynchronous request.
    in: path
    name: workRequestId
    required: true
    type: string
  WorkRequestIdQueryParam:
    description: The ID of the asynchronous work request.
    in: query
    name: workRequestId
    type: string
    x-default-description: 'null'
  WorkRequestSortByQueryParam:
    default: timeAccepted
    description: 'The field to sort by. Only one sort order may be provided. The default
      order for timeAccepted is descending.

      '
    enum:
    - timeAccepted
    in: query
    name: sortBy
    type: string
  WorkRequestStatusQueryParam:
    description: A filter to return only resources whose lifecycleState matches the
      given OperationStatus.
    enum: *id007
    in: query
    name: status
    required: false
    type: string
    x-default-description: 'null'
    x-obmcs-top-level-enum: '#/definitions/OperationStatus'
  compartmentId:
    description: The compartment ID.
    in: query
    maxLength: 255
    minLength: 32
    name: compartmentId
    required: false
    type: string
    x-default-description: 'null'
paths:
  /actions/analyzeDocument:
    post:
      description: 'Perform different types of image analysis.

        '
      operationId: AnalyzeDocument
      parameters:
      - description: The details of how to analyze a document.
        in: body
        name: AnalyzeDocumentDetails
        required: true
        schema:
          $ref: '#/definitions/AnalyzeDocumentDetails'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: The request was accepted and returned an analysis result.
          headers:
            etag: &id010
              description: 'For optimistic concurrency control. See `if-match`.

                '
              type: string
            opc-request-id: &id011
              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
          schema:
            $ref: '#/definitions/AnalyzeDocumentResult'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        413:
          $ref: '#/responses/413'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Perform document analysis.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/AnalyzeDocumentResult'
  /actions/analyzeImage:
    post:
      description: 'Perform different types of image analysis.

        '
      operationId: AnalyzeImage
      parameters:
      - description: Details about how to analyze an image.
        in: body
        name: AnalyzeImageDetails
        required: true
        schema:
          $ref: '#/definitions/AnalyzeImageDetails'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: The request was accepted and returned an analysis result.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/AnalyzeImageResult'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        413:
          $ref: '#/responses/413'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Perform image analysis.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/AnalyzeImageResult'
  /documentJobs:
    post:
      description: 'Create a document analysis batch job.

        '
      operationId: CreateDocumentJob
      parameters:
      - description: The details of the batch document analysis.
        in: body
        name: CreateDocumentJobDetails
        required: true
        schema:
          $ref: '#/definitions/CreateDocumentJobDetails'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Accepted the request.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/DocumentJob'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Create a batch document analysis job.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/DocumentJob'
  /documentJobs/{documentJobId}:
    get:
      description: 'Get details of a document batch job.

        '
      operationId: GetDocumentJob
      parameters:
      - $ref: '#/parameters/DocumentJobIdParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: The details of a batch document job with given ID.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/DocumentJob'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get details of a batch document job.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/DocumentJob'
  /documentJobs/{documentJobId}/actions/cancel:
    post:
      description: 'Cancel a document batch job.

        '
      operationId: CancelDocumentJob
      parameters:
      - $ref: '#/parameters/DocumentJobIdParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The job is accepted.
          headers:
            opc-request-id: *id011
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Cancel a batch document job.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/DocumentJob'
  /imageJobs:
    post:
      description: 'Create an image analysis batch job.

        '
      operationId: CreateImageJob
      parameters:
      - description: The details of the batch image analysis.
        in: body
        name: CreateImageJobDetails
        required: true
        schema:
          $ref: '#/definitions/CreateImageJobDetails'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Accepted the request.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/ImageJob'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Create a batch image analysis job.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/ImageJob'
  /imageJobs/{imageJobId}:
    get:
      description: 'Get details of an image batch job.

        '
      operationId: GetImageJob
      parameters:
      - $ref: '#/parameters/ImageJobIdParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: The details of a batch image job with given ID.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/ImageJob'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get details of a batch image job.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/ImageJob'
  /imageJobs/{imageJobId}/actions/cancel:
    post:
      description: 'Cancel an image batch job.

        '
      operationId: CancelImageJob
      parameters:
      - $ref: '#/parameters/ImageJobIdParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: Request accepted.
          headers:
            opc-request-id: *id011
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Cancel a batch image job.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/ImageJob'
  /models:
    get:
      description: 'Returns a list of models in a compartment.

        '
      operationId: ListModels
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/ProjectIdQueryParam'
      - $ref: '#/parameters/ModelLifecycleStateQueryParam'
      - $ref: '#/parameters/DisplayNameQueryParam'
      - $ref: '#/parameters/ModelIdentifierQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - $ref: '#/parameters/SortByQueryParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of ModelSummary objects.
          headers:
            opc-next-page: &id013
              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: *id011
          schema:
            $ref: '#/definitions/ModelCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Gets a list of all models in a compartment
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/ModelCollection'
    post:
      description: 'Create a new model.

        '
      operationId: CreateModel
      parameters:
      - description: The metadata about the new model.
        in: body
        name: CreateModelDetails
        required: true
        schema:
          $ref: '#/definitions/CreateModelDetails'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        201:
          description: The request was successfully received, and the model creation
            is in progress.
          headers:
            etag: *id010
            opc-request-id: *id011
            opc-work-request-id: &id012
              description: 'A unique Oracle-assigned identifier for the asynchronous
                request. You can use this to query status of the asynchronous operation.

                '
              type: string
          schema:
            $ref: '#/definitions/Model'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Creates a new model .
      tags:
      - AIServiceVision
  /models/{modelId}:
    delete:
      description: Delete a model by identifier.
      operationId: DeleteModel
      parameters:
      - $ref: '#/parameters/ModelIdentifierPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The request is accepted, and the model metadata is to be deleted.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Delete a model.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/Model'
    get:
      description: Get a model by identifier.
      operationId: GetModel
      parameters:
      - $ref: '#/parameters/ModelIdentifierPathParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieved the model with the given ID.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/Model'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get a model.
      tags:
      - AIServiceVision
    put:
      description: Updates the model metadata.
      operationId: UpdateModel
      parameters:
      - $ref: '#/parameters/ModelIdentifierPathParam'
      - description: The model metadata to be updated.
        in: body
        name: UpdateModelDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateModelDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The request is accepted, and the model metadata is to be updated.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        405:
          $ref: '#/responses/405'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Update the metadata about the model.
      tags:
      - AIServiceVision
      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: '#/parameters/ModelIdentifierPathParam'
      - description: The details of the move.
        in: body
        name: ChangeModelCompartmentDetails
        required: true
        schema:
          $ref: '#/definitions/ChangeModelCompartmentDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        204:
          description: The model was successfully moved to the specified compartment.
          headers:
            opc-request-id: *id011
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
      summary: Moves a model into a different compartment.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/Model'
  /projects:
    get:
      description: 'Returns a list of projects.

        '
      operationId: ListProjects
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/ProjectLifecycleStateQueryParam'
      - $ref: '#/parameters/DisplayNameQueryParam'
      - $ref: '#/parameters/ProjectIdentifierQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - $ref: '#/parameters/SortByQueryParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of ProjectSummary objects.
          headers:
            opc-next-page: *id013
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/ProjectCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Gets a list of all the projects in a compartment.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/ProjectCollection'
    post:
      description: 'Create a new project.

        '
      operationId: CreateProject
      parameters:
      - description: The new Project's details.
        in: body
        name: CreateProjectDetails
        required: true
        schema:
          $ref: '#/definitions/CreateProjectDetails'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        201:
          description: The request was successfully received and the project creation
            is in progress.
          headers:
            etag: *id010
            opc-request-id: *id011
            opc-work-request-id: *id012
          schema:
            $ref: '#/definitions/Project'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Creates a new project.
      tags:
      - AIServiceVision
  /projects/{projectId}:
    delete:
      description: Delete a project by identifier.
      operationId: DeleteProject
      parameters:
      - $ref: '#/parameters/ProjectIdentifierPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The request is accepted and the Project is to be deleted.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Delete a project.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/Project'
    get:
      description: Get a project by identifier.
      operationId: GetProject
      parameters:
      - $ref: '#/parameters/ProjectIdentifierPathParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieved the project with the given ID.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/Project'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get a project.
      tags:
      - AIServiceVision
    put:
      description: Update the project metadata.
      operationId: UpdateProject
      parameters:
      - $ref: '#/parameters/ProjectIdentifierPathParam'
      - description: The project metadata to be updated.
        in: body
        name: UpdateProjectDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateProjectDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The request is accepted and the project is to be updated.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        405:
          $ref: '#/responses/405'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Update the metadata about the project.
      tags:
      - AIServiceVision
      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: '#/parameters/ProjectIdentifierPathParam'
      - description: The deatils of the move.
        in: body
        name: ChangeProjectCompartmentDetails
        required: true
        schema:
          $ref: '#/definitions/ChangeProjectCompartmentDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        204:
          description: The project was moved successfully to the specified compartment.
          headers:
            opc-request-id: *id011
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
      summary: Move a project into a different compartment.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/Project'
  /streamGroups:
    get:
      description: 'Gets a list of the streamGroups in the specified compartment.

        '
      operationId: ListStreamGroups
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/StreamGroupIdQueryParam'
      - $ref: '#/parameters/DisplayNameQueryParam'
      - $ref: '#/parameters/StreamPaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - $ref: '#/parameters/SortByQueryParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: List of the streamGroups.
          headers:
            opc-next-page: *id013
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/StreamGroupCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: list streamGroups.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamGroupCollection'
    post:
      description: 'Registration of new streamGroup

        '
      operationId: CreateStreamGroup
      parameters:
      - description: Details about the streamGroup
        in: body
        name: CreateStreamGroupDetails
        required: true
        schema:
          $ref: '#/definitions/CreateStreamGroupDetails'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        201:
          description: The request was successfully received and the streamGroup creation
            is in progress.
          headers:
            etag: *id010
            opc-request-id: *id011
            opc-work-request-id: *id012
          schema:
            $ref: '#/definitions/StreamGroup'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Register a new streamGroup.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamGroup'
  /streamGroups/{streamGroupId}:
    delete:
      description: 'Delete a  streamGroup

        '
      operationId: DeleteStreamGroup
      parameters:
      - $ref: '#/parameters/StreamGroupIdParam'
      - $ref: '#/parameters/RequestIdHeader'
      - $ref: '#/parameters/IfMatchHeader'
      responses:
        202:
          description: Accepted the request.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Delete a  streamGroup.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/StreamGroup'
    get:
      description: 'Get a  streamGroup

        '
      operationId: GetStreamGroup
      parameters:
      - $ref: '#/parameters/StreamGroupIdParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Accepted the request.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/StreamGroup'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get streamGroup information.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamGroup'
    put:
      description: 'Update a streamGroup

        '
      operationId: UpdateStreamGroup
      parameters:
      - $ref: '#/parameters/StreamGroupIdParam'
      - description: Details about the streamGroup
        in: body
        name: UpdateStreamGroupDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateStreamGroupDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The request is accepted and the streamGroup is to be updated.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Update a  streamGroup.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/StreamGroup'
  /streamGroups/{streamGroupId}/actions/changeCompartment:
    post:
      description: Move a streamGroup from one compartment to another. When provided,
        If-Match is checked against the ETag values of the resource.
      operationId: ChangeStreamGroupCompartment
      parameters:
      - $ref: '#/parameters/StreamGroupIdParam'
      - description: The details of the move.
        in: body
        name: ChangeStreamGroupCompartmentDetails
        required: true
        schema:
          $ref: '#/definitions/ChangeStreamGroupCompartmentDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The streamGroup was moved successfully to the specified compartment.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
      summary: Move a streamGroup into a different compartment.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamGroup'
  /streamJobs:
    get:
      description: 'Get list of stream jobs

        '
      operationId: ListStreamJobs
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/StreamJobLifecycleStateQueryParam'
      - $ref: '#/parameters/StreamJobIdQueryParam'
      - $ref: '#/parameters/DisplayNameQueryParam'
      - $ref: '#/parameters/StreamPaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - $ref: '#/parameters/SortByQueryParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Get list of stream jobs in a compartment
          headers:
            opc-next-page: *id013
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/StreamJobCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get list of stream Jobs
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamJobCollection'
    post:
      description: 'Create a stream analysis job with given inputs and features.

        '
      operationId: CreateStreamJob
      parameters:
      - description: Details about the stream analysis.
        in: body
        name: CreateStreamJobDetails
        required: true
        schema:
          $ref: '#/definitions/CreateStreamJobDetails'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        201:
          description: The request was successfully received and the stream job creation
            is in progress.
          headers:
            etag: *id010
            opc-request-id: *id011
            opc-work-request-id: *id012
          schema:
            $ref: '#/definitions/StreamJob'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Create a stream analysis job with given inputs and features.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamJob'
  /streamJobs/{streamJobId}:
    delete:
      description: 'Get details of a stream analysis job.

        '
      operationId: DeleteStreamJob
      parameters:
      - $ref: '#/parameters/StreamJobIdParam'
      - $ref: '#/parameters/RequestIdHeader'
      - $ref: '#/parameters/IfMatchHeader'
      responses:
        202:
          description: Delete stream Job
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        412:
          $ref: '#/responses/412'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get details of a stream analysis job.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/StreamJob'
    get:
      description: 'Get details of a stream analysis job.

        '
      operationId: GetStreamJob
      parameters:
      - $ref: '#/parameters/StreamJobIdParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Details of a stream analysis job with given id.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/StreamJob'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get details of a stream analysis job.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamJob'
    put:
      description: 'Create a stream analysis job with given inputs and features.

        '
      operationId: UpdateStreamJob
      parameters:
      - description: Details about the stream analysis.
        in: body
        name: UpdateStreamJobDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateStreamJobDetails'
      - $ref: '#/parameters/RequestIdHeader'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/StreamJobIdParam'
      responses:
        202:
          description: The request is accepted and the streamjob is to be updated.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Create a stream analysis job with given inputs and features.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/StreamJob'
  /streamJobs/{streamJobId}/actions/changeCompartment:
    post:
      description: Move a streamJob from one compartment to another. When provided,
        If-Match is checked against the ETag values of the resource.
      operationId: ChangeStreamJobCompartment
      parameters:
      - $ref: '#/parameters/StreamJobIdParam'
      - description: The details of the move.
        in: body
        name: ChangeStreamJobCompartmentDetails
        required: true
        schema:
          $ref: '#/definitions/ChangeStreamJobCompartmentDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The streamJob was moved successfully to the specified compartment.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
      summary: Move a streamJob into a different compartment.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamJob'
  /streamJobs/{streamJobId}/actions/start:
    post:
      description: 'End a stream analysis Run.

        '
      operationId: StartStreamJob
      parameters:
      - $ref: '#/parameters/StreamJobIdParam'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      - $ref: '#/parameters/IfMatchHeader'
      responses:
        202:
          description: Request to start stream job is accepted and start stream job
            is in progress
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: End a stream analysis job.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-obmcs-terraform:
        actionType: START
      x-related-resource: '#/definitions/StreamJob'
  /streamJobs/{streamJobId}/actions/stop:
    post:
      description: 'End a stream analysis Run.

        '
      operationId: StopStreamJob
      parameters:
      - $ref: '#/parameters/StreamJobIdParam'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: Request to start stream job is accepted and start stream job
            is in progress.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        409:
          $ref: '#/responses/409'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: End a stream analysis Run.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-obmcs-terraform:
        actionType: STOP
      x-related-resource: '#/definitions/StreamJob'
  /streamSources:
    get:
      description: 'Gets a list of the streamSources in the specified compartment.

        '
      operationId: ListStreamSources
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/StreamSourceLifecycleStateQueryParam'
      - $ref: '#/parameters/StreamSourceIdQueryParam'
      - $ref: '#/parameters/DisplayNameQueryParam'
      - $ref: '#/parameters/StreamPaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - $ref: '#/parameters/SortByQueryParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: List of the StreamSources.
          headers:
            opc-next-page: *id013
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/StreamSourceCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: list streamSources.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamSourceCollection'
    post:
      description: 'Registration of new streamSource

        '
      operationId: CreateStreamSource
      parameters:
      - description: Details about the StreamSource
        in: body
        name: CreateStreamSourceDetails
        required: true
        schema:
          $ref: '#/definitions/CreateStreamSourceDetails'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        201:
          description: The request was successfully received and the streamSource
            creation is in progress.
          headers:
            etag: *id010
            opc-request-id: *id011
            opc-work-request-id: *id012
          schema:
            $ref: '#/definitions/StreamSource'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Register a new streamSource.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamSource'
  /streamSources/{streamSourceId}:
    delete:
      description: 'Delete a  streamSource

        '
      operationId: DeleteStreamSource
      parameters:
      - $ref: '#/parameters/StreamSourceIdParam'
      - $ref: '#/parameters/RequestIdHeader'
      - $ref: '#/parameters/IfMatchHeader'
      responses:
        202:
          description: Accepted the request.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Delete a  streamSource.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/StreamSource'
    get:
      description: 'Get a  streamSource

        '
      operationId: GetStreamSource
      parameters:
      - $ref: '#/parameters/StreamSourceIdParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Accepted the request.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/StreamSource'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get streamSource information.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamSource'
    put:
      description: 'Update a streamSource

        '
      operationId: UpdateStreamSource
      parameters:
      - $ref: '#/parameters/StreamSourceIdParam'
      - description: Details about the StreamSource
        in: body
        name: UpdateStreamSourceDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateStreamSourceDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The request is accepted and the streamSource is to be updated.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Update a  streamSource.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/StreamSource'
  /streamSources/{streamSourceId}/actions/changeCompartment:
    post:
      description: Move a streamSource from one compartment to another. When provided,
        If-Match is checked against the ETag values of the resource.
      operationId: ChangeStreamSourceCompartment
      parameters:
      - $ref: '#/parameters/StreamSourceIdParam'
      - description: The details of the move.
        in: body
        name: ChangeStreamSourceCompartmentDetails
        required: true
        schema:
          $ref: '#/definitions/ChangeStreamSourceCompartmentDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The streamSource was moved successfully to the specified compartment.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
      summary: Move a streamSource into a different compartment.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/StreamSource'
  /videoJobs:
    post:
      description: 'Create a video analysis job with given inputs and features.

        '
      operationId: CreateVideoJob
      parameters:
      - description: Details about the video analysis.
        in: body
        name: CreateVideoJobDetails
        required: true
        schema:
          $ref: '#/definitions/CreateVideoJobDetails'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Accepted the request.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/VideoJob'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Create a video analysis job with given inputs and features.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/VideoJob'
  /videoJobs/{videoJobId}:
    get:
      description: 'Get details of a video analysis job.

        '
      operationId: GetVideoJob
      parameters:
      - $ref: '#/parameters/VideoJobIdParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Details of a video analysis job with given id.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/VideoJob'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get details of a video analysis job.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/VideoJob'
  /videoJobs/{videoJobId}/actions/cancel:
    post:
      description: 'Cancel a video analysis job.

        '
      operationId: CancelVideoJob
      parameters:
      - $ref: '#/parameters/VideoJobIdParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: accepted.
          headers:
            opc-request-id: *id011
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Cancel a video analysis job.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/VideoJob'
  /visionPrivateEndpoints:
    get:
      description: 'Returns a list of visionPrivateEndpoints.

        '
      operationId: ListVisionPrivateEndpoints
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/VisionPrivateEndpointLifecycleStateQueryParam'
      - $ref: '#/parameters/DisplayNameQueryParam'
      - $ref: '#/parameters/VisionPrivateEndpointIdQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - $ref: '#/parameters/SortByQueryParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of VisionPrivateEndpointSummary objects.
          headers:
            opc-next-page: *id013
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/VisionPrivateEndpointCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Gets a list of all the visionPrivateEndpoints in a compartment.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/VisionPrivateEndpointCollection'
    post:
      description: 'Create a new visionPrivateEndpoint.

        '
      operationId: CreateVisionPrivateEndpoint
      parameters:
      - description: The new VisionPrivateEndpoint's details.
        in: body
        name: CreateVisionPrivateEndpointDetails
        required: true
        schema:
          $ref: '#/definitions/CreateVisionPrivateEndpointDetails'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        201:
          description: The request was successfully received and the visionPrivateEndpoint
            creation is in progress.
          headers:
            etag: *id010
            opc-request-id: *id011
            opc-work-request-id: *id012
          schema:
            $ref: '#/definitions/VisionPrivateEndpoint'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Creates a new visionPrivateEndpoint.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
  /visionPrivateEndpoints/{visionPrivateEndpointId}:
    delete:
      description: Delete a visionPrivateEndpoint by identifier.
      operationId: DeleteVisionPrivateEndpoint
      parameters:
      - $ref: '#/parameters/VisionPrivateEndpointIdParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The request is accepted and the VisionPrivateEndpoint is to
            be deleted.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Delete a visionPrivateEndpoint.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/VisionPrivateEndpoint'
    get:
      description: Get a visionPrivateEndpoint by identifier.
      operationId: GetVisionPrivateEndpoint
      parameters:
      - $ref: '#/parameters/VisionPrivateEndpointIdParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieved the visionPrivateEndpoint with the given ID.
          headers:
            etag: *id010
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/VisionPrivateEndpoint'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get a visionPrivateEndpoint.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
    put:
      description: Update the visionPrivateEndpoint metadata.
      operationId: UpdateVisionPrivateEndpoint
      parameters:
      - $ref: '#/parameters/VisionPrivateEndpointIdParam'
      - description: The visionPrivateEndpoint metadata to be updated.
        in: body
        name: UpdateVisionPrivateEndpointDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateVisionPrivateEndpointDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The request is accepted and the visionPrivateEndpoint is to
            be updated.
          headers:
            opc-request-id: *id011
            opc-work-request-id: *id012
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        405:
          $ref: '#/responses/405'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Update the metadata about the visionPrivateEndpoint.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/VisionPrivateEndpoint'
  /visionPrivateEndpoints/{visionPrivateEndpointId}/actions/changeCompartment:
    post:
      description: Move a visionPrivateEndpoint from one compartment to another. When
        provided, If-Match is checked against the ETag values of the resource.
      operationId: ChangeVisionPrivateEndpointCompartment
      parameters:
      - $ref: '#/parameters/VisionPrivateEndpointIdParam'
      - description: The deatils of the move.
        in: body
        name: ChangeVisionPrivateEndpointCompartmentDetails
        required: true
        schema:
          $ref: '#/definitions/ChangeVisionPrivateEndpointCompartmentDetails'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RetryTokenHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        204:
          description: The visionPrivateEndpoint was moved successfully to the specified
            compartment.
          headers:
            opc-request-id: *id011
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
      summary: Move a visionPrivateEndpoint into a different compartment.
      tags:
      - AIServiceVision
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/VisionPrivateEndpoint'
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/WorkRequestIdQueryParam'
      - $ref: '#/parameters/WorkRequestStatusQueryParam'
      - $ref: '#/parameters/ResourceIdentifierQueryParam'
      - $ref: '#/parameters/RequestIdHeader'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - $ref: '#/parameters/WorkRequestSortByQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page: *id013
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/WorkRequestSummaryCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: A list of work requests.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    delete:
      description: Cancel the work request with the given ID.
      operationId: CancelWorkRequest
      parameters:
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        202:
          description: The work request will be cancelled.
          headers:
            opc-request-id: *id011
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Cancel the work request.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/WorkRequest'
    get:
      description: Gets the status of the work request with the given ID.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/RequestIdHeader'
      responses:
        200:
          description: The details of the work request.
          headers:
            etag: *id010
            opc-request-id: *id011
            retry-after: &id014
              description: A decimal number representing the number of seconds the
                client should wait before polling this endpoint again.
              type: integer
          schema:
            $ref: '#/definitions/WorkRequest'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Get the work request status.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Returns a (paginated) list of errors for a given work request.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/RequestIdHeader'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/WorkRequestSortByQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      responses:
        200:
          description: The list of work request errors.
          headers:
            opc-next-page: *id013
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/WorkRequestErrorCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Lists the work request errors.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Return a (paginated) list of logs for a given work request.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/RequestIdHeader'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/WorkRequestSortByQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      responses:
        200:
          description: A list of work request logs.
          headers:
            opc-next-page: *id013
            opc-request-id: *id011
          schema:
            $ref: '#/definitions/WorkRequestLogEntryCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/default'
      summary: Lists work request logs.
      tags:
      - AIServiceVision
      x-related-resource: '#/definitions/WorkRequestLogEntry'
produces:
- application/json
responses:
  400:
    description: Bad Request.
    headers:
      opc-request-id: *id011
    schema:
      $ref: '#/definitions/Error'
  401:
    description: Unauthorized.
    headers:
      opc-request-id: *id011
    schema:
      $ref: '#/definitions/Error'
  404:
    description: Not Found.
    headers:
      opc-request-id: *id011
    schema:
      $ref: '#/definitions/Error'
  405:
    description: Method Not Allowed.
    headers:
      opc-request-id: *id011
    schema:
      $ref: '#/definitions/Error'
  409:
    description: Conflict.
    headers:
      opc-request-id: *id011
    schema:
      $ref: '#/definitions/Error'
  412:
    description: Precondition Failed.
    headers:
      opc-request-id: *id011
    schema:
      $ref: '#/definitions/Error'
  413:
    description: Request Entity Too Large.
    headers:
      opc-request-id: *id011
    schema:
      $ref: '#/definitions/Error'
  429:
    description: Too Many Requests.
    headers:
      opc-request-id: *id011
    schema:
      $ref: '#/definitions/Error'
  500:
    description: Internal Server Error.
    headers:
      opc-request-id: *id011
    schema:
      $ref: '#/definitions/Error'
  default:
    description: Unknown Error.
    headers:
      opc-request-id: *id011
    schema:
      $ref: '#/definitions/Error'
schemes:
- http
- https
swagger: '2.0'
x-anchors:
  x-headers:
    etag: *id010
    opc-next-page: *id013
    opc-request-id: *id011
    opc-work-request-id: *id012
    retry-after: *id014
  x-properties:
    definedTags: *id003
    freeformTags: *id004
    systemTags: *id005
x-oracle-package: com.oracle.pic.ocas.vision
