From 06cacb83a0a49980b83567f0cc2a26f79ee130c0 Mon Sep 17 00:00:00 2001
From: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 6 Jun 2024 17:00:27 +0000
Subject: [PATCH] Automated update to repo's documentation from github action
---
...adless.endpoints.generativedirectanswer.md | 2 +-
docs/search-headless.endpoints.md | 1 +
...-headless.generativedirectanswerrequest.md | 87 ++-----------------
...s.generativedirectanswerrequest.results.md | 2 +-
....generativedirectanswerrequest.searchid.md | 2 +-
...enerativedirectanswerrequest.searchterm.md | 2 +-
...enerativedirectanswerresponse.citations.md | 2 +-
...rativedirectanswerresponse.directanswer.md | 2 +-
...headless.generativedirectanswerresponse.md | 85 ++----------------
...rativedirectanswerresponse.resultstatus.md | 2 +-
docs/search-headless.md | 2 +
...earch-headless.searchcore._constructor_.md | 3 +-
...dless.searchcore.generativedirectanswer.md | 39 ++-------
docs/search-headless.searchcore.md | 3 +-
...hheadless.executegenerativedirectanswer.md | 4 +-
docs/search-headless.searchheadless.md | 1 +
16 files changed, 35 insertions(+), 204 deletions(-)
diff --git a/docs/search-headless.endpoints.generativedirectanswer.md b/docs/search-headless.endpoints.generativedirectanswer.md
index 2def1f55..b707a6ee 100644
--- a/docs/search-headless.endpoints.generativedirectanswer.md
+++ b/docs/search-headless.endpoints.generativedirectanswer.md
@@ -4,7 +4,7 @@
## Endpoints.generativeDirectAnswer property
-**Signature:**
+Signature:
```typescript
generativeDirectAnswer?: string;
diff --git a/docs/search-headless.endpoints.md b/docs/search-headless.endpoints.md
index 7df496cc..8f1e1ada 100644
--- 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 | (Optional) |
+| [generativeDirectAnswer?](./search-headless.endpoints.generativedirectanswer.md) | string | (Optional) |
| [questionSubmission?](./search-headless.endpoints.questionsubmission.md) | string | (Optional) |
| [status?](./search-headless.endpoints.status.md) | string | (Optional) |
| [universalAutocomplete?](./search-headless.endpoints.universalautocomplete.md) | string | (Optional) |
diff --git a/docs/search-headless.generativedirectanswerrequest.md b/docs/search-headless.generativedirectanswerrequest.md
index de85bff4..78c47014 100644
--- 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:**
+Signature:
```typescript
export declare interface GenerativeDirectAnswerRequest extends SearchRequest
```
-**Extends:** [SearchRequest](./search-headless.searchrequest.md)
+Extends: [SearchRequest](./search-headless.searchrequest.md)
## Properties
-
+| 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
-
-
- |
-
-Modifiers
-
-
- |
-
-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.
-
-
- |
-
diff --git a/docs/search-headless.generativedirectanswerrequest.results.md b/docs/search-headless.generativedirectanswerrequest.results.md
index 1376bd21..b2cdd90e 100644
--- 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:**
+Signature:
```typescript
results: VerticalResults[];
diff --git a/docs/search-headless.generativedirectanswerrequest.searchid.md b/docs/search-headless.generativedirectanswerrequest.searchid.md
index 2f2a2027..c7379338 100644
--- 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:**
+Signature:
```typescript
searchId: string;
diff --git a/docs/search-headless.generativedirectanswerrequest.searchterm.md b/docs/search-headless.generativedirectanswerrequest.searchterm.md
index bc4a156d..ff877047 100644
--- 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:**
+Signature:
```typescript
searchTerm: string;
diff --git a/docs/search-headless.generativedirectanswerresponse.citations.md b/docs/search-headless.generativedirectanswerresponse.citations.md
index 00f7a6c6..6673141a 100644
--- 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:**
+Signature:
```typescript
citations: string[];
diff --git a/docs/search-headless.generativedirectanswerresponse.directanswer.md b/docs/search-headless.generativedirectanswerresponse.directanswer.md
index 303d1346..0ec0f058 100644
--- 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:**
+Signature:
```typescript
directAnswer: string;
diff --git a/docs/search-headless.generativedirectanswerresponse.md b/docs/search-headless.generativedirectanswerresponse.md
index 8aef9c86..e4e9d659 100644
--- a/docs/search-headless.generativedirectanswerresponse.md
+++ b/docs/search-headless.generativedirectanswerresponse.md
@@ -6,7 +6,7 @@
A representation of a generative direct answer response.
-**Signature:**
+Signature:
```typescript
export declare interface GenerativeDirectAnswerResponse
@@ -14,82 +14,9 @@ export declare interface GenerativeDirectAnswerResponse
## Properties
-
+| 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
-
-
- |
-
-Modifiers
-
-
- |
-
-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.
-
-
- |
-
diff --git a/docs/search-headless.generativedirectanswerresponse.resultstatus.md b/docs/search-headless.generativedirectanswerresponse.resultstatus.md
index 8069531a..59403c05 100644
--- 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:**
+Signature:
```typescript
resultStatus: string;
diff --git a/docs/search-headless.md b/docs/search-headless.md
index dadae416..91b3ca62 100644
--- 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
index 763c7487..741a1ff3 100644
--- 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
Signature:
```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
index a42a34e1..7e49c61a 100644
--- a/docs/search-headless.searchcore.generativedirectanswer.md
+++ b/docs/search-headless.searchcore.generativedirectanswer.md
@@ -6,7 +6,7 @@
Performs a generative direct answer request.
-**Signature:**
+Signature:
```typescript
generativeDirectAnswer(request: GenerativeDirectAnswerRequest): Promise;
@@ -14,40 +14,11 @@ generativeDirectAnswer(request: GenerativeDirectAnswerRequest): Promise
+| Parameter | Type | Description |
+| --- | --- | --- |
+| request | [GenerativeDirectAnswerRequest](./search-headless.generativedirectanswerrequest.md) | Generative direct answer request options |
-Parameter
-
-
- |
-
-Type
-
-
- |
-
-Description
-
-
- |
-
-
-request
-
-
- |
-
-[GenerativeDirectAnswerRequest](./search-headless.generativedirectanswerrequest.md)
-
-
- |
-
-Generative direct answer request options
-
-
- |
-
-**Returns:**
+Returns:
Promise<[GenerativeDirectAnswerResponse](./search-headless.generativedirectanswerresponse.md)>
diff --git a/docs/search-headless.searchcore.md b/docs/search-headless.searchcore.md
index ae4a2086..8e5596a5 100644
--- 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 SearchCore
class |
+| [(constructor)(searchService, questionSubmissionService, autoCompleteService, generativeDirectAnswerService)](./search-headless.searchcore._constructor_.md) | | Constructs a new instance of the SearchCore
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
index 4982471b..4770cdf5 100644
--- 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:**
+Signature:
```typescript
executeGenerativeDirectAnswer(): Promise;
```
-**Returns:**
+Returns:
Promise<[GenerativeDirectAnswerResponse](./search-headless.generativedirectanswerresponse.md) \| undefined>
diff --git a/docs/search-headless.searchheadless.md b/docs/search-headless.searchheadless.md
index 4eb2e96e..0ba2605f 100644
--- 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. |