QueryDTO interface

Package:

@azure/cognitiveservices-qnamaker

POST body schema to query the knowledgebase.

Properties

answerSpanRequest	To configure Answer span prediction feature.
context	Context object with previous QnA's information.
isTest	Query against the test index.
qnaId	Exact qnaId to fetch from the knowledgebase, this field takes priority over question.
question	User question to query against the knowledge base.
rankerType	Optional field. Set to 'QuestionOnly' for using a question only Ranker.
scoreThreshold	Minimum threshold score for answers.
strictFilters	Find QnAs that are associated with the given list of metadata.
strictFiltersCompoundOperationType	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.
userId	Unique identifier for the user.

Property Details

answerSpanRequest

To configure Answer span prediction feature.

answerSpanRequest?: QueryDTOAnswerSpanRequest

Property Value

QueryDTOAnswerSpanRequest

context

Context object with previous QnA's information.

context?: QueryDTOContext

Property Value

QueryDTOContext

isTest

Query against the test index.

isTest?: boolean

Property Value

boolean

qnaId

Exact qnaId to fetch from the knowledgebase, this field takes priority over question.

qnaId?: string

Property Value

string

question

User question to query against the knowledge base.

question?: string

Property Value

string

rankerType

Optional field. Set to 'QuestionOnly' for using a question only Ranker.

rankerType?: string

Property Value

string

scoreThreshold

Minimum threshold score for answers.

scoreThreshold?: number

Property Value

number

strictFilters

Find QnAs that are associated with the given list of metadata.

strictFilters?: MetadataDTO[]

Property Value

MetadataDTO[]

strictFiltersCompoundOperationType

Optional field. Set to 'OR' for using OR operation for strict filters. Possible values include: 'AND', 'OR'

strictFiltersCompoundOperationType?: StrictFiltersCompoundOperationType

Property Value

StrictFiltersCompoundOperationType

top

Max number of answers to be returned for the question.

top?: number

Property Value

number

userId

Unique identifier for the user.

userId?: string

Property Value

string