Factset Natural Language Processing API — Summarization

naftiko: 1.0.0-alpha2
info:
  label: Factset Natural Language Processing API — Summarization
  description: 'Factset Natural Language Processing API — Summarization. 4 operations. Lead operation: Factset Endpoint to
    generate a headline from text. Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Summarization
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: natural-language-processing-summarization
    baseUri: https://api.factset.com/cognitive/nlp/v1
    description: Factset Natural Language Processing API — Summarization business capability. Self-contained, no shared references.
    resources:
    - name: summarization-headline
      path: /summarization/headline
      operations:
      - name: summarizationheadline
        method: POST
        description: Factset Endpoint to generate a headline from text
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: summarization-headline-and-summary
      path: /summarization/headline-and-summary
      operations:
      - name: summarizationheadlineandsummary
        method: POST
        description: Factset Endpoint to summarize and generate a headline from text
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: summarization-result-resultId
      path: /summarization/result/{resultId}
      operations:
      - name: summarizationresult
        method: GET
        description: Factset Endpoint to obtain result of a particular summarization job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resultId
          in: path
          type: string
          required: true
    - name: summarization-summary
      path: /summarization/summary
      operations:
      - name: summarizationsummary
        method: POST
        description: Factset Endpoint to summarize text
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.FACTSET_API_KEY}}'
  exposes:
  - type: rest
    namespace: natural-language-processing-summarization-rest
    port: 8080
    description: REST adapter for Factset Natural Language Processing API — Summarization. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/summarization/headline
      name: summarization-headline
      description: REST surface for summarization-headline.
      operations:
      - method: POST
        name: summarizationheadline
        description: Factset Endpoint to generate a headline from text
        call: natural-language-processing-summarization.summarizationheadline
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/summarization/headline-and-summary
      name: summarization-headline-and-summary
      description: REST surface for summarization-headline-and-summary.
      operations:
      - method: POST
        name: summarizationheadlineandsummary
        description: Factset Endpoint to summarize and generate a headline from text
        call: natural-language-processing-summarization.summarizationheadlineandsummary
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/summarization/result/{resultid}
      name: summarization-result-resultid
      description: REST surface for summarization-result-resultId.
      operations:
      - method: GET
        name: summarizationresult
        description: Factset Endpoint to obtain result of a particular summarization job
        call: natural-language-processing-summarization.summarizationresult
        with:
          resultId: rest.resultId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/summarization/summary
      name: summarization-summary
      description: REST surface for summarization-summary.
      operations:
      - method: POST
        name: summarizationsummary
        description: Factset Endpoint to summarize text
        call: natural-language-processing-summarization.summarizationsummary
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: natural-language-processing-summarization-mcp
    port: 9090
    transport: http
    description: MCP adapter for Factset Natural Language Processing API — Summarization. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: factset-endpoint-generate-headline-text
      description: Factset Endpoint to generate a headline from text
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: natural-language-processing-summarization.summarizationheadline
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-endpoint-summarize-and-generate
      description: Factset Endpoint to summarize and generate a headline from text
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: natural-language-processing-summarization.summarizationheadlineandsummary
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-endpoint-obtain-result-particular
      description: Factset Endpoint to obtain result of a particular summarization job
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: natural-language-processing-summarization.summarizationresult
      with:
        resultId: tools.resultId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-endpoint-summarize-text
      description: Factset Endpoint to summarize text
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: natural-language-processing-summarization.summarizationsummary
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.