Skip to content

AskSearchResponseDto

Endpoints · All schemas

FieldRequiredDescription
explanationYesShort explanation of how the query was interpreted
planYesSee definition below
queryYesOriginal Ask Search query
resultsYesSee definition below
warningsYesUnsupported or ambiguous parts of the query

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: AskSearchPlanDto, SearchResponseDto

{
  "properties": {
    "explanation": {
      "description": "Short explanation of how the query was interpreted",
      "type": "string"
    },
    "plan": {
      "$ref": "#/components/schemas/AskSearchPlanDto"
    },
    "query": {
      "description": "Original Ask Search query",
      "type": "string"
    },
    "results": {
      "$ref": "#/components/schemas/SearchResponseDto"
    },
    "warnings": {
      "description": "Unsupported or ambiguous parts of the query",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "explanation",
    "plan",
    "query",
    "results",
    "warnings"
  ],
  "type": "object"
}