Automated update to repo's documentation from github action

yext · Jun 6, 2024 · 06cacb8 · 06cacb8
1 parent ba68635
commit 06cacb8
Show file tree

Hide file tree

Showing 16 changed files with 35 additions and 204 deletions.
diff --git a/docs/search-headless.endpoints.generativedirectanswer.md b/docs/search-headless.endpoints.generativedirectanswer.md
@@ -4,7 +4,7 @@
 
 ## Endpoints.generativeDirectAnswer property
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 generativeDirectAnswer?: string;

diff --git a/docs/search-headless.endpoints.md b/docs/search-headless.endpoints.md
@@ -17,6 +17,7 @@ export declare interface Endpoints
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [filterSearch?](./search-headless.endpoints.filtersearch.md) | string | <i>(Optional)</i> |
+|  [generativeDirectAnswer?](./search-headless.endpoints.generativedirectanswer.md) | string | <i>(Optional)</i> |
 |  [questionSubmission?](./search-headless.endpoints.questionsubmission.md) | string | <i>(Optional)</i> |
 |  [status?](./search-headless.endpoints.status.md) | string | <i>(Optional)</i> |
 |  [universalAutocomplete?](./search-headless.endpoints.universalautocomplete.md) | string | <i>(Optional)</i> |

diff --git a/docs/search-headless.generativedirectanswerrequest.md b/docs/search-headless.generativedirectanswerrequest.md
@@ -6,91 +6,18 @@
 
 Options which can be specified for a generative direct answer request.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 export declare interface GenerativeDirectAnswerRequest extends SearchRequest 
 ```
-**Extends:** [SearchRequest](./search-headless.searchrequest.md)
+<b>Extends:</b> [SearchRequest](./search-headless.searchrequest.md)
 
 ## Properties
 
-<table><thead><tr><th>
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [results](./search-headless.generativedirectanswerrequest.results.md) | [VerticalResults](./search-headless.verticalresults.md)<!-- -->\[\] | The complete set of Search Results |
+|  [searchId](./search-headless.generativedirectanswerrequest.searchid.md) | string | The ID of the search request. |
+|  [searchTerm](./search-headless.generativedirectanswerrequest.searchterm.md) | string | The text of the user-written query that prompted Search results. |
 
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[results](./search-headless.generativedirectanswerrequest.results.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[VerticalResults](./search-headless.verticalresults.md)<!-- -->\[\]
-
-
-</td><td>
-
-The complete set of Search Results
-
-
-</td></tr>
-<tr><td>
-
-[searchId](./search-headless.generativedirectanswerrequest.searchid.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The ID of the search request.
-
-
-</td></tr>
-<tr><td>
-
-[searchTerm](./search-headless.generativedirectanswerrequest.searchterm.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The text of the user-written query that prompted Search results.
-
-
-</td></tr>
-</tbody></table>
diff --git a/docs/search-headless.generativedirectanswerrequest.results.md b/docs/search-headless.generativedirectanswerrequest.results.md
@@ -6,7 +6,7 @@
 
 The complete set of Search Results
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 results: VerticalResults[];

diff --git a/docs/search-headless.generativedirectanswerrequest.searchid.md b/docs/search-headless.generativedirectanswerrequest.searchid.md
@@ -6,7 +6,7 @@
 
 The ID of the search request.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 searchId: string;

diff --git a/docs/search-headless.generativedirectanswerrequest.searchterm.md b/docs/search-headless.generativedirectanswerrequest.searchterm.md
@@ -6,7 +6,7 @@
 
 The text of the user-written query that prompted Search results.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 searchTerm: string;

diff --git a/docs/search-headless.generativedirectanswerresponse.citations.md b/docs/search-headless.generativedirectanswerresponse.citations.md
@@ -6,7 +6,7 @@
 
 An array of uids from the relevant [Result.rawData](./search-headless.result.rawdata.md) that were used to form the directAnswer.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 citations: string[];

diff --git a/docs/search-headless.generativedirectanswerresponse.directanswer.md b/docs/search-headless.generativedirectanswerresponse.directanswer.md
@@ -6,7 +6,7 @@
 
 The text of the final generated response.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 directAnswer: string;

diff --git a/docs/search-headless.generativedirectanswerresponse.md b/docs/search-headless.generativedirectanswerresponse.md
@@ -6,90 +6,17 @@
 
 A representation of a generative direct answer response.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 export declare interface GenerativeDirectAnswerResponse 
 ```
 
 ## Properties
 
