QueryDTO interface

Package:

@azure/cognitiveservices-qnamaker-runtime

POST body schema to query the knowledgebase.

Properties

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	Threshold for answers returned based on score.
strictFilters	Find only answers that contain these metadata.
top	Max number of answers to be returned for the question.
userId	Unique identifier for the user.

Property Details

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

Threshold for answers returned based on score.

scoreThreshold?: number

Property Value

number

strictFilters

Find only answers that contain these metadata.

strictFilters?: MetadataDTO[]

Property Value

MetadataDTO[]

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