Merge branch 'develop' into dev/merge-v2.5.5-830b50e-into-develop

docs/search-core.endpoints.generativedirectanswer.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Endpoints](./search-core.endpoints.md) &gt; [generativeDirectAnswer](./search-core.endpoints.generativedirectanswer.md)
+
+## Endpoints.generativeDirectAnswer property
+
+<b>Signature:</b>
+
+```typescript
+generativeDirectAnswer?: string;
+```

docs/search-core.endpoints.md

@@ -14,8 +14,6 @@ export interface Endpoints
 
 ## Properties
 
-<table><thead><tr><th>
-
 Property
 
 

docs/search-core.generativedirectanswerrequest.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md)
+
+## GenerativeDirectAnswerRequest interface
+
+Options which can be specified for a generative direct answer request.
+
+<b>Signature:</b>
+
+```typescript
+export interface GenerativeDirectAnswerRequest extends SearchRequest 
+```
+<b>Extends:</b> [SearchRequest](./search-core.searchrequest.md)
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [results](./search-core.generativedirectanswerrequest.results.md) | [VerticalResults](./search-core.verticalresults.md)<!-- -->\[\] | The complete set of Search Results |
+|  [searchId](./search-core.generativedirectanswerrequest.searchid.md) | string | The ID of the search request. |
+|  [searchTerm](./search-core.generativedirectanswerrequest.searchterm.md) | string | The text of the user-written query that prompted Search results. |
+

docs/search-core.generativedirectanswerrequest.results.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; [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) &gt; [results](./search-core.generativedirectanswerrequest.results.md)
+
+## GenerativeDirectAnswerRequest.results property
+
+The complete set of Search Results
+
+<b>Signature:</b>
+
+```typescript
+results: VerticalResults[];
+```

docs/search-core.generativedirectanswerrequest.searchid.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; [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) &gt; [searchId](./search-core.generativedirectanswerrequest.searchid.md)
+
+## GenerativeDirectAnswerRequest.searchId property
+
+The ID of the search request.
+
+<b>Signature:</b>
+
+```typescript
+searchId: string;
+```

docs/search-core.generativedirectanswerrequest.searchterm.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; [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) &gt; [searchTerm](./search-core.generativedirectanswerrequest.searchterm.md)
+
+## GenerativeDirectAnswerRequest.searchTerm property
+
+The text of the user-written query that prompted Search results.
+
+<b>Signature:</b>
+
+```typescript
+searchTerm: string;
+```

docs/search-core.generativedirectanswerresponse.citations.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; [GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md) &gt; [citations](./search-core.generativedirectanswerresponse.citations.md)
+
+## GenerativeDirectAnswerResponse.citations property
+
+An array of uids from the relevant [Result.rawData](./search-core.result.rawdata.md) that were used to form the directAnswer.
+
+<b>Signature:</b>
+
+```typescript
+citations: string[];
+```

docs/search-core.generativedirectanswerresponse.directanswer.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; [GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md) &gt; [directAnswer](./search-core.generativedirectanswerresponse.directanswer.md)
+
+## GenerativeDirectAnswerResponse.directAnswer property
+
+The text of the final generated response.
+
+<b>Signature:</b>
+
+```typescript
+directAnswer: string;
+```

