Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

QnAMakerOptions interface

Package:
botbuilder-ai

Additional settings used to configure a QnAMaker instance.

Properties

context

The context of the previous turn.
enablePreciseAnswer

A value indicating user's choice to receive PreciseAnswer or not.
filters
includeUnstructuredSources

includeUnstructuredSources - option to fetch answers from unsrtuctured sources
isTest

A value indicating whether to call test or prod environment of knowledgebase.
metadataBoost

(Optional) Metadata related to query.
qnaId

Id of the current question asked.
rankerType

Ranker types.
scoreThreshold

(Optional) The minimum score threshold, used to filter returned results. Values range from score of 0.0 to 1.0.
strictFilters

(Optional) Filters used on query.
strictFiltersJoinOperator

A value indicating choice for Strict Filters Join Operation.
timeout

(Optional) The time in milliseconds to wait before the request times out.
top

(Optional) number of results to return.

Property Details

context

The context of the previous turn.

context?: QnARequestContext

Property Value

enablePreciseAnswer

A value indicating user's choice to receive PreciseAnswer or not.

enablePreciseAnswer?: boolean

Property Value

boolean

filters 

filters?: Filters

Property Value

includeUnstructuredSources

includeUnstructuredSources - option to fetch answers from unsrtuctured sources

includeUnstructuredSources?: boolean

Property Value

boolean

isTest

A value indicating whether to call test or prod environment of knowledgebase.

isTest?: boolean

Property Value

boolean

metadataBoost

(Optional) Metadata related to query.

metadataBoost?: QnAMakerMetadata[]

Property Value

qnaId

Id of the current question asked.

qnaId?: number

Property Value

number

rankerType

Ranker types.

rankerType?: string

Property Value

string

scoreThreshold

(Optional) The minimum score threshold, used to filter returned results. Values range from score of 0.0 to 1.0.

scoreThreshold?: number

Property Value

number

strictFilters

(Optional) Filters used on query.

strictFilters?: QnAMakerMetadata[]

Property Value

strictFiltersJoinOperator

A value indicating choice for Strict Filters Join Operation.

strictFiltersJoinOperator?: JoinOperator

Property Value

timeout

(Optional) The time in milliseconds to wait before the request times out.

timeout?: number

Property Value

number

top

(Optional) number of results to return.

top?: number

Property Value

number