Suggestions

The service is designed for use as a type ahead service. It returns high quality semantic search results with dynamic snippets returned from an advanced extractive qa reader model.

SecurityoAuthUser or oAuthCustomer or oAuthAnonymousCustomer

Request

query Parameters

q required	string The users query.
portalId required	number The unique id an eGain Knowledge Base Portal.
personalizationProfileId	number The unique id of the eGain Knowledge personalization profile id.
languageCode	string Default: "en-US" The eGain Knowledge Base Language ID. Only English or en-US is supported at this time. Value: "en-US"
departmentId	number Department Id.
userId	number User Id.

Responses

200

Successful Semantic Suggestions Response

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/instantanswers/suggestions

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"suggestions": [{"answer": "click Open Account",
"answerScore": 0.10102194547653198,
"answerStart": 60,
"articleId": 202200000004095,
"articleTypeAttributes": {"typeName": "General"
},
"bm25Score": 1.2259192920760023,
"compositeScore": 0.38587135,
"heading": "",
"instantAnswer": false,
"question": "Can I open",
"similarityScore": 0.38587135,
"snippet": "<span class=\"highlight-color\" style=\"background-color: #FFFF00\"><b> To open a new checking account, first go to eightbank.com, click Open Account and select Checking Account.</b> Here you can review the various checking account types and make a selection. Follow the onscreen instructions to complete this process.</span> Here you can review the various checking account types and make a selection. Follow the onscreen...",
"suggestion": "How to Open Checking Account",
"suggestionType": "SEMANTIC_SUGGESTION"
}
]
}