Typesense Vector Search API — NL Search Models

naftiko: 1.0.0-alpha2
info:
  label: Typesense Vector Search API — NL Search Models
  description: 'Typesense Vector Search API — NL Search Models. 5 operations. Lead operation: List All NL Search Models. Self-contained
    Naftiko capability covering one Typesense business surface.'
  tags:
  - Typesense
  - NL Search Models
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TYPESENSE_API_KEY: TYPESENSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: vector-search-nl-search-models
    baseUri: ''
    description: Typesense Vector Search API — NL Search Models business capability. Self-contained, no shared references.
    resources:
    - name: nl_search_models
      path: /nl_search_models
      operations:
      - name: listnlsearchmodels
        method: GET
        description: List All NL Search Models
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createnlsearchmodel
        method: POST
        description: Create An NL Search Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: nl_search_models-modelId
      path: /nl_search_models/{modelId}
      operations:
      - name: getnlsearchmodel
        method: GET
        description: Retrieve An NL Search Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatenlsearchmodel
        method: PUT
        description: Update An NL Search Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletenlsearchmodel
        method: DELETE
        description: Delete An NL Search Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-TYPESENSE-API-KEY
      value: '{{env.TYPESENSE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: vector-search-nl-search-models-rest
    port: 8080
    description: REST adapter for Typesense Vector Search API — NL Search Models. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/nl-search-models
      name: nl-search-models
      description: REST surface for nl_search_models.
      operations:
      - method: GET
        name: listnlsearchmodels
        description: List All NL Search Models
        call: vector-search-nl-search-models.listnlsearchmodels
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createnlsearchmodel
        description: Create An NL Search Model
        call: vector-search-nl-search-models.createnlsearchmodel
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/nl-search-models/{modelid}
      name: nl-search-models-modelid
      description: REST surface for nl_search_models-modelId.
      operations:
      - method: GET
        name: getnlsearchmodel
        description: Retrieve An NL Search Model
        call: vector-search-nl-search-models.getnlsearchmodel
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatenlsearchmodel
        description: Update An NL Search Model
        call: vector-search-nl-search-models.updatenlsearchmodel
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletenlsearchmodel
        description: Delete An NL Search Model
        call: vector-search-nl-search-models.deletenlsearchmodel
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vector-search-nl-search-models-mcp
    port: 9090
    transport: http
    description: MCP adapter for Typesense Vector Search API — NL Search Models. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-all-nl-search-models
      description: List All NL Search Models
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vector-search-nl-search-models.listnlsearchmodels
      outputParameters:
      - type: object
        mapping: $.
    - name: create-nl-search-model
      description: Create An NL Search Model
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: vector-search-nl-search-models.createnlsearchmodel
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-nl-search-model
      description: Retrieve An NL Search Model
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vector-search-nl-search-models.getnlsearchmodel
      outputParameters:
      - type: object
        mapping: $.
    - name: update-nl-search-model
      description: Update An NL Search Model
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: vector-search-nl-search-models.updatenlsearchmodel
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-nl-search-model
      description: Delete An NL Search Model
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: vector-search-nl-search-models.deletenlsearchmodel
      outputParameters:
      - type: object
        mapping: $.