Automated update to repo's documentation from github action

yext · Jun 4, 2024 · a8b8520 · a8b8520
1 parent 170e8f8
commit a8b8520
Show file tree

Hide file tree

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

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

diff --git a/docs/search-core.generativedirectanswerrequest.md b/docs/search-core.generativedirectanswerrequest.md
@@ -6,85 +6,18 @@
 
 Options which can be specified for a generative direct answer request.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 export interface GenerativeDirectAnswerRequest extends SearchRequest 
 ```
-**Extends:** [SearchRequest](./search-core.searchrequest.md)
+<b>Extends:</b> [SearchRequest](./search-core.searchrequest.md)
 
 ## Properties
 
-<table><thead><tr><th>
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [results](./search-core.generativedirectanswerrequest.results.md) | [VerticalResults](./search-core.verticalresults.md) \| Record&lt;string, [VerticalResults](./search-core.verticalresults.md)<!-- -->\[\]&gt; | 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. |
 
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[results](./search-core.generativedirectanswerrequest.results.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Record&lt;string, [VerticalResults](./search-core.verticalresults.md)<!-- -->\[\]&gt;
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[searchId](./search-core.generativedirectanswerrequest.searchid.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[searchTerm](./search-core.generativedirectanswerrequest.searchterm.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
diff --git a/docs/search-core.generativedirectanswerrequest.results.md b/docs/search-core.generativedirectanswerrequest.results.md
@@ -4,8 +4,10 @@
 
 ## GenerativeDirectAnswerRequest.results property
 
-**Signature:**
+The complete set of Search Results
+
+<b>Signature:</b>
 
 ```typescript
-results: Record<string, VerticalResults[]>;
+results: VerticalResults | Record<string, VerticalResults[]>;
 ```
diff --git a/docs/search-core.generativedirectanswerrequest.searchid.md b/docs/search-core.generativedirectanswerrequest.searchid.md
@@ -4,7 +4,9 @@
 
 ## GenerativeDirectAnswerRequest.searchId property
 
-**Signature:**
+The ID of the search request.
+
+<b>Signature:</b>
 
 ```typescript
 searchId: string;

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

diff --git a/docs/search-core.generativedirectanswerresponse.citations.md b/docs/search-core.generativedirectanswerresponse.citations.md
@@ -4,7 +4,9 @@
 
 ## GenerativeDirectAnswerResponse.citations property
 
-**Signature:**
+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[];

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

diff --git a/docs/search-core.generativedirectanswerresponse.md b/docs/search-core.generativedirectanswerresponse.md
@@ -6,84 +6,17 @@
 
 A representation of a generative direct answer response.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 export interface GenerativeDirectAnswerResponse 
 ```
 
 ## Properties
 
-<table><thead><tr><th>
+|  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. |
 
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[citations](./search-core.generativedirectanswerresponse.citations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[directAnswer](./search-core.generativedirectanswerresponse.directanswer.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[resultStatus](./search-core.generativedirectanswerresponse.resultstatus.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
diff --git a/docs/search-core.generativedirectanswerresponse.resultstatus.md b/docs/search-core.generativedirectanswerresponse.resultstatus.md
@@ -4,7 +4,9 @@
 
 ## GenerativeDirectAnswerResponse.resultStatus property
 
-**Signature:**
+A string representing whether there was a result found within the given invocation.
+
+<b>Signature:</b>
 
 ```typescript
 resultStatus: string;

diff --git a/docs/search-core.generativedirectanswerresponse.uuid.md b/docs/search-core.generativedirectanswerresponse.uuid.md
diff --git a/docs/search-core.generativedirectanswerservice.generateanswer.md b/docs/search-core.generativedirectanswerservice.generateanswer.md
@@ -6,46 +6,19 @@
 
 Generates an answer to a search query.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 generateAnswer(request: GenerativeDirectAnswerRequest): Promise<GenerativeDirectAnswerResponse>;
 ```
 
 ## Parameters
 
-<table><thead><tr><th>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) |  |
 
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-request
-
-
-</td><td>
-
-[GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
+<b>Returns:</b>
 
 Promise&lt;[GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md)<!-- -->&gt;
 
diff --git a/docs/search-core.generativedirectanswerservice.md b/docs/search-core.generativedirectanswerservice.md
@@ -6,34 +6,15 @@
 
 A service for generative direct answer requests.
 
-**Signature:**
+<b>Signature:</b>
 
 ```typescript
 export interface GenerativeDirectAnswerService 
 ```
 
 ## Methods
 
-<table><thead><tr><th>
+|  Method | Description |
+|  --- | --- |
+|  [generateAnswer(request)](./search-core.generativedirectanswerservice.generateanswer.md) | Generates an answer to a search query. |
 
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[generateAnswer(request)](./search-core.generativedirectanswerservice.generateanswer.md)
-
-
-</td><td>
-
-Generates an answer to a search query.
-
-
-</td></tr>
-</tbody></table>
diff --git a/docs/search-core.md b/docs/search-core.md
@@ -74,6 +74,9 @@
 |  [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md) | A [FieldValueFilter](./search-core.fieldvaluefilter.md) with the kind of filter specified to discriminate between static filter types. |
 |  [FilterSearchRequest](./search-core.filtersearchrequest.md) | Options for a filtersearch request. |
 |  [FilterSearchResponse](./search-core.filtersearchresponse.md) | The response of a filtersearch request. |
+|  [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) | Options which can be specified for a generative direct answer request. |
+|  [GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md) | A representation of a generative direct answer response. |
+|  [GenerativeDirectAnswerService](./search-core.generativedirectanswerservice.md) | A service for generative direct answer requests. |
 |  [HighlightedValue](./search-core.highlightedvalue.md) | A field value and its substring matches as emphasized by the Search API. |
 |  [HolidayHours](./search-core.holidayhours.md) | An interface for holiday hours to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. |
 |  [Hours](./search-core.hours.md) | An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. |

diff --git a/docs/search-core.searchcore._constructor_.md b/docs/search-core.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-core.searchservice.md) |  |
 |  questionSubmissionService | [QuestionSubmissionService](./search-core.questionsubmissionservice.md) |  |
 |  autoCompleteService | [AutocompleteService](./search-core.autocompleteservice.md) |  |
+|  generativeDirectAnswerService | [GenerativeDirectAnswerService](./search-core.generativedirectanswerservice.md) |  |