Interface RelevanceInspectorState

A scoped and simplified part of the headless state that is relevant to the RelevanceInspector controller.

interface RelevanceInspectorState {
    executionReport?: ExecutionReport;
    expressions?: QueryExpressions;
    fetchAllFields?: boolean;
    fieldsDescription?: FieldDescription[];
    isEnabled: boolean;
    rankingExpressions?: QueryRankingExpression[];
    rankingInformation?: ResultRankingInformation[];
    userIdentities?: SecurityIdentity[];
}

Properties

executionReport? expressions? fetchAllFields? fieldsDescription? isEnabled rankingExpressions? rankingInformation? userIdentities?

Properties

OptionalexecutionReport

executionReport?: ExecutionReport

The query execution report.

Optionalexpressions

expressions?: QueryExpressions

The query expressions sent in the request.

OptionalfetchAllFields

fetchAllFields?: boolean

Whether fields debugging is enabled, returning all fields available on query results.

OptionalfieldsDescription

fieldsDescription?: FieldDescription[]

The description of all fields available in the index.

isEnabled

isEnabled: boolean

Whether debug mode is enabled.

OptionalrankingExpressions

rankingExpressions?: QueryRankingExpression[]

The ranking expressions.

OptionalrankingInformation

rankingInformation?: ResultRankingInformation[]

The ranking information for every result.

OptionaluserIdentities

userIdentities?: SecurityIdentity[]

The security identities.

Settings

Member Visibility

On This Page

Properties