specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.yaml [1421:2022]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  IngestionJob:
    title: IngestionJob
    description: Represents the details of a job.
    type: object
    required:
      - kind
    discriminator: kind
    properties:
      kind:
        $ref: '#/definitions/IngestionJobType'
      jobId:
        type: string
  IngestionJobType:
    title: IngestionJobType
    type: string
    description: The job type.
    enum:
      - SystemCompute
      - UserCompute
    x-ms-enum:
      name: IngestionJobType
      modelAsString: true
      values:
        - name: SystemCompute
          value: SystemCompute
          description: Jobs that run on service owned resources.
        - name: UserCompute
          value: UserCompute
          description: Jobs that run on user owned workspace.
  IngestionJobSystemCompute:
    type: object
    allOf:
      - $ref: '#/definitions/IngestionJob'
      - type: object
        properties:
          searchServiceConnection:
            $ref: '#/definitions/BaseConnection'
          datasource:
            $ref: '#/definitions/SystemComputeDatasource'
          completionAction:
            $ref: '#/definitions/CompletionAction'
          dataRefreshIntervalInHours:
            type: integer
    x-ms-discriminator-value: SystemCompute
  IngestionJobUserCompute:
    type: object
    required:
      - workspaceId
    allOf:
      - $ref: '#/definitions/IngestionJob'
      - type: object
        properties:
          workspaceId:
            type: string
          compute:
            $ref: '#/definitions/JobCompute'
          target:
            $ref: '#/definitions/TargetIndex'
          datasource:
            $ref: '#/definitions/UserComputeDatasource'
          dataRefreshIntervalInHours:
            type: integer
    x-ms-discriminator-value: UserCompute
  JobCompute:
    title: JobCompute
    description: The compute settings of the job.
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: '#/definitions/ComputeType'
  ComputeType:
    type: string
    description: The compute type.
    enum:
      - ServerlessCompute
      - CustomCompute
    x-ms-enum:
      name: ComputeType
      modelAsString: true
      values:
        - name: ServerlessCompute
          value: ServerlessCompute
          description: Serverless user compute.
        - name: CustomCompute
          value: CustomCompute
          description: Custom user compute.
  ServerlessCompute:
    description: Serverless compute.
    allOf:
      - $ref: '#/definitions/JobCompute'
      - type: object
        properties:
          sku:
            type: string
            description: SKU Level
          instanceCount:
            type: integer
            description: The count of instances to run the job on.
    x-ms-discriminator-value: ServerlessCompute
  CustomCompute:
    description: Custom compute.
    required:
      - computeId
    allOf:
      - $ref: '#/definitions/JobCompute'
      - type: object
        properties:
          computeId:
            type: string
            description: Id of the custom compute
    x-ms-discriminator-value: CustomCompute
  TargetIndex:
    title: TargetIndex
    description: Information about the index to be created.
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: '#/definitions/TargetType'
  TargetType:
    type: string
    description: The target type.
    enum:
      - AzureAISearch
      - CosmosDB
      - Pinecone
    x-ms-enum:
      name: TargetType
      modelAsString: true
      values:
        - name: AzureAISearch
          value: AzureAISearch
          description: Azure AI Search Index.
        - name: CosmosDB
          value: CosmosDB
          description: CosmosDB Index.
        - name: Pinecone
          value: Pinecone
          description: Pinecone Index.
  AzureAISearchIndex:
    description: Azure AI Search Index.
    required:
      - connectionId
    allOf:
      - $ref: '#/definitions/TargetIndex'
      - type: object
        properties:
          connectionId:
            type: string
            description: The id of the connection pointing to the Azure AI Search Index.
    x-ms-discriminator-value: AzureAISearch
  CosmosDBIndex:
    description: CosmosDB Index.
    required:
      - connectionId
    allOf:
      - $ref: '#/definitions/TargetIndex'
      - type: object
        properties:
          connectionId:
            type: string
            description: The id of the connection pointing to the cosmos DB.
          collectionName:
            type: string
            description: The name of the cosmos DB collection.
          databaseName:
            type: string
            description: The name of the cosmos DB database.
    x-ms-discriminator-value: CosmosDB
  PineconeIndex:
    description: Pinecone Index.
    required:
      - connectionId
    allOf:
      - $ref: '#/definitions/TargetIndex'
      - type: object
        properties:
          connectionId:
            type: string
            description: The id of the connection pointing to the pinecone.
    x-ms-discriminator-value: Pinecone
  UserComputeDatasource:
    title: UserComputeDatasource
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: '#/definitions/UserComputeDatasourceType'
  UserComputeDatasourceType:
    type: string
    description: The datasource type.
    enum:
      - Dataset
      - Urls
    x-ms-enum:
      name: UserComputeDatasourceType
      modelAsString: true
      values:
        - name: Dataset
          value: Dataset
          description: Workspace Dataset.
        - name: Urls
          value: Urls
          description: URLs.
  UserComputeDataset:
    type: object
    title: UserComputeStorage
    description: Storage account
    required:
      - datasetId
      - datasetType
    x-ms-discriminator-value: Dataset
    allOf:
      - $ref: '#/definitions/UserComputeDatasource'
      - type: object
        properties:
          datasetId:
            type: string
          datasetType:
            type: string
          chunking:
            $ref: '#/definitions/ChunkingSettings'
          embeddings:
            type: array
            items:
              $ref: '#/definitions/WorkspaceConnectionEmbeddingSettings'
  UserComputeUrl:
    type: object
    title: UserComputeUrl
    description: Urls
    required:
      - urls
      - embeddings
    x-ms-discriminator-value: Urls
    allOf:
      - $ref: '#/definitions/UserComputeDatasource'
      - type: object
        properties:
          urls:
            type: array
            items:
              type: string
          crawling:
            $ref: '#/definitions/CrawlingSettings'
          chunking:
            $ref: '#/definitions/ChunkingSettings'
          embeddings:
            type: array
            items:
              $ref: '#/definitions/WorkspaceConnectionEmbeddingSettings'
  SystemComputeDatasource:
    title: SystemComputeDatasource
    type: object
    required:
      - kind
    properties:
      kind:
        $ref: '#/definitions/SystemComputeDatasourceType'
    discriminator: kind
  SystemComputeDatasourceType:
    type: string
    description: The datasource type.
    enum:
      - Storage
      - Urls
    x-ms-enum:
      name: SystemComputeDatasourceType
      modelAsString: true
      values:
        - name: Storage
          value: Storage
          description: Azure Storage Account.
        - name: Urls
          value: Urls
          description: URLs.
  SystemComputeStorage:
    title: SystemComputeStorage
    description: Storage account
    required:
      - connection
      - containerName
      - embeddings
    x-ms-discriminator-value: Storage
    allOf:
      - $ref: '#/definitions/SystemComputeDatasource'
      - type: object
        properties:
          connection:
            $ref: '#/definitions/BaseConnection'
          containerName:
            type: string
            description: container name
          chunking:
            $ref: '#/definitions/ChunkingSettings'
          embeddings:
            type: array
            items:
              $ref: '#/definitions/GenericEmbeddingSettings'
  SystemComputeUrl:
    title: SystemComputeUrl
    description: Urls
    required:
      - urls
      - connection
      - containerName
      - embeddings
    x-ms-discriminator-value: Urls
    allOf:
      - $ref: '#/definitions/SystemComputeDatasource'
      - type: object
        properties:
          urls:
            type: array
            items:
              type: string
          connection:
            $ref: '#/definitions/BaseConnection'
          containerName:
            type: string
            description: container name
          crawling:
            $ref: '#/definitions/CrawlingSettings'
          chunking:
            $ref: '#/definitions/ChunkingSettings'
          embeddings:
            type: array
            items:
              $ref: '#/definitions/GenericEmbeddingSettings'
  ChunkingSettings:
    type: object
    title: ChunkingSettings
    description: Chunking settings
    properties:
      maxChunkSizeInTokens:
        type: integer
  CrawlingSettings:
    type: object
    title: CrawlingSettings
    description: Crawling settings
    properties:
      maxCrawlDepth:
        type: integer
      maxCrawlTimeInMins:
        type: integer
      maxDownloadTimeInMins:
        type: integer
      maxFileSize:
        type: integer
      maxRedirects:
        type: integer
      maxFiles:
        type: integer
  GenericEmbeddingSettings:
    title: ConnectionEmbeddingSettings
    description: Connection Embedding Settings
    type: object
    properties:
      connection:
        $ref: '#/definitions/BaseConnection'
      deploymentName:
        type: string
      modelName:
        type: string
  WorkspaceConnectionEmbeddingSettings:
    title: WorkspaceConnectionEmbeddingSettings
    description: Connection id to the embedding model
    type: object
    properties:
      connectionId:
        type: string
      deploymentName:
        type: string
      modelName:
        type: string
  BaseConnection:
    title: BaseConnection
    description: A connection to a resource.
    type: object
    required:
      - kind
    properties:
      kind:
        $ref: '#/definitions/ConnectionType'
    discriminator: kind
  ConnectionType:
    type: string
    description: The connection type.
    enum:
      - EndpointWithKey
      - ConnectionString
      - EndpointWithManagedIdentity
      - WorkspaceConnection
      - RelativeConnection
    x-ms-enum:
      name: ConnectionType
      modelAsString: true
      values:
        - name: EndpointWithKey
          value: EndpointWithKey
          description: Endpoint and key connection.
        - name: ConnectionString
          value: ConnectionString
          description: Connection string.
        - name: EndpointWithManagedIdentity
          value: EndpointWithManagedIdentity
          description: Endpoint and managed identity.
        - name: WorkspaceConnection
          value: WorkspaceConnection
          description: AML Workspace connection.
        - name: RelativeConnection
          value: RelativeConnection
          description: Relative deployment
  EndpointKeyConnection:
    description: Endpoint key connection.
    required:
      - endpoint
      - key
    allOf:
      - $ref: '#/definitions/BaseConnection'
      - type: object
        properties:
          endpoint:
            type: string
            description: Endpoint
          key:
            type: string
            description: Key
    x-ms-discriminator-value: EndpointWithKey
  ConnectionStringConnection:
    description: Connection string connection.
    required:
      - connectionString
    allOf:
      - $ref: '#/definitions/BaseConnection'
      - type: object
        properties:
          connectionString:
            type: string
            description: Connection string
    x-ms-discriminator-value: ConnectionString
  EndpointMIConnection:
    description: Endpoint Managed Identity connection.
    required:
      - endpoint
    allOf:
      - $ref: '#/definitions/BaseConnection'
      - type: object
        properties:
          endpoint:
            type: string
            description: Endpoint
          resourceId:
            type: string
            description: Resource Id
    x-ms-discriminator-value: EndpointWithManagedIdentity
  WorkspaceConnection:
    description: AML Workspace connection.
    required:
      - connectionId
    allOf:
      - $ref: '#/definitions/BaseConnection'
      - type: object
        properties:
          connectionId:
            type: string
            description: ConnectionId
    x-ms-discriminator-value: WorkspaceConnection
  DeploymentConnection:
    description: Relative deployment connection.
    allOf:
      - $ref: '#/definitions/BaseConnection'
    x-ms-discriminator-value: RelativeConnection
  CompletionAction:
    type: string
    description: The completion action.
    enum:
      - cleanUpTempAssets
      - keepAllAssets
    x-ms-enum:
      name: IngestionJobCompletionAction
      modelAsString: true
      values:
        - name: keepAllAssets
          value: keepAllAssets
          description: >-
            Will not clean up any of the intermediate assets created during the
            ingestion process.
        - name: cleanUpTempAssets
          value: cleanUpTempAssets
          description: >-
            Will clean up intermediate assets created during the ingestion
            process.
  IngestionJobList:
    title: IngestionJobList
    description: Represents a list of ingestion jobs.
    type: object
    properties:
      nextLink:
        description: The link to the next page.
        type: string
      value:
        description: The list of items.
        type: array
        items:
          $ref: '#/definitions/IngestionJob'
  IngestionJobRunList:
    title: IngestionJobRunList
    description: Represents a list of ingestion job runs.
    type: object
    properties:
      nextLink:
        description: The link to the next page.
        type: string
      value:
        description: The list of items.
        type: array
        items:
          $ref: '#/definitions/IngestionJobRun'
  IngestionJobRun:
    title: IngestionJobRun
    description: The details of a job run
    type: object
    properties:
      jobId:
        type: string
      runId:
        type: string
      status:
        $ref: '#/definitions/OperationState'
      error:
        $ref: '#/definitions/IngestionError'
      warnings:
        type: array
        items:
          type: string
      progress:
        $ref: '#/definitions/IngestionJobProgress'
  IngestionError:
    title: IngestionError
    description: The details of the ingestion error
    type: object
    properties:
      message:
        type: string
      innerErrors:
        type: array
        items:
          type: string
  IngestionJobProgress:
    title: IngestionJobProgress
    type: object
    required:
      - stageProgress
    properties:
      stageProgress:
        type: array
        items:
          $ref: '#/definitions/IngestionJobStageProgress'
  IngestionJobStageProgress:
    title: IngestionJobStageProgress
    type: object
    properties:
      name:
        type: string
      totalItems:
        type: integer
        format: int32
      processedItems:
        type: integer
        format: int32
      state:
        $ref: '#/definitions/OperationState'
      subStageProgress:
        type: array
        items:
          $ref: '#/definitions/IngestionJobStageProgress'
