Vectara Query Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/vectara/main/json-schema/vectara-query-schema.json",
  "title": "Vectara Query Request",
  "description": "Request body for the Vectara Query API. Combines a natural-language query with retrieval and grounded-generation parameters.",
  "type": "object",
  "required": ["query"],
  "properties": {
    "query": {
      "type": "string",
      "description": "Natural-language query string."
    },
    "search": {
      "type": "object",
      "properties": {
        "limit": { "type": "integer", "default": 10 },
        "offset": { "type": "integer", "default": 0 },
        "metadata_filter": { "type": "string" },
        "lexical_interpolation": {
          "type": "number",
          "minimum": 0,
          "maximum": 1,
          "description": "Hybrid search blend between lexical (1.0) and semantic (0.0)."
        },
        "reranker": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": ["customer_reranker", "mmr", "chain", "userfn"],
              "description": "Reranker type applied after initial retrieval."
            },
            "reranker_id": { "type": "string" },
            "diversity_bias": { "type": "number" }
          }
        }
      }
    },
    "generation": {
      "type": "object",
      "properties": {
        "generation_preset_name": { "type": "string" },
        "max_used_search_results": { "type": "integer" },
        "response_language": { "type": "string" },
        "enable_factual_consistency_score": {
          "type": "boolean",
          "description": "Whether to compute Vectara's Hughes Hallucination Evaluation Model (HHEM) factual-consistency score."
        },
        "citations": {
          "type": "object",
          "properties": {
            "style": {
              "type": "string",
              "enum": ["none", "numeric", "html", "markdown"]
            }
          }
        }
      }
    },
    "stream_response": {
      "type": "boolean",
      "description": "Whether to stream the response via Server-Sent Events."
    }
  }
}