AskRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/georgiacommons-org/json-schema/georgiacommons-org-ask-request-schema.json",
  "title": "AskRequest",
  "x-generated": "2026-11-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/georgiacommons-org-openapi.json#/components/schemas/AskRequest",
  "properties": {
    "mode": {
      "type": "string",
      "enum": [
        "quick",
        "document"
      ],
      "title": "Mode",
      "default": "quick"
    },
    "messages": {
      "items": {
        "$ref": "#/$defs/ChatMessage"
      },
      "type": "array",
      "maxItems": 40,
      "minItems": 1,
      "title": "Messages"
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "es"
      ],
      "title": "Language",
      "default": "en"
    },
    "document_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Document Id",
      "description": "Required in document mode: the work id of the page the reader is on."
    },
    "search": {
      "anyOf": [
        {
          "$ref": "#/$defs/SearchOverride"
        },
        {
          "type": "null"
        }
      ]
    },
    "context_ids": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "maxItems": 10,
      "title": "Context Ids"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "messages"
  ],
  "$defs": {
    "ChatMessage": {
      "properties": {
        "role": {
          "type": "string",
          "enum": [
            "user",
            "assistant"
          ],
          "title": "Role"
        },
        "content": {
          "type": "string",
          "minLength": 1,
          "title": "Content"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "role",
        "content"
      ],
      "title": "ChatMessage"
    },
    "Filters": {
      "properties": {
        "doc_type": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Doc Type",
          "description": "Document types, e.g. bill, opinion, code_section, constitution_provision, meeting_transcript, amendment."
        },
        "level": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Level",
          "description": "Levels of government: federal, state, county, municipal, consolidated, school_district, regional."
        },
        "branch": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Branch",
          "description": "Branches: legislative, executive, judicial."
        },
        "body": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Body",
          "description": "Issuing bodies by id, e.g. ga-supreme-court, ga-senate, ga-house-rules (describe_site lists them)."
        },
        "body_type": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Body Type",
          "description": "Kinds of body: legislative_chamber, legislative_committee, court, board_of_education, governing_body, ..."
        },
        "place": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Place",
          "description": "A Georgia place in words or as an id (Atlanta, Cobb County, city:savannah). Matches the body's jurisdiction."
        },
        "include_overlapping": {
          "type": "boolean",
          "title": "Include Overlapping",
          "description": "With place: also bodies whose area overlaps it (Fulton and DeKalb for Atlanta).",
          "default": true
        },
        "place_scope": {
          "type": "string",
          "enum": [
            "either",
            "jurisdiction",
            "mentions"
          ],
          "title": "Place Scope",
          "description": "With place: documents issued for that place (jurisdiction), documents that mention it (mentions), or either (default).",
          "default": "either"
        },
        "date_from": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Date From",
          "description": "Earliest date: YYYY, YYYY-MM, or YYYY-MM-DD."
        },
        "date_to": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Date To",
          "description": "Latest date: YYYY, YYYY-MM, or YYYY-MM-DD."
        },
        "date_field": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "date_primary",
                "date_filed",
                "date_met",
                "date_adopted",
                "date_effective"
              ]
            },
            {
              "type": "null"
            }
          ],
          "title": "Date Field",
          "description": "Which date the range applies to; defaults to each type's own (filing date for opinions, meeting date for meetings)."
        },
        "session": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Session",
          "description": "Legislative session slug, e.g. 2025-2026 or 2026-special."
        },
        "status": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Status",
          "description": "Status classes: pending, passed_one_chamber, passed_both, enacted, vetoed, failed, in_force, repealed, decided, held."
        },
        "action": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Action",
          "description": "Stage of an action inside a meeting: reading, motion, vote, adopted, failed, public_comment, ..."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "title": "Filters",
      "description": "Hard filters. Every field is optional; values come from the vocabularies."
    },
    "LinkedTo": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "A document id; results are documents linked to it (and, with a locator, the linked stretch)."
        },
        "relations": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Relations",
          "description": "Relation types: discusses, amends, amendment_to, cites, implements, supersedes, same_case. Default: all."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "id"
      ],
      "title": "LinkedTo"
    },
    "SearchOverride": {
      "properties": {
        "filters": {
          "anyOf": [
            {
              "$ref": "#/$defs/Filters"
            },
            {
              "type": "null"
            }
          ]
        },
        "phrasings": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Phrasings"
        },
        "linked_to": {
          "anyOf": [
            {
              "$ref": "#/$defs/LinkedTo"
            },
            {
              "type": "null"
            }
          ]
        },
        "versions": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "current",
                "all"
              ]
            },
            {
              "type": "null"
            }
          ],
          "title": "Versions"
        },
        "mode": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "best",
                "all"
              ]
            },
            {
              "type": "null"
            }
          ],
          "title": "Mode"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "title": "SearchOverride",
      "description": "What the reader set by editing a chip or clicking a facet: it replaces\nthe planner's reading for this turn."
    }
  }
}