• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

yext / search-core / 9687864195

26 Jun 2024 10:56PM UTC coverage: 89.352%. Remained the same
9687864195

push

github

web-flow
Revert "Add generativeDirectAnswer service (#263)" (#265)

This reverts commit e2fe1fd3b.

167 of 193 branches covered (86.53%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

7 existing lines in 2 files now uncovered.

219 of 239 relevant lines covered (91.63%)

8.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0
/src/SearchCore.ts
1
import { SearchService } from './services/SearchService';
2
import { UniversalSearchRequest } from './models/searchservice/request/UniversalSearchRequest';
3
import { UniversalSearchResponse } from './models/searchservice/response/UniversalSearchResponse';
4
import { VerticalSearchRequest } from './models/searchservice/request/VerticalSearchRequest';
5
import { VerticalSearchResponse } from './models/searchservice/response/VerticalSearchResponse';
6

7
import { QuestionSubmissionService } from './services/QuestionSubmissionService';
8
import { QuestionSubmissionRequest } from './models/questionsubmission/QuestionSubmissionRequest';
9
import { QuestionSubmissionResponse } from './models/questionsubmission/QuestionSubmissionResponse';
10
import { UniversalAutocompleteRequest, VerticalAutocompleteRequest, FilterSearchRequest }
11
  from './models/autocompleteservice/AutocompleteRequest';
12
import { AutocompleteResponse, FilterSearchResponse } from './models/autocompleteservice/AutocompleteResponse';
13
import { AutocompleteService } from './services/AutocompleteService';
14

15
/**
16
 * Provides methods for executing searches, submitting questions, and performing autocompletes.
17
 *
18
 * @public
19
 */
20
export class SearchCore {
21
  constructor(
22
    private searchService: SearchService,
23
    private questionSubmissionService: QuestionSubmissionService,
24
    private autoCompleteService: AutocompleteService
25
  ) {}
26

27
  /**
28
   * Performs a search across all verticals.
29
   *
30
   * @remarks
31
   * If rejected, the reason will be an {@link SearchError}.
32
   *
33
   * @param request - Universal search request options
34
   */
35
  universalSearch(request: UniversalSearchRequest): Promise<UniversalSearchResponse> {
UNCOV
36
    return this.searchService.universalSearch(request);
×
37
  }
38

39
  /**
40
   * Performs a search for a single vertical.
41
   *
42
   * @remarks
43
   * If rejected, the reason will be an {@link SearchError}.
44
   *
45
   * @param request - Vertical search request options
46
   */
47
  verticalSearch(request: VerticalSearchRequest): Promise<VerticalSearchResponse> {
UNCOV
48
    return this.searchService.verticalSearch(request);
×
49
  }
50

51
  /**
52
   * Submits a custom question to the Search API.
53
   *
54
   * @remarks
55
   * If rejected, the reason will be an {@link SearchError}.
56
   *
57
   * @param request - Question submission request options
58
   */
59
  submitQuestion(request: QuestionSubmissionRequest): Promise<QuestionSubmissionResponse> {
UNCOV
60
    return this.questionSubmissionService.submitQuestion(request);
×
61
  }
62

63
  /**
64
   * Performs an autocomplete request across all verticals.
65
   *
66
   * @remarks
67
   * If rejected, the reason will be an {@link SearchError}.
68
   *
69
   * @param request - Universal autocomplete request options
70
   */
71
  universalAutocomplete(request: UniversalAutocompleteRequest): Promise<AutocompleteResponse> {
UNCOV
72
    return this.autoCompleteService.universalAutocomplete(request);
×
73
  }
74

75
  /**
76
   * Performs an autocomplete request for a single vertical.
77
   *
78
   * @remarks
79
   * If rejected, the reason will be an {@link SearchError}.
80
   *
81
   * @param request - Vertical autocomplete request options
82
   */
83
  verticalAutocomplete(request: VerticalAutocompleteRequest): Promise<AutocompleteResponse> {
UNCOV
84
    return this.autoCompleteService.verticalAutocomplete(request);
×
85
  }
86

87
  /**
88
   * Performs a filtersearch request against specified fields within a single vertical.
89
   *
90
   * @remarks
91
   * This differs from the vertical autocomplete because the vertical autocomplete
92
   * operates on all entity fields whereas filtersearch operates only on specified fields.
93
   * If rejected, the reason will be an {@link SearchError}.
94
   *
95
   * @example
96
   * A site has a 'products' vertical and would like a way to allow the user to narrow down
97
   * the results by the product name. The site can add a second search bar powered by filtersearch
98
   * which will include only product names as search suggestions.
99
   *
100
   * @param request - filtersearch request options
101
   */
102
  filterSearch(request: FilterSearchRequest): Promise<FilterSearchResponse> {
UNCOV
103
    return this.autoCompleteService.filterSearch(request);
×
104
  }
105
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc