Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make queryDurationMillis field optional in VerticalResults #266

Merged
merged 5 commits into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/search-core.verticalresults.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export interface VerticalResults
| Property | Type | Description |
| --- | --- | --- |
| [appliedQueryFilters](./search-core.verticalresults.appliedqueryfilters.md) | [AppliedQueryFilter](./search-core.appliedqueryfilter.md)<!-- -->\[\] | A array of [AppliedQueryFilter](./search-core.appliedqueryfilter.md)<!-- -->s which were applied to the vertical results. |
| [queryDurationMillis](./search-core.verticalresults.querydurationmillis.md) | number | The duration of the query in milliseconds. |
| [queryDurationMillis?](./search-core.verticalresults.querydurationmillis.md) | number | <i>(Optional)</i> The duration of the query in milliseconds. |
| [results](./search-core.verticalresults.results.md) | [Result](./search-core.result.md)<!-- -->\[\] | An array of search [Result](./search-core.result.md)<!-- -->s for the vertical. |
| [resultsCount](./search-core.verticalresults.resultscount.md) | number | The total number of results within the vertical. |
| [source](./search-core.verticalresults.source.md) | [Source](./search-core.source.md) | Represents the source of a [Result](./search-core.result.md)<!-- -->. |
Expand Down
2 changes: 1 addition & 1 deletion docs/search-core.verticalresults.querydurationmillis.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ The duration of the query in milliseconds.
<b>Signature:</b>

```typescript
queryDurationMillis: number;
queryDurationMillis?: number;
```
2 changes: 1 addition & 1 deletion etc/search-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -858,7 +858,7 @@ export interface VerticalAutocompleteRequest extends SearchRequest {
// @public
export interface VerticalResults {
appliedQueryFilters: AppliedQueryFilter[];
queryDurationMillis: number;
queryDurationMillis?: number;
results: Result[];
resultsCount: number;
source: Source;
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@yext/search-core",
"version": "2.6.0-beta",
"version": "2.6.0-beta.2",
anguyen-yext2 marked this conversation as resolved.
Show resolved Hide resolved
"description": "Typescript Networking Library for the Yext Search API",
"main": "./dist/commonjs/src/index.js",
"module": "./dist/esm/src/index.js",
Expand Down
2 changes: 1 addition & 1 deletion src/models/searchservice/response/VerticalResults.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export interface VerticalResults {
/** A array of {@link AppliedQueryFilter}s which were applied to the vertical results. */
appliedQueryFilters: AppliedQueryFilter[],
/** The duration of the query in milliseconds. */
queryDurationMillis: number,
queryDurationMillis?: number,
anguyen-yext2 marked this conversation as resolved.
Show resolved Hide resolved
/** An array of search {@link Result}s for the vertical. */
results: Result[],
/**
Expand Down
44 changes: 23 additions & 21 deletions tests/infra/GenerativeDirectAnswerServiceImpl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ const defaultEndpoints: Required<Endpoints> = new EndpointsFactory().getEndpoint

const mockVerticalResults = [{
'appliedQueryFilters': [],
'queryDurationMillis': 141,
'results': [
{
'distance': 608,
Expand Down Expand Up @@ -142,28 +141,31 @@ it('additionalQueryParams are passed through', async () => {
}));
});

const mockUniversalResults = [mockVerticalResults, {
'appliedQueryFilters': [],
'queryDurationMillis': 313,
'results': [
{
'id': '4038721755206544552',
'index': 3,
'name': 'How do I create a Very Special Event?',
'rawData': {
const mockUniversalResults = [
{ ...mockVerticalResults, 'queryDurationMillis': 141 },
{
'appliedQueryFilters': [],
'queryDurationMillis': 313,
'results': [
{
'id': '4038721755206544552',
'index': 3,
'name': 'How do I create a Very Special Event?',
'question': 'How do I create a Very Special Event?',
'type': 'faq',
'uid': '8367352'
},
'source': 'CUSTOM_SEARCHER'
}
],
'resultsCount': 1,
'source': 'DOCUMENT_VERTICAL',
'verticalKey': 'faq_vector'
}];
'rawData': {
'id': '4038721755206544552',
'name': 'How do I create a Very Special Event?',
'question': 'How do I create a Very Special Event?',
'type': 'faq',
'uid': '8367352'
},
'source': 'CUSTOM_SEARCHER'
}
],
'resultsCount': 1,
'source': 'DOCUMENT_VERTICAL',
'verticalKey': 'faq_vector'
}
];

const gdaRequestUniversalResults: GenerativeDirectAnswerRequest = {
searchId: 'testSeachId',
Expand Down
Loading