swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: 'Microsoft Azure AccessControlClient AccessConnector Ingestion: API'
schemes:
- https
tags:
- name: 'Ingestion:'
paths:
  /extensions/on-your-data/ingestion-jobs/{jobId}:
    put:
      tags:
      - 'Ingestion:'
      summary: Microsoft Azure Starts A Job For Ingesting Data Into An Azure Search Index To Be Used As A Data Source For Completions The Status Of The Ingestion Job Will Be Kept For 48 Hours After Its Completion And Will Be Deleted Afterwards
      operationId: microsoftAzureIngestionjobsCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/apiVersionQueryParameter'
      - name: jobId
        in: path
        description: The id of the ingestion job.
        required: true
        type: string
      - in: body
        name: ingestionJob
        description: The details of the ingestion job.
        required: true
        schema:
          $ref: '#/definitions/IngestionJob'
      - in: header
        name: searchServiceEndpoint
        description: The endpoint to the search service resource where the ingestion assets will be created.
        type: string
        required: true
      - in: header
        name: searchServiceAdminKey
        description: The admin key to the search service resource if Managed Identity is not setup.
        type: string
      - in: header
        name: storageConnectionString
        description: The connection string to the blob storage account hosting the data that will be ingested.
        type: string
        required: true
      - in: header
        name: storageContainer
        description: The name of the container hosting the data that will be ingested.
        type: string
        required: true
      - in: header
        name: embeddingEndpoint
        description: The endpoint of the embeddings model to be used for embeddings calculations if enabled.
        type: string
      - in: header
        name: embeddingKey
        description: The key to use for accessing the embeddings model if enabled and if Managed Identity is not setup.
        type: string
      - in: header
        name: storageEndpoint
        description: The blob storage endpoint hosting the data that will be ingested. Required for ResourceId format of storageConnectionString.
        type: string
      - in: header
        name: embeddingDeploymentName
        description: The name of embedding deployment of the current Azure OpenAI resource to use for accessing the embeddings model.
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/IngestionJob'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Starting an ingestion job.:
          $ref: ./examples/put_ingestion_job.json
      description: Needs a more full description created.
    get:
      tags:
      - 'Ingestion:'
      summary: Microsoft Azure Gets The Status Of An Ingestion Job By Its Id
      operationId: microsoftAzureIngestionjobsGet
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: The id of the ingestion job.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionQueryParameter'
      responses:
        '200':
          description: Success
          headers:
            Retry-After:
              description: An integer number of seconds to wait before making the next request to the status monitor.
              type: integer
              format: int32
          schema:
            $ref: '#/definitions/IngestionJob'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Getting status of an ingestion job.:
          $ref: ./examples/get_ingestion_job.json
      description: Needs a more full description created.
  /extensions/on-your-data/ingestion-jobs:
    get:
      tags:
      - 'Ingestion:'
      summary: Microsoft Azure Lists The Status Of All Ingestion Jobs That Ran In The Past 48 Hours In The Form Of Paginated Collections
      operationId: microsoftAzureIngestionjobsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/apiVersionQueryParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/IngestionJobList'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Getting status of an ingestion job.:
          $ref: ./examples/get_ingestion_jobs.json
      description: Needs a more full description created.
