predictive_search オブジェクト

{
  "access": {
    "global": false,
    "parents": [],
    "template": []
  },
  "deprecated": false,
  "deprecation_reason": "",
  "description": "> Note:\n> The `predictive_search` object returns results only when rendered in a section using the Predictive Search API and the\n[Section Rendering API](/api/section-rendering). To learn about how to include predictive search in your theme,\n> refer to [Add predictive search to your theme](/themes/navigation-search/search/predictive-search).",
  "properties": [
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "boolean",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "Returns `true` when being referenced inside a section that's been rendered using the Predictive Search API and\nthe Section Rendering API. Returns `false` if not.",
      "name": "performed"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "You can check whether any resources of a specific type were returned using the [`size` filter](/docs/api/liquid/filters/size).\n\n```liquid\n{% if predictive_search.resources.articles.size > 0 %}\n  {% for article in predictive_search.resources.articles %}\n    {{ article.title }}\n  {% endfor %}\n{% endif %}\n```",
      "examples": [],
      "return_type": [
        {
          "type": "predictive_search_resources",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The resources associated with the query.",
      "name": "resources"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Tip:\n> Use the [`highlight` filter](/docs/api/liquid/filters/highlight) to highlight the search terms in search results content.",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The entered search terms.",
      "name": "terms"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "Searches can be performed on the following object types:\n\n- [`article`](/docs/api/liquid/objects/article)\n- [`collection`](/docs/api/liquid/objects/collection)\n- [`page`](/docs/api/liquid/objects/page)\n- [`product`](/docs/api/liquid/objects/product)\n\n> Note:\n> The types are determined by the [`type` query parameter](/api/ajax/reference/predictive-search#query-parameters).",
      "examples": [],
      "return_type": [
        {
          "type": "array",
          "name": "",
          "description": "",
          "array_value": "string"
        }
      ],
      "summary": "The object types that the search was performed on.",
      "name": "types"
    }
  ],
  "summary": "Information about the results from a predictive search query through the\n[Predictive Search API](/api/ajax/reference/predictive-search#get-locale-search-suggest).",
  "name": "predictive_search",
  "examples": [],
  "json_data": {
    "path": "",
    "handle": "",
    "data_from_file": "{\"performed\":true,\"resources\":{},\"terms\":\"potion\",\"types\":[]}"
  },
  "return_type": []
}