Merge 0976923 into e7f7462

yext · Mar 23, 2023 · e6ea876 · e6ea876
2 parents e7f7462 + 0976923
commit e6ea876
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 3 deletions.
diff --git a/docs/search-core.autocompleteresult.md b/docs/search-core.autocompleteresult.md
@@ -19,6 +19,7 @@ export interface AutocompleteResult
 |  [filter?](./search-core.autocompleteresult.filter.md) | [FieldValueFilter](./search-core.fieldvaluefilter.md) | <i>(Optional)</i> A filter applied to the autocomplete response. |
 |  [key?](./search-core.autocompleteresult.key.md) | string | <i>(Optional)</i> The fieldId which corresponds to the AutocompleteResult value. |
 |  [matchedSubstrings?](./search-core.autocompleteresult.matchedsubstrings.md) | { length: number; offset: number; }\[\] | <i>(Optional)</i> An array of substrings which overlap with the autocomplete input. |
+|  [queryIntents](./search-core.autocompleteresult.queryintents.md) | [SearchIntent](./search-core.searchintent.md)<!-- -->\[\] | [SearchIntent](./search-core.searchintent.md)<!-- -->s corresponding to the autocomplete result. |
 |  [relatedItem?](./search-core.autocompleteresult.relateditem.md) | [Result](./search-core.result.md) | <i>(Optional)</i> An entity that corresponds to the autocomplete result. |
 |  [value](./search-core.autocompleteresult.value.md) | string | The value of an autocomplete suggestion. |
 |  [verticalKeys?](./search-core.autocompleteresult.verticalkeys.md) | string\[\] | <i>(Optional)</i> Any vertical keys associated with a prompt. This only shows up on universal autocomplete requests. |

diff --git a/docs/search-core.autocompleteresult.queryintents.md b/docs/search-core.autocompleteresult.queryintents.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [AutocompleteResult](./search-core.autocompleteresult.md) &gt; [queryIntents](./search-core.autocompleteresult.queryintents.md)
+
+## AutocompleteResult.queryIntents property
+
+[SearchIntent](./search-core.searchintent.md)<!-- -->s corresponding to the autocomplete result.
+
+<b>Signature:</b>
+
+```typescript
+queryIntents: SearchIntent[];
+```
diff --git a/etc/search-core.api.md b/etc/search-core.api.md
@@ -75,6 +75,7 @@ export interface AutocompleteResult {
         length: number;
         offset: number;
     }[];
+    queryIntents: SearchIntent[];
     relatedItem?: Result;
     value: string;
     verticalKeys?: string[];

diff --git a/src/models/autocompleteservice/AutocompleteResponse.ts b/src/models/autocompleteservice/AutocompleteResponse.ts
@@ -93,5 +93,9 @@ export interface AutocompleteResult {
    * Any vertical keys associated with a prompt.
    * This only shows up on universal autocomplete requests.
    **/
-  verticalKeys?: string[]
+  verticalKeys?: string[],
+  /**
+   * {@link SearchIntent}s corresponding to the autocomplete result.
+   */
+  queryIntents: SearchIntent[]
 }
diff --git a/src/transformers/autocompleteservice/createAutocompleteResponse.ts b/src/transformers/autocompleteservice/createAutocompleteResponse.ts
@@ -12,7 +12,8 @@ export function createAutocompleteResponse(data: any): AutocompleteResponse {
 
   const response = data.response;
   const responseResults = response.results.map(createAutocompleteResult);
-  const inputIntents = response.input ? response.input.queryIntents : [];
+  const inputIntents = response.input?.queryIntents ?? [];
+
   return {
     results: responseResults,
     queryId: response.queryId,

diff --git a/src/transformers/autocompleteservice/createAutocompleteResult.ts b/src/transformers/autocompleteservice/createAutocompleteResult.ts
@@ -13,6 +13,7 @@ export function createAutocompleteResult(result: any): AutocompleteResult {
     matchedSubstrings: result.matchedSubstrings || [],
     value: result.value,
     relatedItem: relatedItem,
-    verticalKeys: result.verticalKeys
+    verticalKeys: result.verticalKeys,
+    queryIntents: result.queryIntents ?? []
   };
 }
diff --git a/tests/transformers/autocompleteservice/createAutocompleteResponse.ts b/tests/transformers/autocompleteservice/createAutocompleteResponse.ts
@@ -11,6 +11,9 @@ describe('AutocompleteResponse', () => {
       results: [
         {
           value: 'salesforce',
+          queryIntents: [
+            SearchIntent.NearMe
+          ],
           matchedSubstrings: [
             {
               offset: 0,
@@ -33,6 +36,7 @@ describe('AutocompleteResponse', () => {
           results: [
             {
               value: 'Virginia Beach',
+              queryIntents: [],
               matchedSubstrings: [
                 {
                   offset: 0,
@@ -77,6 +81,7 @@ describe('AutocompleteResponse', () => {
                 fieldId: 'name'
               },
               key: 'name',
+              queryIntents: [],
               relatedItem: {
                 rawData: {
                   mock: 'data'
@@ -110,6 +115,7 @@ describe('AutocompleteResponse', () => {
                 fieldId: 'name2'
               },
               key: 'name',
+              queryIntents: [],
               relatedItem: {
                 rawData: {
                   mock: 'data2'

diff --git a/tests/transformers/autocompleteservice/createAutocompleteResult.ts b/tests/transformers/autocompleteservice/createAutocompleteResult.ts
@@ -23,6 +23,7 @@ describe('AutocompleteResult', () => {
     const expectedResult = {
       key: 'key',
       value: 'salesforce',
+      queryIntents: [],
       matchedSubstrings: [
         {
           offset: 0,
@@ -69,6 +70,7 @@ describe('AutocompleteResult', () => {
         fieldId: 'name'
       },
       key: 'name',
+      queryIntents: [],
       relatedItem: {
         rawData: {
           mock: 'data'
@@ -106,6 +108,7 @@ describe('AutocompleteResult', () => {
         fieldId: 'name'
       },
       key: 'name',
+      queryIntents: [],
       matchedSubstrings: [
         {
           offset: 0,