Extractive

The service will retrieve a set of answers for a given scope. A scope is a collection of datasources or an eGain KB Portal with a specific language and personalization profile id.

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

Semantic Suggestions Response.

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/instantanswers/extractive

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"answers": [{"question": "Banking app",
"retriever": {"articleId": 202200000004045,
"articleName": "Mobile Banking",
"sectionCompositeSimScore": 0.7612220654238891,
"sectionContent": "<section>  <p>   Enjoy mobile banking without an app. Go to  from your smartphone, sign in to our mobile website and do your banking on the go. Our convenient alternative to an app lets you bank easily and securely. Use the mobile website to pay bills, send money, transfer funds, view your transaction history and find an ATM or branch.  </p> </section> ",
"sectionContentText": "Enjoy mobile banking without an app. Go to  from your smartphone, sign in to our mobile website and do your banking on the go. Our convenient alternative to an app lets you bank easily and securely. Use the mobile website to pay bills, send money, transfer funds, view your transaction history and find an ATM or branch.",
"sectionHeading": "Mobile Banking"
},
"snippet": "Enjoy mobile banking without an app. <span class=\\\"highlight-color\\\" style=\\\"background-color: #FFFF00\\\"> Enjoy mobile banking without an app. <b>Go to  from your smartphone, sign in to our mobile website and do your banking on the go.</b> Our convenient alternative to an app lets you bank easily and securely. Use the mobile website to pay bills, send money, transfer funds, view your transaction history and find an ATM or branch.</span> Our convenient alternative to an app lets you bank easily and securely. Use the mobile website to pay bil..."
}
]
}