Recommendation parameters - Revision history

Scott at 20:15, 3 July 2014

2014-07-03T20:15:20Z

Scott at 06:32, 21 February 2014

2014-02-21T06:32:58Z

Scott at 05:49, 21 February 2014

2014-02-21T05:49:55Z

Scott at 19:40, 10 January 2014

2014-01-10T19:40:34Z

Scott at 20:57, 6 January 2014

2014-01-06T20:57:58Z

Scott at 20:41, 6 January 2014

2014-01-06T20:41:21Z

Scott: Created page with "{| ! Type ! Name ! Default ! Description |- | list | tags | | |- | list | excludedTags | | |- | list | exclude | | |- | list | items | | |- | boolean | includeUnranked | fals..."

2014-01-03T21:59:54Z

Created page with "{| ! Type ! Name ! Default ! Description |- | list | tags | | |- | list | excludedTags | | |- | list | exclude | | |- | list | items | | |- | boolean | includeUnranked | fals..."

New page

{|
! Type
! Name
! Default
! Description
|-
| list
| tags
|
|
|-
| list
| excludedTags
|
|
|-
| list
| exclude
|
|
|-
| list
| items
|
|
|-
| boolean
| includeUnranked
| false
|
|-
| boolean
| showReferences
| false
|
|-
| list
| ignore
|
|
|-
| boolean
| excludeLinked
| false
|
|-
| boolean
| createMissingLinks
| false
|
|-
| int
| maxResults
| 20
|
|-
| boolean
| countOnly
| false
|
|-
| boolean
| includeProperties
| false
|
|-
| boolean
| includeTags
| false
|
|-
| list
| include
|
|
|-
| string
| tagOperation
| "OR"
|
|-
| enum
| updateMethod
| DatabaseItemXMLHandler.UpdateMethod.Replace
|
|-
| list
| itemsToRank
|
|
|-
| float
| popularity
| (float) -1.0
|
|}

@@ Line 69: / Line 69: @@
 | enum [ add, subtract, replace ]
 | updateMethod
-| Replace
+| replace
 | Specifies the behavior POSTed updates to items
 |-

@@ Line 67: / Line 67: @@
 | Specifies whether the list of tags specified in "tags" should be evaluated using a logical "or" or logical "and"
 |-
-| enum [ Add, Subtract, Replace ]
+| enum [ add, subtract, replace ]
 | updateMethod
 | Replace

@@ Line 65: / Line 65: @@
 | tagOperation
 | OR
-| Specifies whether the list of tags specified in "tags" or "excludedTags" should be evaluated using a logical "or" or logical "and"
+| Specifies whether the list of tags specified in "tags" should be evaluated using a logical "or" or logical "and"
 |-
 | enum [ Add, Subtract, Replace ]

← Older revision		Revision as of 20:57, 6 January 2014
Line 1:		Line 1:
		+	''List'' parameters are just a comma separated list of strings, defaulting to an empty list.
		+
	{\| class="wikitable"		{\| class="wikitable"
	! Type		! Type

@@ Line 6: / Line 6: @@
 ! Default
 ! Description
 |-
 | list

@@ Line 1: / Line 1: @@
-{|
+{| class="wikitable"
 ! Type
 ! Name
@@ Line 8: / Line 8: @@
 | 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
+| 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"
+| OR
+| Specifies whether the list of tags specified in "tags" or "excludedTags" should be evaluated using a logical "or" or logical "and"
 |-
-| enum
+| enum [ Add, Subtract, Replace ]
 | updateMethod
-| DatabaseItemXMLHandler.UpdateMethod.Replace
+| Replace
+| Specifies the behavior POSTed updates to items
 |-
 | list
 | itemsToRank
+|
+| Ranks a specific set of items using the "related" method
 |-
-| float
+| float (0 .. 1.0)
 | popularity
-| (float) -1.0
+| -1.0 (automatic)
+| Skews results towards more niche or popular items
 |}