Automated update to repo's documentation from github action

yext · Dec 10, 2024 · e04ecad · e04ecad
1 parent 0f5e84d
commit e04ecad
Show file tree

Hide file tree

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

diff --git a/docs/search-core.endpoints.md b/docs/search-core.endpoints.md
@@ -14,6 +14,8 @@ export interface Endpoints
 
 ## Properties
 
+<table><thead><tr><th>
+
 Property
 
 
@@ -51,6 +53,25 @@ string
 _(Optional)_
 
 
+</td></tr>
+<tr><td>
+
+[generativeDirectAnswer?](./search-core.endpoints.generativedirectanswer.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
 </td></tr>
 <tr><td>
 

diff --git a/docs/search-core.generativedirectanswerrequest.md b/docs/search-core.generativedirectanswerrequest.md
@@ -6,18 +6,91 @@
 
 Options which can be specified for a generative direct answer request.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface GenerativeDirectAnswerRequest extends SearchRequest 
 ```
-<b>Extends:</b> [SearchRequest](./search-core.searchrequest.md)
+**Extends:** [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. |
+<table><thead><tr><th>
 
+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>
+
+[VerticalResults](./search-core.verticalresults.md)<!-- -->\[\]
+
+
+</td><td>
+
+The complete set of Search Results
+
+
+</td></tr>
+<tr><td>
+
+[searchId](./search-core.generativedirectanswerrequest.searchid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The ID of the search request.
+
+
+</td></tr>
+<tr><td>
+
+[searchTerm](./search-core.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-core.generativedirectanswerrequest.results.md b/docs/search-core.generativedirectanswerrequest.results.md
@@ -6,7 +6,7 @@
 
 The complete set of Search Results
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 results: VerticalResults[];

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

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

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

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

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

diff --git a/docs/search-core.generativedirectanswerservice.generateanswer.md b/docs/search-core.generativedirectanswerservice.generateanswer.md
@@ -6,19 +6,46 @@
 
 Generates an answer to a search query.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 generateAnswer(request: GenerativeDirectAnswerRequest): Promise<GenerativeDirectAnswerResponse>;
 ```
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  request | [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) |  |
+<table><thead><tr><th>
 
-<b>Returns:</b>
+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:**
 
 Promise&lt;[GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md)<!-- -->&gt;
 
diff --git a/docs/search-core.generativedirectanswerservice.md b/docs/search-core.generativedirectanswerservice.md
@@ -6,15 +6,34 @@
 
 A service for generative direct answer requests.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface GenerativeDirectAnswerService 
 ```
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [generateAnswer(request)](./search-core.generativedirectanswerservice.generateanswer.md) | Generates an answer to a search query. |
+<table><thead><tr><th>
 
+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>