Antfly · Schema

QueryBuilderResult

Artificial IntelligenceSearchRetrievalVectorsHybrid

Properties

Name Type Description
session_id string Correlation identifier for client-carried continuation.
iteration integer Number of internal passes consumed while producing this result.
clarification_count integer Number of user clarification turns already consumed in this interaction.
status object Current status of the bounded query-builder execution.
steps array Shared bounded-agent execution trace for this query-builder run.
remaining_internal_iterations integer Remaining internal reasoning passes for this interaction.
remaining_user_clarifications integer Remaining clarification turns allowed for this interaction.
questions array Clarification questions exposed in the shared bounded-agent envelope.
query object Generated search query in Antfly's native full-text query format (a Bleve-compatible JSON query DSL: `match`, `term`, `conjuncts`, `disjuncts`, `must_not`, etc.). Can be used directly in QueryRequest.
query_request object Antfly query request assembled by the coordinator. New clients should prefer this field when they want an executable Antfly query object.
retrieval_query_request object Antfly retrieval query assembled by the coordinator when the requested artifact is intended for retrieval. Apply retrieval_navigation to steps.retrieval.navigation. This is additive to query_request f
retrieval_navigation object Optional retrieval-step navigation policy for the returned query at query_index zero.
specialist string Specialist or strategy used to build the query, such as `full_text`, `filter`, or `hybrid`.
plan object Optional machine-readable coordination plan for observability.
explanation string Human-readable explanation of what the query does and why it was structured this way
confidence number Model's confidence in the generated query (0.0-1.0)
warnings array Any issues, limitations, or assumptions made when generating the query
View JSON Schema on GitHub

JSON Schema

