QueryDTO interface
POST body schema to query the knowledgebase.
Properties
| answer |
To configure Answer span prediction feature. |
| context | Context object with previous QnA's information. |
| is |
Query against the test index. |
| qna |
Exact qnaId to fetch from the knowledgebase, this field takes priority over question. |
| question | User question to query against the knowledge base. |
| ranker |
Optional field. Set to 'QuestionOnly' for using a question only Ranker. |
| score |
Minimum threshold score for answers. |
| strict |
Find QnAs that are associated with the given list of metadata. |
| strict |
Optional field. Set to 'OR' for using OR operation for strict filters. Possible values include: 'AND', 'OR' |
| top | Max number of answers to be returned for the question. |
| user |
Unique identifier for the user. |
Property Details
answerSpanRequest
To configure Answer span prediction feature.
answerSpanRequest?: QueryDTOAnswerSpanRequestProperty Value
context
Context object with previous QnA's information.
context?: QueryDTOContextProperty Value
isTest
Query against the test index.
isTest?: booleanProperty Value
boolean
qnaId
Exact qnaId to fetch from the knowledgebase, this field takes priority over question.
qnaId?: stringProperty Value
string
question
User question to query against the knowledge base.
question?: stringProperty Value
string
rankerType
Optional field. Set to 'QuestionOnly' for using a question only Ranker.
rankerType?: stringProperty Value
string
scoreThreshold
Minimum threshold score for answers.
scoreThreshold?: numberProperty Value
number
strictFilters
Find QnAs that are associated with the given list of metadata.
strictFilters?: MetadataDTO[]Property Value
strictFiltersCompoundOperationType
Optional field. Set to 'OR' for using OR operation for strict filters. Possible values include: 'AND', 'OR'
strictFiltersCompoundOperationType?: StrictFiltersCompoundOperationTypeProperty Value
top
Max number of answers to be returned for the question.
top?: numberProperty Value
number
userId
Unique identifier for the user.
userId?: stringProperty Value
string