docs/search-core.generativedirectanswerresponse.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md)
+
+## GenerativeDirectAnswerResponse interface
+
+A representation of a generative direct answer response.
+
+<b>Signature:</b>
+
+```typescript
+export interface GenerativeDirectAnswerResponse 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [citations](./search-core.generativedirectanswerresponse.citations.md) | string\[\] | An array of uids from the relevant [Result.rawData](./search-core.result.rawdata.md) that were used to form the directAnswer. |
+|  [directAnswer](./search-core.generativedirectanswerresponse.directanswer.md) | string | The text of the final generated response. |
+|  [resultStatus](./search-core.generativedirectanswerresponse.resultstatus.md) | string | A string representing whether there was a result found within the given invocation. |
+

docs/search-core.generativedirectanswerresponse.resultstatus.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; [GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md) &gt; [resultStatus](./search-core.generativedirectanswerresponse.resultstatus.md)
+
+## GenerativeDirectAnswerResponse.resultStatus property
+
+A string representing whether there was a result found within the given invocation.
+
+<b>Signature:</b>
+
+```typescript
+resultStatus: string;
+```

docs/search-core.generativedirectanswerservice.generateanswer.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerService](./search-core.generativedirectanswerservice.md) &gt; [generateAnswer](./search-core.generativedirectanswerservice.generateanswer.md)
+
+## GenerativeDirectAnswerService.generateAnswer() method
+
+Generates an answer to a search query.
+
+<b>Signature:</b>
+
+```typescript
+generateAnswer(request: GenerativeDirectAnswerRequest): Promise<GenerativeDirectAnswerResponse>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) |  |
+
+<b>Returns:</b>
+
+Promise&lt;[GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md)<!-- -->&gt;
+

docs/search-core.generativedirectanswerservice.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerService](./search-core.generativedirectanswerservice.md)
+
+## GenerativeDirectAnswerService interface
+
+A service for generative direct answer requests.
+
+<b>Signature:</b>
+
+```typescript
+export interface GenerativeDirectAnswerService 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [generateAnswer(request)](./search-core.generativedirectanswerservice.generateanswer.md) | Generates an answer to a search query. |
+

docs/search-core.md

@@ -271,8 +271,6 @@ The entrypoint to the search-core library.
 
 ## Interfaces
 
-<table><thead><tr><th>
-
 Interface
 
 

docs/search-core.searchcore._constructor_.md

@@ -9,12 +9,11 @@ Constructs a new instance of the `SearchCore` class
 **Signature:**
 
 ```typescript
-constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService);
+constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService, generativeDirectAnswerService: GenerativeDirectAnswerService);
 ```
 
 ## Parameters
 
-<table><thead><tr><th>
 
 Parameter
 

docs/search-core.searchcore.generativedirectanswer.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [SearchCore](./search-core.searchcore.md) &gt; [generativeDirectAnswer](./search-core.searchcore.generativedirectanswer.md)
+
+## SearchCore.generativeDirectAnswer() method
+
+Performs a generative direct answer request.
+
+<b>Signature:</b>
+
+```typescript
+generativeDirectAnswer(request: GenerativeDirectAnswerRequest): Promise<GenerativeDirectAnswerResponse>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) | Generative direct answer request options |
+
+<b>Returns:</b>
+
+Promise&lt;[GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md)<!-- -->&gt;
+
+## Remarks
+
+If rejected, the reason will be an [SearchError](./search-core.searcherror.md)<!-- -->.
+

docs/search-core.searchcore.md

@@ -14,138 +14,6 @@ export declare class SearchCore
 
 ## Constructors
 
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(searchService, questionSubmissionService, autoCompleteService)](./search-core.searchcore._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `SearchCore` class
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[filterSearch(request)](./search-core.searchcore.filtersearch.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Performs a filtersearch request against specified fields within a single vertical.
-
-
-</td></tr>
-<tr><td>
-
-[submitQuestion(request)](./search-core.searchcore.submitquestion.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Submits a custom question to the Search API.
-
-
-</td></tr>
-<tr><td>
-
-[universalAutocomplete(request)](./search-core.searchcore.universalautocomplete.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Performs an autocomplete request across all verticals.
-
-
-</td></tr>
-<tr><td>
-
-[universalSearch(request)](./search-core.searchcore.universalsearch.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Performs a search across all verticals.
-
-
-</td></tr>
-<tr><td>
-
-[verticalAutocomplete(request)](./search-core.searchcore.verticalautocomplete.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Performs an autocomplete request for a single vertical.
-
-
-</td></tr>
-<tr><td>
-
-[verticalSearch(request)](./search-core.searchcore.verticalsearch.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Performs a search for a single vertical.
-
 
 </td></tr>
 </tbody></table>

docs/search-core.source.md

@@ -14,7 +14,7 @@ export declare enum Source
 
 ## Enumeration Members
 
-<table><thead><tr><th>
+
 
 Member