Yelp · Schema

AiChatRequest

AiChatRequest schema from Yelp Fusion API

RestaurantLocal SearchReviewsBusiness DataLocation

Properties

Name	Type	Description
query	string	Natural language query.
chat_id	string	Conversation id to continue a multi-turn session.
user_context	object	Location context for geo-specific results.
request_context	object	Processing settings such as skip_text_generation.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/yelp/refs/heads/main/json-schema/yelp-ai-chat-request-schema.json",
  "title": "AiChatRequest",
  "description": "AiChatRequest schema from Yelp Fusion API",
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 1000,
      "description": "Natural language query.",
      "example": "find the best tacos in the Bay Area"
    },
    "chat_id": {
      "type": "string",
      "description": "Conversation id to continue a multi-turn session.",
      "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    },
    "user_context": {
      "type": "object",
      "description": "Location context for geo-specific results.",
      "properties": {
        "latitude": {
          "type": "number",
          "format": "double"
        },
        "longitude": {
          "type": "number",
          "format": "double"
        }
      }
    },
    "request_context": {
      "type": "object",
      "additionalProperties": true,
      "description": "Processing settings such as skip_text_generation."
    }
  },
  "required": [
    "query"
  ]
}