@coveo/headless-react
    Preparing search index...

    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[];
    }
    Index

    Properties

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

    Properties

    executionReport?: ExecutionReport

    The query execution report.

    expressions?: QueryExpressions

    The query expressions sent in the request.

    fetchAllFields?: boolean

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

    fieldsDescription?: FieldDescription[]

    The description of all fields available in the index.

    isEnabled: boolean

    Whether debug mode is enabled.

    rankingExpressions?: QueryRankingExpression[]

    The ranking expressions.

    rankingInformation?: ResultRankingInformation[]

    The ranking information for every result.

    userIdentities?: SecurityIdentity[]

    The security identities.

    Settings

    Member Visibility
    In this article
    Properties