antfly-query-builder-result-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/antfly/json-schema/antfly-query-builder-result-schema.json",
  "title": "QueryBuilderResult",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/antfly-query-operations-api-openapi.yml#/components/schemas/QueryBuilderResult",
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "session_id": {
      "type": "string",
      "description": "Correlation identifier for client-carried continuation."
    },
    "iteration": {
      "type": "integer",
      "description": "Number of internal passes consumed while producing this result."
    },
    "clarification_count": {
      "type": "integer",
      "description": "Number of user clarification turns already consumed in this interaction."
    },
    "status": {
      "$ref": "#/$defs/AgentStatus",
      "description": "Current status of the bounded query-builder execution."
    },
    "steps": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AgentStep"
      },
      "description": "Shared bounded-agent execution trace for this query-builder run."
    },
    "remaining_internal_iterations": {
      "type": "integer",
      "description": "Remaining internal reasoning passes for this interaction."
    },
    "remaining_user_clarifications": {
      "type": "integer",
      "description": "Remaining clarification turns allowed for this interaction."
    },
    "questions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AgentQuestion"
      },
      "description": "Clarification questions exposed in the shared bounded-agent envelope."
    },
    "query": {
      "type": "object",
      "description": "Generated search query in Antfly's native full-text query format (a Bleve-compatible\nJSON query DSL: `match`, `term`, `conjuncts`, `disjuncts`, `must_not`, etc.).\nCan be used directly in QueryRequest.full_text_search or filter_query.\n",
      "additionalProperties": true
    },
    "query_request": {
      "$ref": "#/$defs/QueryRequest",
      "description": "Antfly query request assembled by the coordinator. New clients should prefer this\nfield when they want an executable Antfly query object.\n"
    },
    "retrieval_query_request": {
      "$ref": "#/$defs/QueryRequest",
      "description": "Antfly retrieval query assembled by the coordinator when the requested artifact\nis intended for retrieval. Apply retrieval_navigation to steps.retrieval.navigation. This is additive to\nquery_request for clients that execute through the retrieval agent pipeline.\n"
    },
    "retrieval_navigation": {
      "$ref": "#/$defs/RetrievalNavigationConfig",
      "description": "Optional retrieval-step navigation policy for the returned query at query_index zero."
    },
    "specialist": {
      "type": "string",
      "description": "Specialist or strategy used to build the query, such as `full_text`, `filter`, or `hybrid`."
    },
    "plan": {
      "type": "object",
      "additionalProperties": true,
      "description": "Optional machine-readable coordination plan for observability."
    },
    "explanation": {
      "type": "string",
      "description": "Human-readable explanation of what the query does and why it was structured this way"
    },
    "confidence": {
      "type": "number",
      "format": "double",
      "minimum": 0,
      "maximum": 1,
      "description": "Model's confidence in the generated query (0.0-1.0)"
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Any issues, limitations, or assumptions made when generating the query"
    }
  },
  "$defs": {
    "AgentQuestion": {
      "type": "object",
      "required": [
        "id",
        "kind",
        "question"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable question identifier for client-carried continuation"
        },
        "kind": {
          "$ref": "#/$defs/AgentQuestionKind"
        },
        "question": {
          "type": "string",
          "description": "The clarifying question to ask the user"
        },
        "reason": {
          "type": "string",
          "description": "Why clarification is needed"
        },
        "options": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Optional list of choices for the user"
        },
        "default_answer": {
          "type": "string",
          "description": "Suggested default answer when the server has a preferred choice"
        },
        "affects": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "High-level result areas affected by this decision"
        }
      }
    },
    "AgentQuestionKind": {
      "type": "string",
      "enum": [
        "confirm",
        "single_choice",
        "multi_choice",
        "free_text",
        "field_policy"
      ],
      "description": "UI rendering/answer handling hint for a bounded agent question"
    },
    "AgentStatus": {
      "type": "string",
      "enum": [
        "clarification_required",
        "completed",
        "in_progress",
        "incomplete",
        "failed"
      ],
      "description": "Shared bounded-agent execution status"
    },
    "AgentStep": {
      "type": "object",
      "description": "A step in the shared bounded-agent execution trace",
      "required": [
        "name",
        "action"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique step ID for correlation and tracing"
        },
        "kind": {
          "$ref": "#/$defs/AgentStepKind"
        },
        "name": {
          "type": "string",
          "description": "Stable step name used for correlation across JSON and SSE surfaces"
        },
        "action": {
          "type": "string",
          "description": "What action was taken"
        },
        "status": {
          "$ref": "#/$defs/AgentStepStatus"
        },
        "error_message": {
          "type": "string",
          "description": "Error details when status is \"error\""
        },
        "duration_ms": {
          "type": "integer",
          "description": "Server-side execution time in milliseconds"
        },
        "details": {
          "type": "object",
          "additionalProperties": true,
          "description": "Additional details about the step"
        }
      }
    },
    "AgentStepKind": {
      "type": "string",
      "enum": [
        "tool_call",
        "planning",
        "classification",
        "generation",
        "validation",
        "clarification"
      ],
      "description": "Shared bounded-agent step category"
    },
    "AgentStepStatus": {
      "type": "string",
      "enum": [
        "success",
        "error",
        "skipped"
      ],
      "description": "Outcome of a shared agent step"
    },
    "AggregationDateRange": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the date range bucket"
        },
        "from": {
          "type": "string",
          "x-go-type-skip-optional-pointer": false,
          "description": "Start date (ISO 8601 or relative like \"now-7d\")"
        },
        "to": {
          "type": "string",
          "x-go-type-skip-optional-pointer": false,
          "description": "End date (ISO 8601 or relative like \"now\")"
        }
      }
    },
    "AggregationRange": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the range bucket"
        },
        "from": {
          "type": "number",
          "format": "float",
          "x-go-type": "float64",
          "x-go-type-skip-optional-pointer": false,
          "description": "Lower bound (inclusive)"
        },
        "to": {
          "type": "number",
          "format": "float",
          "x-go-type": "float64",
          "x-go-type-skip-optional-pointer": false,
          "description": "Upper bound (exclusive)"
        }
      }
    },
    "AggregationRequest": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "$ref": "#/$defs/AggregationType"
        },
        "field": {
          "type": "string",
          "description": "Field to aggregate on. Required unless `fields` is supplied for a multi-field terms aggregation."
        },
        "mode": {
          "x-go-type-skip-optional-pointer": false,
          "allOf": [
            {
              "$ref": "#/$defs/CardinalityMode"
            }
          ],
          "description": "Selection mode for a cardinality aggregation. `auto` (default) uses a materialized HyperLogLog sketch when one applies and is current, else falls back to an exact distinct scan. `exact` always scans. `approximate` requires a sketch and errors if none applies. Ignored for other types."
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Ordered field list for multi-field terms aggregations. Each bucket key is a JSON string containing the serialized value array in the same order; clients should parse bucket.key as JSON."
        },
        "size": {
          "type": "integer",
          "x-go-type-skip-optional-pointer": false,
          "description": "Maximum number of buckets to return (for bucketing aggregations)"
        },
        "ranges": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AggregationRange"
          },
          "description": "Ranges for range aggregations"
        },
        "date_ranges": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AggregationDateRange"
          },
          "description": "Date ranges for date_range aggregations"
        },
        "interval": {
          "type": "number",
          "format": "float",
          "x-go-type": "float64",
          "x-go-type-skip-optional-pointer": false,
          "description": "Fixed interval for histogram aggregations"
        },
        "calendar_interval": {
          "x-go-type-skip-optional-pointer": false,
          "allOf": [
            {
              "$ref": "#/$defs/CalendarInterval"
            }
          ],
          "description": "Calendar-aware interval for date_histogram aggregations"
        },
        "origin": {
          "type": "string",
          "x-go-type-skip-optional-pointer": false,
          "description": "Origin for geohash_grid aggregation (format: \"lat,lon\")\nExample: \"37.7749,-122.4194\"\n"
        },
        "precision": {
          "type": "integer",
          "x-go-type-skip-optional-pointer": false,
          "description": "Geohash precision (1-12) for geohash_grid aggregations"
        },
        "distance_ranges": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DistanceRange"
          },
          "description": "Distance ranges for geo_distance aggregations"
        },
        "unit": {
          "x-go-type-skip-optional-pointer": false,
          "allOf": [
            {
              "$ref": "#/$defs/DistanceUnit"
            }
          ],
          "description": "Distance unit for geo_distance aggregations"
        },
        "min_doc_count": {
          "type": "integer",
          "x-go-type-skip-optional-pointer": false,
          "description": "Minimum document count for a bucket to be included"
        },
        "background_filter": {
          "$ref": "#/$defs/RawQuery",
          "description": "Background filter for significant_terms aggregations"
        },
        "algorithm": {
          "x-go-type-skip-optional-pointer": false,
          "allOf": [
            {
              "$ref": "#/$defs/SignificanceAlgorithm"
            }
          ],
          "description": "Significance algorithm for significant_terms aggregations"
        },
        "algebraic_join": {
          "$ref": "#/$defs/AlgebraicAggregationJoin",
          "description": "Algebraic join descriptor for bounded cross-table aggregation planning"
        },
        "sub_aggregations": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/AggregationRequest"
          },
          "description": "Nested sub-aggregations"
        }
      }
    },
    "AggregationType": {
      "type": "string",
      "enum": [
        "sum",
        "avg",
        "min",
        "max",
        "count",
        "sumsquares",
        "stats",
        "cardinality",
        "terms",
        "range",
        "date_range",
        "histogram",
        "date_histogram",
        "geohash_grid",
        "geo_distance",
        "significant_terms"
      ],
      "description": "Type of aggregation to compute:\n- Metrics: sum, avg, min, max, count, sumsquares, stats, cardinality\n- Bucketing: terms, range, date_range, histogram, date_histogram\n- Geo: geohash_grid, geo_distance\n- Analytics: significant_terms\n"
    },
    "AlgebraicAggregationJoin": {
      "type": "object",
      "required": [
        "name",
        "group_side",
        "measure_side"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Algebraic join materialization or capability name"
        },
        "kind": {
          "type": "string",
          "enum": [
            "none",
            "bucket",
            "window",
            "bucket_window"
          ],
          "x-go-type-skip-optional-pointer": false,
          "description": "Temporal join mode for the algebraic materialization"
        },
        "group_side": {
          "type": "string",
          "description": "Join side that supplies grouping bucket values"
        },
        "measure_side": {
          "type": "string",
          "description": "Join side that supplies metric values"
        }
      }
    },
    "Analyses": {
      "x-go-type-skip-optional-pointer": false,
      "type": "object",
      "properties": {
        "pca": {
          "type": "boolean"
        },
        "tsne": {
          "type": "boolean"
        }
      }
    },
    "AntflyRerankerConfig": {
      "type": "object",
      "description": "Configuration for the Antfly inference reranking provider.",
      "properties": {
        "provider": {
          "type": "string",
          "enum": [
            "antfly"
          ]
        },
        "api_key": {
          "type": "string",
          "description": "Optional bearer API key for remote Antfly inference. Supports secret references and defaults to ANTFLY_INFERENCE_API_KEY. Embedded inference does not resolve or use outbound credentials."
        },
        "model": {
          "type": "string",
          "description": "Optional reranking model name. When omitted, Antfly inference selects a model from its reranker model directory. Set this explicitly when more than one local reranker is installed."
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "The URL of the Inference API endpoint. Can also be set via ANTFLY_INFERENCE_URL environment variable."
        }
      },
      "required": [
        "provider"
      ]
    },
    "AutocompleteQuery": {
      "type": "object",
      "additionalProperties": false,
      "description": "Analyzed bool-prefix search on a logical field. The planner selects\ndeclared search-as-you-type root, shingle and prefix representations.\nRequires a compatible representation; never silently becomes raw prefix search.\n",
      "required": [
        "autocomplete",
        "field"
      ],
      "properties": {
        "autocomplete": {
          "type": "string"
        },
        "field": {
          "type": "string",
          "minLength": 1
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        }
      }
    },
    "BoolFieldQuery": {
      "type": "object",
      "properties": {
        "bool": {
          "type": "boolean"
        },
        "field": {
          "type": "string"
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        }
      },
      "required": [
        "bool"
      ]
    },
    "BoolQuery": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "bool"
      ],
      "description": "Canonical Boolean wrapper. Must clauses score; filter clauses constrain without scoring.",
      "properties": {
        "bool": {
          "$ref": "#/$defs/BoolQueryBody"
        }
      }
    },
    "BoolQueryBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "must": {
          "$ref": "#/$defs/BoolQueryClause"
        },
        "should": {
          "$ref": "#/$defs/BoolQueryClause"
        },
        "must_not": {
          "$ref": "#/$defs/BoolQueryClause"
        },
        "filter": {
          "$ref": "#/$defs/BoolQueryClause"
        },
        "minimum_should_match": {
          "type": "integer",
          "format": "uint32",
          "minimum": 0,
          "description": "Minimum optional clauses required; omission follows the runtime's required-clause defaults."
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        }
      }
    },
    "BoolQueryClause": {
      "oneOf": [
        {
          "$ref": "#/$defs/Query"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Query"
          }
        }
      ]
    },
    "BooleanQuery": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "must": {
          "$ref": "#/$defs/ConjunctionQuery"
        },
        "should": {
          "$ref": "#/$defs/DisjunctionQuery"
        },
        "must_not": {
          "$ref": "#/$defs/DisjunctionQuery"
        },
        "filter": {
          "$ref": "#/$defs/Query"
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        }
      }
    },
    "Boost": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "A floating-point number used to decrease or increase the relevance scores of a query.",
      "default": 1.0
    },
    "CalendarInterval": {
      "type": "string",
      "enum": [
        "minute",
        "hour",
        "day",
        "week",
        "month",
        "quarter",
        "year"
      ],
      "description": "Calendar-aware interval for date_histogram aggregations"
    },
    "CardinalityMode": {
      "type": "string",
      "enum": [
        "auto",
        "exact",
        "approximate"
      ],
      "description": "Exact-vs-approximate selection for a cardinality aggregation:\n- auto: use a materialized HyperLogLog sketch when one applies and is\n  current, else an exact distinct scan (default).\n- exact: always compute an exact distinct count.\n- approximate: require a matching sketch; error if none applies.\n"
    },
    "CatalogTableTarget": {
      "type": "object",
      "description": "An explicit native table target. Components are literal names; dots do not qualify a string table name.",
      "properties": {
        "database": {
          "type": "string",
          "default": "default"
        },
        "namespace": {
          "type": "string",
          "default": "public"
        },
        "table": {
          "type": "string"
        }
      },
      "required": [
        "table"
      ],
      "additionalProperties": false
    },
    "CloudflareRerankerConfig": {
      "type": "object",
      "description": "Cloudflare Workers AI reranking. Uses CLOUDFLARE_API_TOKEN or an Antfly secret reference.",
      "properties": {
        "provider": {
          "type": "string",
          "enum": [
            "cloudflare"
          ]
        },
        "account_id": {
          "type": "string",
          "minLength": 1
        },
        "gateway_id": {
          "type": "string",
          "minLength": 1,
          "description": "Optional AI Gateway ID, sent through cf-aig-gateway-id."
        },
        "model": {
          "type": "string",
          "default": "@cf/baai/bge-reranker-base"
        },
        "api_key": {
          "type": "string",
          "writeOnly": true
        },
        "url": {
          "type": "string",
          "description": "Optional deployment-owned endpoint override."
        }
      },
      "required": [
        "provider",
        "account_id",
        "model"
      ]
    },
    "CohereRerankerConfig": {
      "type": "object",
      "description": "Configuration for the Cohere reranking provider.\n\nAPI key via `api_key` field or `COHERE_API_KEY` environment variable.\n\n**Example Models:** rerank-english-v3.0 (default), rerank-multilingual-v3.0\n\n**Docs:** https://docs.cohere.com/reference/rerank",
      "properties": {
        "provider": {
          "type": "string",
          "enum": [
            "cohere"
          ]
        },
        "model": {
          "type": "string",
          "description": "The name of the Cohere reranking model to use.",
          "default": "rerank-english-v3.0"
        },
        "api_key": {
          "type": "string",
          "description": "The Cohere API key. Can also be set via COHERE_API_KEY environment variable."
        }
      },
      "required": [
        "provider"
      ]
    },
    "ConjunctionQuery": {
      "type": "object",
      "properties": {
        "conjuncts": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Query"
          }
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        }
      },
      "required": [
        "conjuncts"
      ]
    },
    "ContainsQuery": {
      "type": "object",
      "additionalProperties": false,
      "description": "Contiguous substring search on the original logical field value, including whitespace and punctuation.\nNo normalization is applied. Case-sensitive by default; case_sensitive=false\nuses Unicode simple case folding, not locale-specific or multi-character folding.\nMissing, null, and non-string values do not match. Arrays use any-element\nsemantics; a match never spans array elements. Indexes select conservative\ncandidates and original values are verified before counting and pagination.\n",
      "required": [
        "contains",
        "field"
      ],
      "properties": {
        "contains": {
          "type": "string"
        },
        "field": {
          "type": "string",
          "minLength": 1,
          "description": "Logical source field path, not a companion index name."
        },
        "case_sensitive": {
          "type": "boolean",
          "default": true,
          "x-go-type-skip-optional-pointer": false
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        }
      }
    },
    "DateRangeStringQuery": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "type": "string",
          "format": "date-time",
          "x-go-type-skip-optional-pointer": false
        },
        "end": {
          "type": "string",
          "format": "date-time",
          "x-go-type-skip-optional-pointer": false
        },
        "inclusive_start": {
          "type": [
            "boolean",
            "null"
          ],
          "x-go-type-skip-optional-pointer": false
        },
        "inclusive_end": {
          "type": [
            "boolean",
            "null"
          ],
          "x-go-type-skip-optional-pointer": false
        },
        "field": {
          "type": "string"
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        },
        "datetime_parser": {
          "type": "string"
        }
      }
    },
    "DisjunctionQuery": {
      "type": "object",
      "properties": {
        "disjuncts": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Query"
          }
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        },
        "min": {
          "type": "integer",
          "format": "uint32",
          "minimum": 0,
          "x-go-type-skip-optional-pointer": false,
          "description": "Minimum number of disjuncts that must match. Omit for conventional disjunction semantics; set to 0 to make a pure disjunction optional."
        }
      },
      "required": [
        "disjuncts"
      ]
    },
    "DistanceRange": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the distance range bucket"
        },
        "from": {
          "type": "number",
          "format": "float",
          "x-go-type": "float64",
          "x-go-type-skip-optional-pointer": false,
          "description": "Minimum distance (inclusive)"
        },
        "to": {
          "type": "number",
          "format": "float",
          "x-go-type": "float64",
          "x-go-type-skip-optional-pointer": false,
          "description": "Maximum distance (exclusive)"
        }
      }
    },
    "DistanceUnit": {
      "type": "string",
      "enum": [
        "m",
        "km",
        "mi",
        "ft",
        "yd"
      ],
      "description": "Distance unit for geo aggregations:\n- m: meters\n- km: kilometers\n- mi: miles\n- ft: feet\n- yd: yards\n"
    },
    "DocIdQuery": {
      "type": "object",
      "properties": {
        "ids": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        }
      },
      "required": [
        "ids"
      ]
    },
    "EdgeDirection": {
      "x-go-type-skip-optional-pointer": true,
      "type": "string",
      "enum": [
        "out",
        "in",
        "both"
      ],
      "default": "out",
      "description": "Direction of edges to query:\n- out: Outgoing edges from the node\n- in: Incoming edges to the node\n- both: Both outgoing and incoming edges\n"
    },
    "Embedding": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "type": "number",
            "format": "float"
          },
          "description": "Dense embedding as an array of floats, e.g. `[0.1, 0.2, 0.3]`"
        },
        {
          "type": "object",
          "required": [
            "indices",
            "values"
          ],
          "properties": {
            "indices": {
              "type": "array",
              "items": {
                "type": "integer",
                "x-go-type": "uint32"
              }
            },
            "values": {
              "type": "array",
              "items": {
                "type": "number",
                "format": "float"
              }
            }
          },
          "description": "Sparse embedding with `indices` and `values` arrays"
        },
        {
          "type": "string",
          "format": "byte",
          "description": "Packed dense embedding as a base64-encoded string of raw little-endian float32 bytes.\nThis is ~4x more compact than the JSON array format. For example, a 3-dimensional\nvector `[1.0, 2.0, 3.0]` is encoded as base64(12 bytes of little-endian float32s).\n"
        },
        {
          "type": "object",
          "required": [
            "packed_indices",
            "packed_values"
          ],
          "properties": {
            "packed_indices": {
              "type": "string",
              "format": "byte",
              "description": "Base64-encoded little-endian uint32 bytes for sparse indices"
            },
            "packed_values": {
              "type": "string",
              "format": "byte",
              "description": "Base64-encoded little-endian float32 bytes for sparse values"
            }
          },
          "description": "Packed sparse embedding with base64-encoded indices and values.\nSame semantics as the sparse object format but more compact on the wire.\n"
        }
      ]
    },
    "EqualsQuery": {
      "type": "object",
      "additionalProperties": false,
      "description": "Whole string equality on the original logical field value.\nNo normalization is applied. Case-sensitive by default; case_sensitive=false\nuses Unicode simple case folding, not locale-specific or multi-character folding.\nMissing, null, and non-string values do not match. Arrays use any-element\nsemantics; a match never spans array elements. Indexes select conservative\ncandidates and original values are verified before counting and pagination.\n",
      "required": [
        "equals",
        "field"
      ],
      "properties": {
        "equals": {
          "type": "string"
        },
        "field": {
          "type": "string",
          "minLength": 1,
          "description": "Logical source field path, not a companion index name."
        },
        "case_sensitive": {
          "type": "boolean",
          "default": true,
          "x-go-type-skip-optional-pointer": false
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        }
      }
    },
    "ForeignColumn": {
      "type": "object",
      "required": [
        "name",
        "type"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Column name in the foreign table."
        },
        "type": {
          "type": "string",
          "description": "Column data type. Used for filter validation and type coercion.\nCommon types: text, integer, bigint, float, boolean, timestamp, uuid, jsonb.\n"
        },
        "nullable": {
          "type": "boolean",
          "description": "Whether the column allows NULL values.",
          "default": false
        }
      }
    },
    "ForeignSource": {
      "type": "object",
      "required": [
        "type",
        "dsn",
        "postgres_table"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of the foreign data source. Currently only \"postgres\" is supported.\n",
          "enum": [
            "postgres"
          ]
        },
        "dsn": {
          "type": "string",
          "description": "Data source name (connection string) for the foreign database.\nSupports `${secret:key_name}` references that resolve from the Antfly secret store\nor environment variables.\n"
        },
        "postgres_table": {
          "type": "string",
          "description": "Name of the table or view in the foreign PostgreSQL database to query.\n"
        },
        "columns": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ForeignColumn"
          },
          "description": "Optional column definitions for the foreign table. If omitted, columns are\nauto-discovered from `information_schema.columns` on first query.\n"
        }
      }
    },
    "Fuzziness": {
      "description": "The fuzziness of the query. Can be an integer or \"auto\".",
      "anyOf": [
        {
          "type": "integer",
          "format": "int32",
          "minimum": 0,
          "maximum": 2
        },
        {
          "type": "string",
          "enum": [
            "auto"
          ]
        }
      ]
    },
    "FuzzyQuery": {
      "type": "object",
      "properties": {
        "term": {
          "type": "string"
        },
        "prefix_length": {
          "type": "integer",
          "format": "int32",
          "minimum": 0,
          "maximum": 255
        },
        "fuzziness": {
          "$ref": "#/$defs/Fuzziness"
        },
        "field": {
          "type": "string"
        },
        "boost": {
          "$ref": "#/$defs/Boost"
        }
      },
      "required": [
        "term"
      ]
    },
    "GeoBoundingBoxQuery": {
      "type": "object",
      "description": "Geographic bounding box filter. The public query shape uses scalar latitude and longitude bounds to match structured filter_query.geo_bbox. Longitude ranges may cross the antimeridian by specifying a western/min longitude that is greater than the eastern/max longitude; for example, min_lon 179.5 and max_lon -179.5 matches points near +/-180 degrees longitude. Latitude bounds must be ordered with min_lat <= max_lat.\n",
      "properties": {
        "field": {
          "type": "string",
          "description": "Field or path contai

# --- truncated at 32 KB (179 KB total) ---
# Full source: https://artifacts.apis.io/antfly/json-schema/antfly-query-builder-result-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/antfly-query-builder-result"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.