{
  "opencollection": "1.0.0",
  "info": {
    "name": "Typesense Analytics Analytics Events Conversational Search API",
    "version": "30.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-TYPESENSE-API-KEY",
      "value": "{{X-TYPESENSE-API-KEY}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Conversational Search",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Perform A Conversational Search",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collectionName/documents/search",
            "params": [
              {
                "name": "collectionName",
                "value": "",
                "type": "path",
                "description": "Name of the collection to search."
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Natural language question or search query."
              },
              {
                "name": "query_by",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to search against."
              },
              {
                "name": "conversation",
                "value": "",
                "type": "query",
                "description": "Set to true to enable conversational search with RAG."
              },
              {
                "name": "conversation_model_id",
                "value": "",
                "type": "query",
                "description": "ID of the conversation model to use for generating answers."
              },
              {
                "name": "conversation_id",
                "value": "",
                "type": "query",
                "description": "ID of an existing conversation to continue a multi-turn dialog. If not provided, a new conversation is started."
              },
              {
                "name": "filter_by",
                "value": "",
                "type": "query",
                "description": "Filter conditions to narrow the search scope."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Sort conditions for the underlying search."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of documents to pass as context to the LLM."
              }
            ]
          },
          "docs": "Performs a search query with conversational RAG enabled. Typesense retrieves relevant documents and passes them as context to the configured LLM, which generates a natural language answer. Supports multi-turn conversations by passing a conversation_id to maintain context across queries."
        }
      ]
    }
  ],
  "bundled": true
}