Difference between revisions of "Recommendation parameters"
From the Directed Edge Developer Base
(Created page with "{| ! Type ! Name ! Default ! Description |- | list | tags | | |- | list | excludedTags | | |- | list | exclude | | |- | list | items | | |- | boolean | includeUnranked | fals...") |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {| | + | ''List'' parameters are just a comma separated list of strings, defaulting to an empty list. |
| + | |||
| + | {| class="wikitable" | ||
! Type | ! Type | ||
! Name | ! Name | ||
! Default | ! Default | ||
! Description | ! Description | ||
| + | |- | ||
| + | | float | ||
| + | | ''type''Weight | ||
| + | | | ||
| + | | Specifies the relative weights of various link types. See [[REST API#typeWeight|the description in our REST docs]] | ||
|- | |- | ||
| list | | list | ||
| tags | | tags | ||
| | | | ||
| − | | | + | | Only include items which possess the specified tags |
|- | |- | ||
| list | | list | ||
| excludedTags | | excludedTags | ||
| | | | ||
| − | | | + | | Exclude items which possess the specified tags |
|- | |- | ||
| list | | list | ||
| exclude | | exclude | ||
| | | | ||
| − | | | + | | Exclude the items with the given IDs |
|- | |- | ||
| list | | list | ||
| items | | items | ||
| | | | ||
| − | | | + | | For a database-related request (i.e. basket request), specifies the list of items to find related items to; for a normal database GET request, specifies which items should be returned (useful for getting information about a number of items at once) |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| boolean | | boolean | ||
| showReferences | | showReferences | ||
| false | | false | ||
| − | | | + | | Show the "references" (back-links) for an item GET |
|- | |- | ||
| list | | list | ||
| ignore | | ignore | ||
| | | | ||
| − | | | + | | Do not include or factor into ranking the listed IDs |
|- | |- | ||
| boolean | | boolean | ||
| excludeLinked | | excludeLinked | ||
| − | | false | + | | false (recommended) / true (related) |
| − | | | + | | Don't include the items directly linked from the query item (i.e. products already purchased by a customer) |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| int | | int | ||
| maxResults | | maxResults | ||
| 20 | | 20 | ||
| − | | | + | | The maximum number of recommended entries to return |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| boolean | | boolean | ||
| includeProperties | | includeProperties | ||
| false | | false | ||
| − | | | + | | Include the properties for the item as XML attributes in a related or recommended query |
|- | |- | ||
| boolean | | boolean | ||
| includeTags | | includeTags | ||
| false | | false | ||
| − | | | + | | Include the tags for the item as an XML attribute (comma separated) in a related or recommended query |
|- | |- | ||
| list | | list | ||
| include | | include | ||
| | | | ||
| − | | | + | | Hand-pick the listed IDs for inclusion in a recommended or related query |
|- | |- | ||
| string | | string | ||
| tagOperation | | tagOperation | ||
| − | | | + | | OR |
| − | | | + | | Specifies whether the list of tags specified in "tags" should be evaluated using a logical "or" or logical "and" |
|- | |- | ||
| − | | enum | + | | enum [ add, subtract, replace ] |
| updateMethod | | updateMethod | ||
| − | | | + | | replace |
| − | | | + | | Specifies the behavior POSTed updates to items |
|- | |- | ||
| list | | list | ||
| itemsToRank | | itemsToRank | ||
| | | | ||
| − | | | + | | Ranks a specific set of items using the "related" method |
|- | |- | ||
| − | | float | + | | float (0 .. 1.0) |
| popularity | | popularity | ||
| − | | | + | | -1.0 (automatic) |
| − | | | + | | Skews results towards more niche or popular items |
|} | |} | ||
Latest revision as of 20:15, 3 July 2014
List parameters are just a comma separated list of strings, defaulting to an empty list.
| Type | Name | Default | Description |
|---|---|---|---|
| float | typeWeight | Specifies the relative weights of various link types. See the description in our REST docs | |
| list | tags | Only include items which possess the specified tags | |
| list | excludedTags | Exclude items which possess the specified tags | |
| list | exclude | Exclude the items with the given IDs | |
| list | items | For a database-related request (i.e. basket request), specifies the list of items to find related items to; for a normal database GET request, specifies which items should be returned (useful for getting information about a number of items at once) | |
| boolean | showReferences | false | Show the "references" (back-links) for an item GET |
| list | ignore | Do not include or factor into ranking the listed IDs | |
| boolean | excludeLinked | false (recommended) / true (related) | Don't include the items directly linked from the query item (i.e. products already purchased by a customer) |
| int | maxResults | 20 | The maximum number of recommended entries to return |
| boolean | includeProperties | false | Include the properties for the item as XML attributes in a related or recommended query |
| boolean | includeTags | false | Include the tags for the item as an XML attribute (comma separated) in a related or recommended query |
| list | include | Hand-pick the listed IDs for inclusion in a recommended or related query | |
| string | tagOperation | OR | Specifies whether the list of tags specified in "tags" should be evaluated using a logical "or" or logical "and" |
| enum [ add, subtract, replace ] | updateMethod | replace | Specifies the behavior POSTed updates to items |
| list | itemsToRank | Ranks a specific set of items using the "related" method | |
| float (0 .. 1.0) | popularity | -1.0 (automatic) | Skews results towards more niche or popular items |
