Generative

The service will retrieve a set of answers for a given scope. A scope is a collection of data sources 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/generative

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"generatedResponse": "Based on the information provided, the fees associated with your loan may include a monthly maintenance fee, late fees, and potentially insufficient funds fees. However, specific details about the fees, such as the amount and any other applicable fees, are not mentioned in the context. It would be best to refer to your loan agreement or contact your loan provider directly for accurate and detailed information about your fees.",
"score": 0.5416205028692881,
"answers": [{"question": "What are my fees?",
"retriever": {"articleId": 202200000002346,
"articleName": "Are there fees to keep in mind?",
"sectionCompositeSimScore": 0.8091969519294738,
"sectionContent": "<section>  <p>   With an Eight Bank Personal Loan, there are no application or origination fees. In addition, there are no prepayment penalties if you decide to pay your loan off early. We may charge a fee if your payment is late or if you do not have sufficient funds to cover a payment.  </p> </section> ",
"sectionContentText": "With an Eight Bank Personal Loan, there are no application or origination fees. In addition, there are no prepayment penalties if you decide to pay your loan off early. We may charge a fee if your payment is late or if you do not have sufficient funds to cover a payment.",
"sectionHeading": "Are there fees to keep in mind?"
},
"snippet": "<span class=\\\"highlight-color\\\" style=\\\"background-color: #FFFF00\\\"><b> With an Eight Bank Personal Loan, there are no application or origination fees.</b> In addition, there are no prepayment penalties if you decide to pay your loan off early. We may charge a fee if your payment is late or if you do not have sufficient funds to cover a payment.</span> In addition, there are no prepayment penalties if you decide to pay your loan off early. We may charge a fee ..."
}
],
"references": {"averageScore": 0.5416205028692881,
"citations": [{"generatedSentence": "Based on the information provided, the fees associated with your loan may include a monthly maintenance fee, late fees, and potentially insufficient funds fees.",
"generativeAiApproved": true,
"heading": "Are there fees to keep in mind?",
"referenceId": 202200000002346,
"referenceName": "Are there fees to keep in mind?",
"referenceSentence": "We may charge a fee if your payment is late or if you do not have sufficient funds to cover a payment.",
"score": 0.6404048204421997
},
{"generatedSentence": "However, specific details about the fees, such as the amount and any other applicable fees, are not mentioned in the context.",
"generativeAiApproved": true,
"heading": "Are there fees to keep in mind?",
"referenceId": 202200000002346,
"referenceName": "Are there fees to keep in mind?",
"referenceSentence": "We may charge a fee if your payment is late or if you do not have sufficient funds to cover a payment.",
"score": 0.4857357442378998
}
]
}
}