SearchResponse

All wire models

Model aliases: SearchResponse.

Type: object.

Fields

Required means the key must be present. Nullable means its value may be null; it does not make a required key optional. “Not specified” means the schema declares no default.

Field	Type	Required	Default
knowledge_settings_snapshot	OrganizationKnowledgeSnapshot or null	No	null
hits	Array of SearchHit	Yes	Not specified
answer	string or null	No	null
citations	Array of Citation	No	Not specified

Model constraints

• Additional properties: permitted

Exact JSON Schema

This is a schema definition, not an example request. It preserves all declared keywords, including constraints not summarized above.

Complete JSON Schema

JSON

{
  "additionalProperties": true,
  "properties": {
    "knowledge_settings_snapshot": {
      "anyOf": [
        {
          "$ref": "#/$defs/OrganizationKnowledgeSnapshot"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "hits": {
      "items": {
        "$ref": "#/$defs/SearchHit"
      },
      "title": "Hits",
      "type": "array"
    },
    "answer": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Answer"
    },
    "citations": {
      "items": {
        "$ref": "#/$defs/Citation"
      },
      "title": "Citations",
      "type": "array"
    }
  },
  "required": [
    "hits"
  ],
  "title": "SearchResponse",
  "type": "object"
}