QnAMaker Runtime Client (stable:4.0)

2025/10/21 • 2 deleted methods

Runtime_GenerateAnswer (removed)
Description :  GenerateAnswer call to query the knowledgebase.
Reference :  Link ¶

⚼ Request

POST:  /knowledgebases/{kbId}/generateAnswer
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
generateAnswerPayload:
{
Description: Post body of the request. ,
Required: True ,
}
{
qnaId:
{
Description: Exact qnaId to fetch from the knowledgebase, this field takes priority over question. ,
Required: False ,
}
string ,
question:
{
Description: User question to query against the knowledge base. ,
Required: False ,
}
string ,
top:
{
Description: Max number of answers to be returned for the question. ,
Format: int32 ,
Required: False ,
}
integer ,
userId:
{
Description: Unique identifier for the user. Optional parameter for telemetry. For more information, refer Analytics and Telemetry. ,
Required: False ,
}
string ,
isTest:
{
Description: Query against the test index. ,
Required: False ,
}
boolean ,
scoreThreshold:
{
Description: Threshold for answers returned based on score. ,
Required: False ,
}
number ,
context:
{
Description: Context object with previous QnA's information. ,
Required: False ,
}
string ,
rankerType:
{
Description: Optional field. Set to 'QuestionOnly' for using a question only Ranker. ,
Required: False ,
}
string ,
strictFilters:
{
Description: Find only answers that contain these metadata. ,
Required: False ,
}
[
{
name:
{
Description: Metadata name. ,
Required: True ,
}
string ,
value:
{
Description: Metadata value. ,
Required: True ,
}
string ,
}
,
]
,
strictFiltersCompoundOperationType:
{
Description: Optional field. Set to OR for using OR as Operation for Strict Filters. ,
Enum:
{
AND: No description available. ,
OR: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
answers:
{
Description: Represents Search Result list. ,
Required: False ,
}
[
{
questions:
{
Description: List of questions. ,
Required: False ,
}
[
string ,
]
,
answer:
{
Description: Answer. ,
Required: False ,
}
string ,
score:
{
Description: Search result score. ,
Required: False ,
}
number ,
id:
{
Description: Id of the QnA result. ,
Format: int32 ,
Required: False ,
}
integer ,
source:
{
Description: Source of QnA result. ,
Required: False ,
}
string ,
metadata:
{
Description: List of metadata. ,
Required: False ,
}
[
{
name:
{
Description: Metadata name. ,
Required: True ,
}
string ,
value:
{
Description: Metadata value. ,
Required: True ,
}
string ,
}
,
]
,
context:
{
Description: Context object of the QnA ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Runtime_Train (removed)
Description :  Train call to add suggestions to the knowledgebase.
Reference :  Link ¶

⚼ Request

POST:  /knowledgebases/{kbId}/train
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
trainPayload:
{
Description: Post body of the request. ,
Required: True ,
}
{
feedbackRecords:
{
Description: List of feedback records. ,
Required: False ,
}
[
{
userId:
{
Description: Unique identifier for the user. ,
Required: False ,
}
string ,
userQuestion:
{
Description: The suggested question being provided as feedback. ,
Required: False ,
}
string ,
qnaId:
{
Description: The qnaId for which the suggested question is provided as feedback. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}