Microsoft Azure Text Analytics Client — Entities

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure Text Analytics Client — Entities
  description: 'Microsoft Azure Text Analytics Client — Entities. 6 operations. Lead operation: Microsoft Azure Submit Healthcare
    Analysis Job. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - Entities
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: text-analytics-client-entities
    baseUri: ''
    description: Microsoft Azure Text Analytics Client — Entities business capability. Self-contained, no shared references.
    resources:
    - name: entities-health-jobs
      path: /entities/health/jobs
      operations:
      - name: microsoftazurehealth
        method: POST
        description: Microsoft Azure Submit Healthcare Analysis Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: entities-health-jobs-jobId
      path: /entities/health/jobs/{jobId}
      operations:
      - name: microsoftazurehealthstatus
        method: GET
        description: Microsoft Azure Get Healthcare Analysis Job Status And Results
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: $top
          in: query
          type: integer
          description: (Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip
            is applied first.
        - name: $skip
          in: query
          type: integer
          description: (Optional) Set the number of elements to offset in the response. When both $top and $skip are specified,
            $skip is applied first.
      - name: microsoftazurecancelhealthjob
        method: DELETE
        description: Microsoft Azure Cancel Healthcare Prediction Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: entities-linking
      path: /entities/linking
      operations:
      - name: microsoftazureentitieslinking
        method: POST
        description: Microsoft Azure Linked Entities From A Well Known Knowledge Base
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: entities-recognition-general
      path: /entities/recognition/general
      operations:
      - name: microsoftazureentitiesrecognitiongeneral
        method: POST
        description: Microsoft Azure Named Entity Recognition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: entities-recognition-pii
      path: /entities/recognition/pii
      operations:
      - name: microsoftazureentitiesrecognitionpii
        method: POST
        description: Microsoft Azure Entities Containing Personal Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: domain
          in: query
          type: string
          description: '(Optional) if specified, will set the PII domain to include only a subset of the entity categories.
            Possible values include: ''PHI'', ''none''.'
  exposes:
  - type: rest
    namespace: text-analytics-client-entities-rest
    port: 8080
    description: REST adapter for Microsoft Azure Text Analytics Client — Entities. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/entities/health/jobs
      name: entities-health-jobs
      description: REST surface for entities-health-jobs.
      operations:
      - method: POST
        name: microsoftazurehealth
        description: Microsoft Azure Submit Healthcare Analysis Job
        call: text-analytics-client-entities.microsoftazurehealth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/entities/health/jobs/{jobid}
      name: entities-health-jobs-jobid
      description: REST surface for entities-health-jobs-jobId.
      operations:
      - method: GET
        name: microsoftazurehealthstatus
        description: Microsoft Azure Get Healthcare Analysis Job Status And Results
        call: text-analytics-client-entities.microsoftazurehealthstatus
        with:
          $top: rest.$top
          $skip: rest.$skip
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: microsoftazurecancelhealthjob
        description: Microsoft Azure Cancel Healthcare Prediction Job
        call: text-analytics-client-entities.microsoftazurecancelhealthjob
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/entities/linking
      name: entities-linking
      description: REST surface for entities-linking.
      operations:
      - method: POST
        name: microsoftazureentitieslinking
        description: Microsoft Azure Linked Entities From A Well Known Knowledge Base
        call: text-analytics-client-entities.microsoftazureentitieslinking
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/entities/recognition/general
      name: entities-recognition-general
      description: REST surface for entities-recognition-general.
      operations:
      - method: POST
        name: microsoftazureentitiesrecognitiongeneral
        description: Microsoft Azure Named Entity Recognition
        call: text-analytics-client-entities.microsoftazureentitiesrecognitiongeneral
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/entities/recognition/pii
      name: entities-recognition-pii
      description: REST surface for entities-recognition-pii.
      operations:
      - method: POST
        name: microsoftazureentitiesrecognitionpii
        description: Microsoft Azure Entities Containing Personal Information
        call: text-analytics-client-entities.microsoftazureentitiesrecognitionpii
        with:
          domain: rest.domain
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: text-analytics-client-entities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Azure Text Analytics Client — Entities. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: microsoft-azure-submit-healthcare-analysis
      description: Microsoft Azure Submit Healthcare Analysis Job
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: text-analytics-client-entities.microsoftazurehealth
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-healthcare-analysis
      description: Microsoft Azure Get Healthcare Analysis Job Status And Results
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: text-analytics-client-entities.microsoftazurehealthstatus
      with:
        $top: tools.$top
        $skip: tools.$skip
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-cancel-healthcare-prediction
      description: Microsoft Azure Cancel Healthcare Prediction Job
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: text-analytics-client-entities.microsoftazurecancelhealthjob
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-linked-entities-well
      description: Microsoft Azure Linked Entities From A Well Known Knowledge Base
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: text-analytics-client-entities.microsoftazureentitieslinking
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-named-entity-recognition
      description: Microsoft Azure Named Entity Recognition
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: text-analytics-client-entities.microsoftazureentitiesrecognitiongeneral
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-entities-containing-personal
      description: Microsoft Azure Entities Containing Personal Information
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: text-analytics-client-entities.microsoftazureentitiesrecognitionpii
      with:
        domain: tools.domain
      outputParameters:
      - type: object
        mapping: $.