Parseflow · Capability

Index And Search

Run with Naftiko

Capability Spec

index-and-search.yaml Raw ↑
apiVersion: naftiko.io/v1
kind: Capability
metadata:
  name: index-and-search
  version: 1.0.0-alpha2
  labels:
    provider: parseflow
    family: search
    domain: document-ai
spec:
  title: Index and Search Documents
  description: |
    Add a document to Parseflow's keyword search index and query, list, retrieve,
    or delete indexed documents. The index uses Parseflow's parse/chunk pipeline,
    so indexed payloads are already structured.
  sharedAPI:
    $ref: ./shared/parseflow-api.yaml
  operations:
    - name: index-document
      consume:
        http:
          method: POST
          path: /v2/index
          contentType: multipart/form-data
      inputs:
        - { name: file, type: file }
        - { name: text, type: string }
        - { name: document_id, type: string }
        - { name: chunk_size, type: integer, default: 2000 }
        - { name: overlap, type: integer, default: 200 }
        - { name: mode, type: string, default: basic }
        - { name: schema_json, type: string }
    - name: search
      consume:
        http:
          method: GET
          path: /v2/search
      inputs:
        - { name: q, type: string, in: query }
        - { name: limit, type: integer, in: query, default: 10 }
    - name: list-documents
      consume:
        http:
          method: GET
          path: /v2/search/documents
      inputs:
        - { name: limit, type: integer, in: query, default: 50 }
        - { name: offset, type: integer, in: query, default: 0 }
    - name: get-document
      consume:
        http:
          method: GET
          path: /v2/search/documents/{document_id}
      inputs:
        - { name: document_id, type: string, in: path, required: true }
    - name: delete-document
      consume:
        http:
          method: DELETE
          path: /v2/search/documents/{document_id}
      inputs:
        - { name: document_id, type: string, in: path, required: true }
  expose:
    rest:
      path: /capabilities/index-and-search
    mcp:
      tools:
        - parseflow_index_document
        - parseflow_search
        - parseflow_list_documents
        - parseflow_get_document
        - parseflow_delete_document
  outputs:
    schemaRef: ../json-schema/parseflow-indexed-document-schema.json