mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
51 lines
1.8 KiB
TypeScript
51 lines
1.8 KiB
TypeScript
/*!
|
|
* @license
|
|
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { GenericFacetResponse } from './genericFacetResponse';
|
|
import { ResponseConsistency } from './responseConsistency';
|
|
import { ResultBuckets } from './resultBuckets';
|
|
import { ResultSetContextFacetQueries } from './resultSetContextFacetQueries';
|
|
import { ResultSetContextSpellcheck } from './resultSetContextSpellcheck';
|
|
import { SearchRequest } from './searchRequest';
|
|
|
|
/**
|
|
* Context that applies to the whole result set
|
|
*/
|
|
export interface ResultSetContext {
|
|
consistency?: ResponseConsistency;
|
|
request?: SearchRequest;
|
|
/**
|
|
* The counts from facet queries
|
|
*/
|
|
facetQueries?: ResultSetContextFacetQueries[];
|
|
/**
|
|
* The counts from field facets
|
|
*/
|
|
facetsFields?: ResultBuckets[];
|
|
/**
|
|
* The faceted response
|
|
*/
|
|
facets?: GenericFacetResponse[];
|
|
/**
|
|
* Suggested corrections
|
|
* If zero results were found for the original query then a single entry of type \"searchInsteadFor\" will be returned.
|
|
* If alternatives were found that return more results than the original query they are returned as \"didYouMean\" options.
|
|
* The highest quality suggestion is first.
|
|
*/
|
|
spellcheck?: ResultSetContextSpellcheck[];
|
|
}
|