update

yext · Mar 24, 2023 · 442e03e · 442e03e
1 parent 20dafe0
commit 442e03e
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 9 deletions.
diff --git a/docs/search-core.autocompleteresult.inputintents.md b/docs/search-core.autocompleteresult.inputintents.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; [inputIntents](./search-core.autocompleteresult.inputintents.md)
+
+## AutocompleteResult.inputIntents property
+
+[SearchIntent](./search-core.searchintent.md)<!-- -->s corresponding to the autocomplete result.
+
+<b>Signature:</b>
+
+```typescript
+inputIntents: SearchIntent[];
+```
diff --git a/docs/search-core.autocompleteresult.md b/docs/search-core.autocompleteresult.md
@@ -17,6 +17,7 @@ export interface AutocompleteResult
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [filter?](./search-core.autocompleteresult.filter.md) | [FieldValueFilter](./search-core.fieldvaluefilter.md) | <i>(Optional)</i> A filter applied to the autocomplete response. |
+|  [inputIntents](./search-core.autocompleteresult.inputintents.md) | [SearchIntent](./search-core.searchintent.md)<!-- -->\[\] | [SearchIntent](./search-core.searchintent.md)<!-- -->s corresponding to the autocomplete result. |
 |  [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. |

diff --git a/etc/search-core.api.md b/etc/search-core.api.md
@@ -70,6 +70,7 @@ export interface AutocompleteResponse {
 // @public
 export interface AutocompleteResult {
     filter?: FieldValueFilter;
+    inputIntents: SearchIntent[];
     key?: string;
     matchedSubstrings?: {
         length: number;

diff --git a/src/models/autocompleteservice/AutocompleteResponse.ts b/src/models/autocompleteservice/AutocompleteResponse.ts
@@ -97,5 +97,5 @@ export interface AutocompleteResult {
   /**
    * {@link SearchIntent}s corresponding to the autocomplete result.
    */
-  queryIntents: SearchIntent[]
+  inputIntents: SearchIntent[]
 }
diff --git a/src/transformers/autocompleteservice/createAutocompleteResult.ts b/src/transformers/autocompleteservice/createAutocompleteResult.ts
@@ -14,6 +14,6 @@ export function createAutocompleteResult(result: any): AutocompleteResult {
     value: result.value,
     relatedItem: relatedItem,
     verticalKeys: result.verticalKeys,
-    queryIntents: result.queryIntents ?? []
+    inputIntents: result.queryIntents ?? []
   };
 }
diff --git a/tests/transformers/autocompleteservice/createAutocompleteResponse.ts b/tests/transformers/autocompleteservice/createAutocompleteResponse.ts
@@ -11,7 +11,7 @@ describe('AutocompleteResponse', () => {
       results: [
         {
           value: 'salesforce',
-          queryIntents: [
+          inputIntents: [
             SearchIntent.NearMe
           ],
           matchedSubstrings: [
@@ -36,7 +36,7 @@ describe('AutocompleteResponse', () => {
           results: [
             {
               value: 'Virginia Beach',
-              queryIntents: [],
+              inputIntents: [],
               matchedSubstrings: [
                 {
                   offset: 0,
@@ -81,7 +81,7 @@ describe('AutocompleteResponse', () => {
                 fieldId: 'name'
               },
               key: 'name',
-              queryIntents: [],
+              inputIntents: [],
               relatedItem: {
                 rawData: {
                   mock: 'data'
@@ -115,7 +115,7 @@ describe('AutocompleteResponse', () => {
                 fieldId: 'name2'
               },
               key: 'name',
-              queryIntents: [],
+              inputIntents: [],
               relatedItem: {
                 rawData: {
                   mock: 'data2'

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