definitions:
  ErrorResponse:
    title: ErrorResponse
    description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
  ErrorCode:
    title: ErrorCode
    description: "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
    enum:
    - conflict
    - invalidPayload
    - forbidden
    - notFound
    - unexpectedEntityState
    - itemDoesAlreadyExist
    - serviceUnavailable
    - internalFailure
    - quotaExceeded
    - jsonlValidationFailed
    - fileImportFailed
    - tooManyRequests
    - unauthorized
    - contentFilter
    type: string
    x-ms-enum:
      name: ErrorCode
      modelAsString: true
      values:
      - value: conflict
        description: The requested operation conflicts with the current resource state.
      - value: invalidPayload
        description: The request data is invalid for this operation.
      - value: forbidden
        description: The operation is forbidden for the current user/api key.
      - value: notFound
        description: The resource is not found.
      - value: unexpectedEntityState
        description: The operation cannot be executed in the current resource's state.
      - value: itemDoesAlreadyExist
        description: The item does already exist.
      - value: serviceUnavailable
        description: The service is currently not available.
      - value: internalFailure
        description: Internal error. Please retry.
      - value: quotaExceeded
        description: Quota exceeded.
      - value: jsonlValidationFailed
        description: Validation of jsonl data failed.
      - value: fileImportFailed
        description: Import of file failed.
      - value: tooManyRequests
        description: Too many requests. Please retry later.
      - value: unauthorized
        description: The current user/api key is not authorized for the operation.
      - value: contentFilter
        description: Image generation failed as a result of our safety system.
  IngestionJob:
    title: IngestionJob
    type: object
    required:
    - dataRefreshIntervalInMinutes
    properties:
      id:
        type: string
      dataRefreshIntervalInMinutes:
        type: integer
        format: int32
      completionAction:
        $ref: '#/definitions/IngestionJobCompletionAction'
      chunkSize:
        type: integer
        format: int32
        default: 1024
        description: This number defines the maximum number of tokens in each chunk produced by the ingestion flow.
      status:
        $ref: '#/definitions/OperationState'
      error:
        $ref: '#/definitions/Error'
      warnings:
        type: array
        items:
          type: string
      progress:
        $ref: '#/definitions/IngestionJobProgress'
  IngestionJobCompletionAction:
    title: IngestionJobCompletionAction
    description: The action to take on ingestion job completion.
    enum:
    - keepAllAssets
    - cleanUpAssets
    type: string
    x-ms-enum:
      name: IngestionJobCompletionAction
      modelAsString: true
      values:
      - value: keepAllAssets
        description: Will not clean up any of the intermediate assets created during the ingestion process.
      - value: cleanUpAssets
        description: Will clean up intermediate assets created during the ingestion process.
  OperationState:
    title: OperationState
    description: The state of a job or item.
    enum:
    - notRunning
    - running
    - succeeded
    - failed
    type: string
    readOnly: true
    x-ms-enum:
      name: OperationState
      modelAsString: true
      values:
      - value: notRunning
        description: The operation is not yet queued to be processed in the future.
      - value: running
        description: The operation has started to be processed.
      - value: succeeded
        description: The operation has successfully be processed and is ready for consumption.
      - value: failed
        description: The operation has completed processing with a failure and cannot be further consumed.
  IngestionJobProgress:
    title: IngestionJobProgress
    type: object
    required:
    - stageProgress
    properties:
      stageProgress:
        type: array
        items:
          type: object
          properties:
            name:
              type: string
            totalItems:
              type: integer
              format: int32
            processedItems:
              type: integer
              format: int32
  IngestionJobList:
    title: IngestionJobList
    type: object
    required:
    - value
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/IngestionJob'
  InnerErrorCode:
    title: InnerErrorCode
    description: "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
    enum:
    - invalidPayload
    type: string
    x-ms-enum:
      name: InnerErrorCode
      modelAsString: true
      values:
      - value: invalidPayload
        description: The request data is invalid for this operation.
  InnerError:
    title: InnerError
    description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
    type: object
    properties:
      code:
        $ref: '#/definitions/InnerErrorCode'
      innererror:
        $ref: '#/definitions/InnerError'
  Error:
    title: Error
    description: "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
    required:
    - code
    - message
    type: object
    properties:
      code:
        $ref: '#/definitions/ErrorCode'
      message:
        description: The message of this error.
        minLength: 1
        type: string
      target:
        description: The location where the error happened if available.
        type: string
      details:
        description: The error details if available.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
    readOnly: true
parameters:
  apiVersionQueryParameter:
    in: query
    name: api-version
    description: The requested API version.
    required: true
    type: string
    x-ms-client-default: 2023-10-01-preview
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'