Merge pull request #183 from yext/dev/merge-v2.5.2-89a879b-into-develop

Merge main (v2.5.2) into develop
yext · Sep 19, 2024 · 031f9ed · 031f9ed
2 parents 0fa60c1 + 89572bc
commit 031f9ed
Show file tree

Hide file tree

Showing 11 changed files with 10,248 additions and 445 deletions.
diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES
diff --git a/docs/search-headless.cloudchoice.md b/docs/search-headless.cloudchoice.md
@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [CloudChoice](./search-headless.cloudchoice.md)
+
+## CloudChoice enum
+
+Defines the cloud choice of the API domains.
+
+<b>Signature:</b>
+
+```typescript
+export declare enum CloudChoice 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  GLOBAL\_GCP | <code>&quot;GLOBAL-GCP&quot;</code> |  |
+|  GLOBAL\_MULTI | <code>&quot;GLOBAL-MULTI&quot;</code> |  |
+
diff --git a/docs/search-headless.md b/docs/search-headless.md
@@ -53,7 +53,26 @@ Provides the functionality for interacting with a Search experience.
 </tbody></table>
 
 ## Enumerations
-
+|  Enumeration | Description |
+|  --- | --- |
+|  [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) applied to a search. |
+|  [BuiltInFieldType](./search-headless.builtinfieldtype.md) | Possible built-in field types for [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md)<!-- -->. |
+|  [CloudChoice](./search-headless.cloudchoice.md) | Defines the cloud choice of the API domains. |
+|  [CloudRegion](./search-headless.cloudregion.md) | Defines the cloud region of the API domains. |
+|  [DirectAnswerType](./search-headless.directanswertype.md) | Represents the type of direct answer. |
+|  [Direction](./search-headless.direction.md) | The direction of a sort. |
+|  [Environment](./search-headless.environment.md) | Defines the environment of the API domains. |
+|  [ErrorType](./search-headless.errortype.md) | Identifier for the type of error causing the failure. |
+|  [FilterCombinator](./search-headless.filtercombinator.md) | Indicates how child filters in a [StaticFilter](./search-headless.staticfilter.md) should be combined. |
+|  [LocationBiasMethod](./search-headless.locationbiasmethod.md) | The method used to determine the location. |
+|  [Matcher](./search-headless.matcher.md) | A Matcher is a filtering operation. |
+|  [QuerySource](./search-headless.querysource.md) | The source of the search request. |
+|  [QueryTrigger](./search-headless.querytrigger.md) | Describes the ways a search can be executed besides user input. |
+|  [SearchIntent](./search-headless.searchintent.md) | Represents intents from the Search API. |
+|  [SearchTypeEnum](./search-headless.searchtypeenum.md) | An enum which indicates the type of search that Headless is managing. |
+|  [SortType](./search-headless.sorttype.md) | The method of sorting. |
+|  [Source](./search-headless.source.md) | Represents the source of a [Result](./search-headless.result.md)<!-- -->. |
+|  [SpellCheckType](./search-headless.spellchecktype.md) | Represents the type of spell check performed. |
 <table><thead><tr><th>
 
 Enumeration

diff --git a/docs/search-headless.segment.md b/docs/search-headless.segment.md
@@ -13,8 +13,11 @@ export declare interface Segment
 ```
 
 ## Properties
-
-<table><thead><tr><th>
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [pageNumber?](./search-headless.segment.pagenumber.md) | number | <i>(Optional)</i> The page number of the document that the segment came from. Populated only for pdf files. |
+|  [score](./search-headless.segment.score.md) | number | The similarity score of the segment from 0 to 1 |
+|  [text](./search-headless.segment.text.md) | string | The value of the segment as plain text. |
 
 Property
 

diff --git a/docs/search-headless.segment.pagenumber.md b/docs/search-headless.segment.pagenumber.md
@@ -6,7 +6,7 @@
 
 The page number of the document that the segment came from. Populated only for pdf files.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 pageNumber?: number;

diff --git a/docs/search-headless.servingconfig.cloudchoice.md b/docs/search-headless.servingconfig.cloudchoice.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [ServingConfig](./search-headless.servingconfig.md) &gt; [cloudChoice](./search-headless.servingconfig.cloudchoice.md)
+
+## ServingConfig.cloudChoice property
+
+Defines the cloud choice of the API domains.
+
+<b>Signature:</b>
+
+```typescript
+cloudChoice?: CloudChoice;
+```
diff --git a/docs/search-headless.servingconfig.md b/docs/search-headless.servingconfig.md
@@ -13,8 +13,11 @@ export declare interface ServingConfig
 ```
 
 ## Properties
-
-<table><thead><tr><th>
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [cloudChoice?](./search-headless.servingconfig.cloudchoice.md) | [CloudChoice](./search-headless.cloudchoice.md) | <i>(Optional)</i> Defines the cloud choice of the API domains. |
+|  [cloudRegion?](./search-headless.servingconfig.cloudregion.md) | [CloudRegion](./search-headless.cloudregion.md) | <i>(Optional)</i> Defines the cloud region of the API domains. |
+|  [environment?](./search-headless.servingconfig.environment.md) | [Environment](./search-headless.environment.md) | <i>(Optional)</i> Defines the environment of the API domains. |
 
 Property
 

diff --git a/docs/search-headless.source.md b/docs/search-headless.source.md
@@ -13,8 +13,12 @@ export declare enum Source
 ```
 
 ## Enumeration Members
-
-<table><thead><tr><th>
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  Custom | <code>&quot;CUSTOM_SEARCHER&quot;</code> | The result was from a custom source. |
+|  DocumentVertical | <code>&quot;DOCUMENT_VERTICAL&quot;</code> | The result is from a document vertical. |
+|  Google | <code>&quot;GOOGLE_CSE&quot;</code> | The result is from Google Custom Search Engine. |
+|  KnowledgeManager | <code>&quot;KNOWLEDGE_MANAGER&quot;</code> | The result is from a Knowledge Graph. |
 
 Member
 

diff --git a/etc/search-headless.api.md b/etc/search-headless.api.md
@@ -181,6 +181,14 @@ export interface ClientSDKHeaderValues {
     ANSWERS_CORE?: never;
 }
 
+// @public
+export enum CloudChoice {
+    // (undocumented)
+    GLOBAL_GCP = "GLOBAL-GCP",
+    // (undocumented)
+    GLOBAL_MULTI = "GLOBAL-MULTI"
+}
+
 // @public
 export enum CloudRegion {
     // (undocumented)
@@ -898,6 +906,7 @@ export interface SelectableStaticFilter {
 
 // @public
 export interface ServingConfig {
+    cloudChoice?: CloudChoice;
     cloudRegion?: CloudRegion;
     environment?: Environment;
 }
@@ -933,14 +942,11 @@ export enum SortType {
 
 // @public
 export enum Source {
-    Algolia = "ALGOLIA",
-    Bing = "BING_CSE",
     Custom = "CUSTOM_SEARCHER",
     DocumentVertical = "DOCUMENT_VERTICAL",
     FunctionVertical = "FUNCTION_VERTICAL",
     Google = "GOOGLE_CSE",
-    KnowledgeManager = "KNOWLEDGE_MANAGER",
-    Zendesk = "ZENDESK"
+    KnowledgeManager = "KNOWLEDGE_MANAGER"
 }
 
 // @public