-<table><thead><tr><th>
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [citations](./search-headless.generativedirectanswerresponse.citations.md) | string\[\] | An array of uids from the relevant [Result.rawData](./search-headless.result.rawdata.md) that were used to form the directAnswer. |
+|  [directAnswer](./search-headless.generativedirectanswerresponse.directanswer.md) | string | The text of the final generated response. |
+|  [resultStatus](./search-headless.generativedirectanswerresponse.resultstatus.md) | string | A string representing whether there was a result found within the given invocation. |
 
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[citations](./search-headless.generativedirectanswerresponse.citations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-An array of uids from the relevant [Result.rawData](./search-headless.result.rawdata.md) that were used to form the directAnswer.
-
-
-</td></tr>
-<tr><td>
-
-[directAnswer](./search-headless.generativedirectanswerresponse.directanswer.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The text of the final generated response.
-
-
-</td></tr>
-<tr><td>
-
-[resultStatus](./search-headless.generativedirectanswerresponse.resultstatus.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-A string representing whether there was a result found within the given invocation.
-
-
-</td></tr>
-</tbody></table>
diff --git a/docs/search-headless.generativedirectanswerresponse.resultstatus.md b/docs/search-headless.generativedirectanswerresponse.resultstatus.md
@@ -6,7 +6,7 @@
 
 A string representing whether there was a result found within the given invocation.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 resultStatus: string;

diff --git a/docs/search-headless.md b/docs/search-headless.md
@@ -85,6 +85,8 @@
 |  [FilterSearchRequest](./search-headless.filtersearchrequest.md) | Options for a filtersearch request. |
 |  [FilterSearchResponse](./search-headless.filtersearchresponse.md) | The response of a filtersearch request. |
 |  [FiltersState](./search-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. |
+|  [GenerativeDirectAnswerRequest](./search-headless.generativedirectanswerrequest.md) | Options which can be specified for a generative direct answer request. |
+|  [GenerativeDirectAnswerResponse](./search-headless.generativedirectanswerresponse.md) | A representation of a generative direct answer response. |
 |  [HighlightedValue](./search-headless.highlightedvalue.md) | A field value and its substring matches as emphasized by the Search API. |
 |  [HolidayHours](./search-headless.holidayhours.md) | An interface for holiday hours to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->. |
 |  [Hours](./search-headless.hours.md) | An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->. |

diff --git a/docs/search-headless.searchcore._constructor_.md b/docs/search-headless.searchcore._constructor_.md
@@ -9,7 +9,7 @@ Constructs a new instance of the `SearchCore` class
 <b>Signature:</b>
 
 ```typescript
-constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService);
+constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService, generativeDirectAnswerService: GenerativeDirectAnswerService);
 ```
 
 ## Parameters
@@ -19,4 +19,5 @@ constructor(searchService: SearchService, questionSubmissionService: QuestionSub
 |  searchService | [SearchService](./search-headless.searchservice.md) |  |
 |  questionSubmissionService | [QuestionSubmissionService](./search-headless.questionsubmissionservice.md) |  |
 |  autoCompleteService | [AutocompleteService](./search-headless.autocompleteservice.md) |  |
+|  generativeDirectAnswerService | GenerativeDirectAnswerService |  |
 
diff --git a/docs/search-headless.searchcore.generativedirectanswer.md b/docs/search-headless.searchcore.generativedirectanswer.md
@@ -6,48 +6,19 @@
 
 Performs a generative direct answer request.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 generativeDirectAnswer(request: GenerativeDirectAnswerRequest): Promise<GenerativeDirectAnswerResponse>;
 ```
 
 ## Parameters
 
-<table><thead><tr><th>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | [GenerativeDirectAnswerRequest](./search-headless.generativedirectanswerrequest.md) | Generative direct answer request options |
 
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-request
-
-
-</td><td>
-
-[GenerativeDirectAnswerRequest](./search-headless.generativedirectanswerrequest.md)
-
-
-</td><td>
-
-Generative direct answer request options
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
+<b>Returns:</b>
 
 Promise&lt;[GenerativeDirectAnswerResponse](./search-headless.generativedirectanswerresponse.md)<!-- -->&gt;
 

diff --git a/docs/search-headless.searchcore.md b/docs/search-headless.searchcore.md
@@ -16,13 +16,14 @@ export declare class SearchCore
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(searchService, questionSubmissionService, autoCompleteService)](./search-headless.searchcore._constructor_.md) |  | Constructs a new instance of the <code>SearchCore</code> class |
+|  [(constructor)(searchService, questionSubmissionService, autoCompleteService, generativeDirectAnswerService)](./search-headless.searchcore._constructor_.md) |  | Constructs a new instance of the <code>SearchCore</code> class |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [filterSearch(request)](./search-headless.searchcore.filtersearch.md) |  | Performs a filtersearch request against specified fields within a single vertical. |
+|  [generativeDirectAnswer(request)](./search-headless.searchcore.generativedirectanswer.md) |  | Performs a generative direct answer request. |
 |  [submitQuestion(request)](./search-headless.searchcore.submitquestion.md) |  | Submits a custom question to the Search API. |
 |  [universalAutocomplete(request)](./search-headless.searchcore.universalautocomplete.md) |  | Performs an autocomplete request across all verticals. |
 |  [universalSearch(request)](./search-headless.searchcore.universalsearch.md) |  | Performs a search across all verticals. |

diff --git a/docs/search-headless.searchheadless.executegenerativedirectanswer.md b/docs/search-headless.searchheadless.executegenerativedirectanswer.md
@@ -6,12 +6,12 @@
 
 Perform a generativeDirectAnswer request to the query most recent search stored in state.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 executeGenerativeDirectAnswer(): Promise<GenerativeDirectAnswerResponse | undefined>;
 ```
-**Returns:**
+<b>Returns:</b>
 
 Promise&lt;[GenerativeDirectAnswerResponse](./search-headless.generativedirectanswerresponse.md) \| undefined&gt;
 

diff --git a/docs/search-headless.searchheadless.md b/docs/search-headless.searchheadless.md
@@ -31,6 +31,7 @@ export default class SearchHeadless
 |  --- | --- | --- |
 |  [addListener(listener)](./search-headless.searchheadless.addlistener.md) |  | Adds a listener for a specific state value of type T. |
 |  [executeFilterSearch(query, sectioned, fields)](./search-headless.searchheadless.executefiltersearch.md) |  | Performs a filtersearch request against specified fields within a single vertical using the vertical key stored in state. |
+|  [executeGenerativeDirectAnswer()](./search-headless.searchheadless.executegenerativedirectanswer.md) |  | Perform a generativeDirectAnswer request to the query most recent search stored in state. |
 |  [executeUniversalAutocomplete()](./search-headless.searchheadless.executeuniversalautocomplete.md) |  | Performs an autocomplete request across all verticals using the query input stored in state. |
 |  [executeUniversalQuery()](./search-headless.searchheadless.executeuniversalquery.md) |  | Performs a Search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. |
 |  [executeVerticalAutocomplete()](./search-headless.searchheadless.executeverticalautocomplete.md) |  | Performs an autocomplete request for a single vertical using the query input and vertical key stored in state. |