Search and Recommendation APIリファレンスとデータモデル

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Search and Recommendation APIを使用してリクエストを行う場合は、リクエスト本文でデータオブジェクトをPOSTする必要があります。 事前定義されたデータモデルに従う必要があります。

大事な

データオブジェクトがすべての使用可能なオブジェクトをポストするには、APIリファレンス を参照してください

次のコードブロックは、サンプルのAPI要求を表示し、いくつかの一般的なオブジェクトを一覧表示します。

{
  "context": {
    "ids": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "locale": {
      "country": "us",
      "language": "en"
    },
    "page": {
      "uri": "string"
    },
    "user": {
      "uuid": "string"
    }
  },
  "widget": {
    "items": [
      {
        "entity": "string",
        "rfk_flags": [
          "+semsearch"
        ],
        "rfk_id": "string",
        "search": {
          "content": {
            "fields": [
              "name",
              "price"
            ]
          },
          "facet": {
            "all": true,
            "max": 10,
            "sort": {
              "name": "text",
              "order": "asc"
            },
            "types": [
              {
                "after": "facetid_123",
                "exclude": [
                  "val1",
                  "val2"
                ],
                "filter": {
                  "type": "or",
                  "values": [
                    "facetid_123",
                    "facetid_123"
                  ]
                },
                "filtering_options": [
                  "hard_filters",
                  "other_facet_values"
                ],
                "keyphrase": "Sitecore",
                "max": 10,
                "min_count": 1,
                "name": "brands",
                "sort": {
                  "name": "text",
                  "order": "asc"
                }
              }
            ]
          },
          "filter": {
            "type": "string"
          },
          "group_by": "group_id",
          "limit": 10,
          "offset": 0,
          "personalization": {
            "algorithm": "hard_filters",
            "fields": [
              "brand",
              "color"
            ],
            "ids": [
              "id1",
              "id2"
            ]
          },
          "query": {
            "highlight": {
              "post_tag": "</em>",
              "pre_tag": "<em>"
            },
            "keyphrase": "Sitecore",
            "operator": "or",
            "relevance": [
              {
                "analyzer": "rfk_standard",
                "name": "color",
                "weight": 1
              }
            ]
          },
          "ranking": [
            {
              "name": "sales",
              "weight": 1
            }
          ],
          "related_questions": {
            "highlight": {
              "post_tag": "</em>",
              "pre_tag": "<em>"
            },
            "max": 10
          },
          "rule": {
            "behaviors": true,
            "blacklist": {
              "filter": {
                "type": "string"
              }
            },
            "boost": [
              {
                "filter": {
                  "type": "string"
                },
                "slots": [
                  1,
                  5
                ]
              }
            ],
            "bury": {
              "filter": {
                "type": "string"
              }
            },
            "include": [
              {
                "filter": {
                  "type": "string"
                },
                "slots": [
                  1,
                  5
                ]
              }
            ],
            "pin": [
              {
                "id": "id1",
                "slot": 1
              }
            ]
          },
          "sort": {
            "choices": true,
            "value": [
              {
                "name": "color",
                "order": "desc"
              }
            ]
          },
          "suggestion": [
            {
              "max": 2,
              "name": "my_suggester"
            }
          ],
          "swatch": {
            "fields": [
              "name",
              "price"
            ],
            "group_by": "group_id",
            "max": 10
          }
        },
        "sources": [
          "sourceID1",
          "sourceID2"
        ]
      }
    ]
  }
}
この記事を改善するための提案がある場合は、 お知らせください!