parameters:
  endpoint:
    in: path
    name: endpoint
    description: >-
      Supported Cognitive Services endpoints (protocol and hostname, for
      example: https://aoairesource.openai.azure.com. Replace "aoairesource"
      with your Azure OpenAI account name).
    required: true
    type: string
    format: url
    x-ms-skip-url-encoding: true
    x-ms-parameter-location: client
  apiVersionQueryParameter:
    in: query
    name: api-version
    description: The requested API version.
    required: true
    type: string
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-07-01-preview/azureopenai.yaml [1808:2409]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  IngestionJob:
    title: IngestionJob
    description: Represents the details of a job.
    type: object
    required:
      - kind
    discriminator: kind
    properties:
      kind:
        $ref: '#/definitions/IngestionJobType'
      jobId:
        type: string
  IngestionJobType:
    title: IngestionJobType
    type: string
    description: The job type.
    enum:
      - SystemCompute
      - UserCompute
    x-ms-enum:
      name: IngestionJobType
      modelAsString: true
      values:
        - name: SystemCompute
          value: SystemCompute
          description: Jobs that run on service owned resources.
        - name: UserCompute
          value: UserCompute
          description: Jobs that run on user owned workspace.
  IngestionJobSystemCompute:
    type: object
    allOf:
      - $ref: '#/definitions/IngestionJob'
      - type: object
        properties:
          searchServiceConnection:
            $ref: '#/definitions/BaseConnection'
          datasource:
            $ref: '#/definitions/SystemComputeDatasource'
          completionAction:
            $ref: '#/definitions/CompletionAction'
          dataRefreshIntervalInHours:
            type: integer
    x-ms-discriminator-value: SystemCompute
  IngestionJobUserCompute:
    type: object
    required:
      - workspaceId
    allOf:
      - $ref: '#/definitions/IngestionJob'
      - type: object
        properties:
          workspaceId:
            type: string
          compute:
            $ref: '#/definitions/JobCompute'
          target:
            $ref: '#/definitions/TargetIndex'
          datasource:
            $ref: '#/definitions/UserComputeDatasource'
          dataRefreshIntervalInHours:
            type: integer
    x-ms-discriminator-value: UserCompute
  JobCompute:
    title: JobCompute
    description: The compute settings of the job.
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: '#/definitions/ComputeType'
  ComputeType:
    type: string
    description: The compute type.
    enum:
      - ServerlessCompute
      - CustomCompute
    x-ms-enum:
      name: ComputeType
      modelAsString: true
      values:
        - name: ServerlessCompute
          value: ServerlessCompute
          description: Serverless user compute.
        - name: CustomCompute
          value: CustomCompute
          description: Custom user compute.
  ServerlessCompute:
    description: Serverless compute.
    allOf:
      - $ref: '#/definitions/JobCompute'
      - type: object
        properties:
          sku:
            type: string
            description: SKU Level
          instanceCount:
            type: integer
            description: The count of instances to run the job on.
    x-ms-discriminator-value: ServerlessCompute
  CustomCompute:
    description: Custom compute.
    required:
      - computeId
    allOf:
      - $ref: '#/definitions/JobCompute'
      - type: object
        properties:
          computeId:
            type: string
            description: Id of the custom compute
    x-ms-discriminator-value: CustomCompute
  TargetIndex:
    title: TargetIndex
    description: Information about the index to be created.
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: '#/definitions/TargetType'
  TargetType:
    type: string
    description: The target type.
    enum:
      - AzureAISearch
      - CosmosDB
      - Pinecone
    x-ms-enum:
      name: TargetType
      modelAsString: true
      values:
        - name: AzureAISearch
          value: AzureAISearch
          description: Azure AI Search Index.
        - name: CosmosDB
          value: CosmosDB
          description: CosmosDB Index.
        - name: Pinecone
          value: Pinecone
          description: Pinecone Index.
  AzureAISearchIndex:
    description: Azure AI Search Index.
    required:
      - connectionId
    allOf:
      - $ref: '#/definitions/TargetIndex'
      - type: object
        properties:
          connectionId:
            type: string
            description: The id of the connection pointing to the Azure AI Search Index.
    x-ms-discriminator-value: AzureAISearch
  CosmosDBIndex:
    description: CosmosDB Index.
    required:
      - connectionId
    allOf:
      - $ref: '#/definitions/TargetIndex'
      - type: object
        properties:
          connectionId:
            type: string
            description: The id of the connection pointing to the cosmos DB.
          collectionName:
            type: string
            description: The name of the cosmos DB collection.
          databaseName:
            type: string
            description: The name of the cosmos DB database.
    x-ms-discriminator-value: CosmosDB
  PineconeIndex:
    description: Pinecone Index.
    required:
      - connectionId
    allOf:
      - $ref: '#/definitions/TargetIndex'
      - type: object
        properties:
          connectionId:
            type: string
            description: The id of the connection pointing to the pinecone.
    x-ms-discriminator-value: Pinecone
  UserComputeDatasource:
    title: UserComputeDatasource
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: '#/definitions/UserComputeDatasourceType'
  UserComputeDatasourceType:
    type: string
    description: The datasource type.
    enum:
      - Dataset
      - Urls
    x-ms-enum:
      name: UserComputeDatasourceType
      modelAsString: true
      values:
        - name: Dataset
          value: Dataset
          description: Workspace Dataset.
        - name: Urls
          value: Urls
          description: URLs.
  UserComputeDataset:
    type: object
    title: UserComputeStorage
    description: Storage account
    required:
      - datasetId
      - datasetType
    x-ms-discriminator-value: Dataset
    allOf:
      - $ref: '#/definitions/UserComputeDatasource'
      - type: object
        properties:
          datasetId:
            type: string
          datasetType:
            type: string
          chunking:
            $ref: '#/definitions/ChunkingSettings'
          embeddings:
            type: array
            items:
              $ref: '#/definitions/WorkspaceConnectionEmbeddingSettings'
  UserComputeUrl:
    type: object
    title: UserComputeUrl
    description: Urls
    required:
      - urls
      - embeddings
    x-ms-discriminator-value: Urls
    allOf:
      - $ref: '#/definitions/UserComputeDatasource'
      - type: object
        properties:
          urls:
            type: array
            items:
              type: string
          crawling:
            $ref: '#/definitions/CrawlingSettings'
          chunking:
            $ref: '#/definitions/ChunkingSettings'
          embeddings:
            type: array
            items:
              $ref: '#/definitions/WorkspaceConnectionEmbeddingSettings'
  SystemComputeDatasource:
    title: SystemComputeDatasource
    type: object
    required:
      - kind
    properties:
      kind:
        $ref: '#/definitions/SystemComputeDatasourceType'
    discriminator: kind
  SystemComputeDatasourceType:
    type: string
    description: The datasource type.
    enum:
      - Storage
      - Urls
    x-ms-enum:
      name: SystemComputeDatasourceType
      modelAsString: true
      values:
        - name: Storage
          value: Storage
          description: Azure Storage Account.
        - name: Urls
          value: Urls
          description: URLs.
  SystemComputeStorage:
    title: SystemComputeStorage
    description: Storage account
    required:
      - connection
      - containerName
      - embeddings
    x-ms-discriminator-value: Storage
    allOf:
      - $ref: '#/definitions/SystemComputeDatasource'
      - type: object
        properties:
          connection:
            $ref: '#/definitions/BaseConnection'
          containerName:
            type: string
            description: container name
          chunking:
            $ref: '#/definitions/ChunkingSettings'
          embeddings:
            type: array
            items:
              $ref: '#/definitions/GenericEmbeddingSettings'
  SystemComputeUrl:
    title: SystemComputeUrl
    description: Urls
    required:
      - urls
      - connection
      - containerName
      - embeddings
    x-ms-discriminator-value: Urls
    allOf:
      - $ref: '#/definitions/SystemComputeDatasource'
      - type: object
        properties:
          urls:
            type: array
            items:
              type: string
          connection:
            $ref: '#/definitions/BaseConnection'
          containerName:
            type: string
            description: container name
          crawling:
            $ref: '#/definitions/CrawlingSettings'
          chunking:
            $ref: '#/definitions/ChunkingSettings'
          embeddings:
            type: array
            items:
              $ref: '#/definitions/GenericEmbeddingSettings'
  ChunkingSettings:
    type: object
    title: ChunkingSettings
    description: Chunking settings
    properties:
      maxChunkSizeInTokens:
        type: integer
  CrawlingSettings:
    type: object
    title: CrawlingSettings
    description: Crawling settings
    properties:
      maxCrawlDepth:
        type: integer
      maxCrawlTimeInMins:
        type: integer
      maxDownloadTimeInMins:
        type: integer
      maxFileSize:
        type: integer
      maxRedirects:
        type: integer
      maxFiles:
        type: integer
  GenericEmbeddingSettings:
    title: ConnectionEmbeddingSettings
    description: Connection Embedding Settings
    type: object
    properties:
      connection:
        $ref: '#/definitions/BaseConnection'
      deploymentName:
        type: string
      modelName:
        type: string
  WorkspaceConnectionEmbeddingSettings:
    title: WorkspaceConnectionEmbeddingSettings
    description: Connection id to the embedding model
    type: object
    properties:
      connectionId:
        type: string
      deploymentName:
        type: string
      modelName:
        type: string
  BaseConnection:
    title: BaseConnection
    description: A connection to a resource.
    type: object
    required:
      - kind
    properties:
      kind:
        $ref: '#/definitions/ConnectionType'
    discriminator: kind
  ConnectionType:
    type: string
    description: The connection type.
    enum:
      - EndpointWithKey
      - ConnectionString
      - EndpointWithManagedIdentity
      - WorkspaceConnection
      - RelativeConnection
    x-ms-enum:
      name: ConnectionType
      modelAsString: true
      values:
        - name: EndpointWithKey
          value: EndpointWithKey
          description: Endpoint and key connection.
        - name: ConnectionString
          value: ConnectionString
          description: Connection string.
        - name: EndpointWithManagedIdentity
          value: EndpointWithManagedIdentity
          description: Endpoint and managed identity.
        - name: WorkspaceConnection
          value: WorkspaceConnection
          description: AML Workspace connection.
        - name: RelativeConnection
          value: RelativeConnection
          description: Relative deployment
  EndpointKeyConnection:
    description: Endpoint key connection.
    required:
      - endpoint
      - key
    allOf:
      - $ref: '#/definitions/BaseConnection'
      - type: object
        properties:
          endpoint:
            type: string
            description: Endpoint
          key:
            type: string
            description: Key
    x-ms-discriminator-value: EndpointWithKey
  ConnectionStringConnection:
    description: Connection string connection.
    required:
      - connectionString
    allOf:
      - $ref: '#/definitions/BaseConnection'
      - type: object
        properties:
          connectionString:
            type: string
            description: Connection string
    x-ms-discriminator-value: ConnectionString
  EndpointMIConnection:
    description: Endpoint Managed Identity connection.
    required:
      - endpoint
    allOf:
      - $ref: '#/definitions/BaseConnection'
      - type: object
        properties:
          endpoint:
            type: string
            description: Endpoint
          resourceId:
            type: string
            description: Resource Id
    x-ms-discriminator-value: EndpointWithManagedIdentity
  WorkspaceConnection:
    description: AML Workspace connection.
    required:
      - connectionId
    allOf:
      - $ref: '#/definitions/BaseConnection'
      - type: object
        properties:
          connectionId:
            type: string
            description: ConnectionId
    x-ms-discriminator-value: WorkspaceConnection
  DeploymentConnection:
    description: Relative deployment connection.
    allOf:
      - $ref: '#/definitions/BaseConnection'
    x-ms-discriminator-value: RelativeConnection
  CompletionAction:
    type: string
    description: The completion action.
    enum:
      - cleanUpTempAssets
      - keepAllAssets
    x-ms-enum:
      name: IngestionJobCompletionAction
      modelAsString: true
      values:
        - name: keepAllAssets
          value: keepAllAssets
          description: >-
            Will not clean up any of the intermediate assets created during the
            ingestion process.
        - name: cleanUpTempAssets
          value: cleanUpTempAssets
          description: >-
            Will clean up intermediate assets created during the ingestion
            process.
  IngestionJobList:
    title: IngestionJobList
    description: Represents a list of ingestion jobs.
    type: object
    properties:
      nextLink:
        description: The link to the next page.
        type: string
      value:
        description: The list of items.
        type: array
        items:
          $ref: '#/definitions/IngestionJob'
  IngestionJobRunList:
    title: IngestionJobRunList
    description: Represents a list of ingestion job runs.
    type: object
    properties:
      nextLink:
        description: The link to the next page.
        type: string
      value:
        description: The list of items.
        type: array
        items:
          $ref: '#/definitions/IngestionJobRun'
  IngestionJobRun:
    title: IngestionJobRun
    description: The details of a job run
    type: object
    properties:
      jobId:
        type: string
      runId:
        type: string
      status:
        $ref: '#/definitions/OperationState'
      error:
        $ref: '#/definitions/IngestionError'
      warnings:
        type: array
        items:
          type: string
      progress:
        $ref: '#/definitions/IngestionJobProgress'
  IngestionError:
    title: IngestionError
    description: The details of the ingestion error
    type: object
    properties:
      message:
        type: string
      innerErrors:
        type: array
        items:
          type: string
  IngestionJobProgress:
    title: IngestionJobProgress
    type: object
    required:
      - stageProgress
    properties:
      stageProgress:
        type: array
        items:
          $ref: '#/definitions/IngestionJobStageProgress'
  IngestionJobStageProgress:
    title: IngestionJobStageProgress
    type: object
    properties:
      name:
        type: string
      totalItems:
        type: integer
        format: int32
      processedItems:
        type: integer
        format: int32
      state:
        $ref: '#/definitions/OperationState'
      subStageProgress:
        type: array
        items:
          $ref: '#/definitions/IngestionJobStageProgress'
parameters:
  endpoint:
    in: path
    name: endpoint
    description: >-
      Supported Cognitive Services endpoints (protocol and hostname, for
      example: https://aoairesource.openai.azure.com. Replace "aoairesource"
      with your Azure OpenAI account name).
    required: true
    type: string
    format: url
    x-ms-skip-url-encoding: true
    x-ms-parameter-location: client
  apiVersionQueryParameter:
    in: query
    name: api-version
    description: The requested API version.
    required: true
    type: string
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



