AnswersOptions interface

Package:

@azure/ai-language-conversations

Parameters to query a knowledge base.

Properties

answerContext	Context object with previous QnA's information.
confidenceThreshold	Minimum threshold score for answers, value ranges from 0 to 1.
filters	Filter QnAs based on given metadata list and knowledge base sources.
includeUnstructuredSources	(Optional) Flag to enable Query over Unstructured Sources.
qnaId	Exact QnA ID to fetch from the knowledge base, this field takes priority over question.
question	User question to query against the knowledge base.
rankerKind	Type of ranker to be used.
shortAnswerOptions	To configure Answer span prediction feature.
top	Max number of answers to be returned for the question.
userId	Unique identifier for the user.

Property Details

answerContext

Context object with previous QnA's information.

answerContext?: KnowledgeBaseAnswerContext

Property Value

KnowledgeBaseAnswerContext

confidenceThreshold

Minimum threshold score for answers, value ranges from 0 to 1.

confidenceThreshold?: number

Property Value

number

filters

Filter QnAs based on given metadata list and knowledge base sources.

filters?: QueryFilters

Property Value

QueryFilters

includeUnstructuredSources

(Optional) Flag to enable Query over Unstructured Sources.

includeUnstructuredSources?: boolean

Property Value

boolean

qnaId

Exact QnA ID to fetch from the knowledge base, this field takes priority over question.

qnaId?: number

Property Value

number

question

User question to query against the knowledge base.

question?: string

Property Value

string

rankerKind

Type of ranker to be used.

rankerKind?: string

Property Value

string

shortAnswerOptions

To configure Answer span prediction feature.

shortAnswerOptions?: ShortAnswerOptions

Property Value

ShortAnswerOptions

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