Description |
|---|
Request and change recommended documents. |
URL: /GraphSearch/api/recommend
application/x-www-form-urlencoded
Supported Methods |
|---|
POST |
Parameter | Type | Required | Description |
|---|---|---|---|
pluginName | String | false | Plugin name |
Attribute | Type | Required | Comment |
|---|---|---|---|
count | int | false | Number of results |
documentFacets | Array of String | false | Fetch facets of a document. Set to all to fetch all facets. |
encoding | String | false | Request encoding |
id | String | true | Document Id or document text. |
locale | String | false | Search locale |
searchSpaceId | String | false | SearchSpace Identifier If not specified, the values for the default Search Space will be returned. |
start | int | false | Start of result (pagination) |
text | String | false | Text |
{
"searchSpaceId" : "some searchSpaceId",
"count" : 22149,
"start" : 7204,
"documentFacets" : [ "some documentFacets" ],
"id" : "some id",
"text" : "some text",
"encoding" : "some encoding",
"locale" : "some locale"
}application/json
Attribute | Type | Required | Comment |
|---|---|---|---|
MIMETYPE_PRODUCT_NAME | String | false | |
message | String | false | short descriptive message of the operation result, or an error description |
request | Object | false | Search request |
result | Object | false | the actual response content body, defined by the resultType. |
resultType | String | false | MIME type of the result if successful, or Exception type if an error occurred |
status | int | true | indicates the success or error of the HTTP request, on the protocol layer |
success | boolean | false | true if the operation was successful, on the application layer |
total | long | false | Result size |
{
"MIMETYPE_PRODUCT_NAME" : "some MIMETYPE_PRODUCT_NAME",
"result" : { },
"request" : { },
"total" : 19364,
"success" : false,
"message" : "some message",
"resultType" : "some resultType",
"status" : 17197
}