AskSearchResponseDto
| Field | Required | Description |
|---|---|---|
explanation | Yes | Short explanation of how the query was interpreted |
plan | Yes | See definition below |
query | Yes | Original Ask Search query |
results | Yes | See definition below |
warnings | Yes | Unsupported 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"
}© 2026 Frameleaf Inc. All rights reserved.
Frameleaf and the Frameleaf logo are Trademarks of Frameleaf Inc.