swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector documentClassifiers:build API
schemes:
- https
tags:
- name: documentClassifiers:build
paths:
  /documentClassifiers:build:
    post:
      operationId: microsoftAzureDocumentclassifiersBuildclassifier
      description: Builds a custom document classifier.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: buildRequest
        in: body
        description: Build request parameters.
        required: true
        schema:
          $ref: '#/definitions/BuildDocumentClassifierRequest'
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Operation-Location:
              type: string
              format: uri
              description: The location of an instance of DocumentClassifierBuildOperationDetails
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Build Document Classifier:
          $ref: ./examples/BuildDocumentClassifier.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Documentclassifiers:build
      tags:
      - documentClassifiers:build
definitions:
  ErrorResponse:
    type: object
    description: Error response object.
    properties:
      error:
        $ref: '#/definitions/Error'
        description: Error info.
    required:
    - error
  BuildDocumentClassifierRequest:
    type: object
    description: Request body to build a new custom document classifier.
    properties:
      classifierId:
        type: string
        description: Unique document classifier name.
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      description:
        type: string
        description: Document classifier description.
        maxLength: 4096
      baseClassifierId:
        type: string
        description: Base classifierId on top of which to train the classifier.
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      docTypes:
        type: object
        description: List of document types to classify against.
        additionalProperties:
          $ref: '#/definitions/ClassifierDocumentTypeDetails'
    required:
    - classifierId
    - docTypes
  ContentSourceKind:
    type: string
    description: Type of content source.
    enum:
    - url
    - base64
    - azureBlob
    - azureBlobFileList
    x-ms-enum:
      name: ContentSourceKind
      modelAsString: true
      values:
      - name: url
        value: url
        description: Content at a specific URL.
      - name: base64
        value: base64
        description: Content represented via Base64 encoding.
      - name: azureBlob
        value: azureBlob
        description: Files in a path within an Azure Blob Storage container.
      - name: azureBlobFileList
        value: azureBlobFileList
        description: A file list specifying individual files in an Azure Blob Storage container.
  AzureBlobContentSource:
    type: object
    description: Azure Blob Storage content.
    properties:
      containerUrl:
        type: string
        format: uri
        description: Azure Blob Storage container URL.
      prefix:
        type: string
        description: Blob name prefix.
    required:
    - containerUrl
  AzureBlobFileListContentSource:
    type: object
    description: File list in Azure Blob Storage.
    properties:
      containerUrl:
        type: string
        format: uri
        description: Azure Blob Storage container URL.
      fileList:
        type: string
        description: Path to a JSONL file within the container specifying a subset of documents.
    required:
    - containerUrl
    - fileList
  InnerError:
    type: object
    description: An object containing more specific information about the error.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      innererror:
        $ref: '#/definitions/InnerError'
        description: Inner error.
  ClassifierDocumentTypeDetails:
    type: object
    description: Classifier document type info.
    properties:
      sourceKind:
        $ref: '#/definitions/ContentSourceKind'
        description: Type of training data source.
      azureBlobSource:
        $ref: '#/definitions/AzureBlobContentSource'
        description: 'Azure Blob Storage location containing the training data for a classifier

          document type.  Either azureBlobSource or azureBlobFileListSource must be

          specified.'
      azureBlobFileListSource:
        $ref: '#/definitions/AzureBlobFileListContentSource'
        description: 'Azure Blob Storage file list specifying the training data for a classifier

          document type.  Either azureBlobSource or azureBlobFileListSource must be

          specified.'
  Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
parameters:
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'