From e04ecad43658a9cf21cf0434baff9b7186c42d3c Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 10 Dec 2024 18:06:53 +0000 Subject: [PATCH] Automated update to repo's documentation from github action --- ...h-core.endpoints.generativedirectanswer.md | 2 +- docs/search-core.endpoints.md | 21 +++ ...arch-core.generativedirectanswerrequest.md | 87 ++++++++++- ...e.generativedirectanswerrequest.results.md | 2 +- ....generativedirectanswerrequest.searchid.md | 2 +- ...enerativedirectanswerrequest.searchterm.md | 2 +- ...enerativedirectanswerresponse.citations.md | 2 +- ...rativedirectanswerresponse.directanswer.md | 2 +- ...rch-core.generativedirectanswerresponse.md | 85 +++++++++- ...rativedirectanswerresponse.resultstatus.md | 2 +- ...ativedirectanswerservice.generateanswer.md | 37 ++++- ...arch-core.generativedirectanswerservice.md | 27 +++- docs/search-core.md | 35 +++++ docs/search-core.searchcore._constructor_.md | 15 ++ ...-core.searchcore.generativedirectanswer.md | 39 ++++- docs/search-core.searchcore.md | 146 ++++++++++++++++++ docs/search-core.source.md | 18 ++- docs/search-core.verticalresults.md | 6 +- 18 files changed, 492 insertions(+), 38 deletions(-) diff --git a/docs/search-core.endpoints.generativedirectanswer.md b/docs/search-core.endpoints.generativedirectanswer.md index 2dc926a5..ea544c63 100644 --- a/docs/search-core.endpoints.generativedirectanswer.md +++ b/docs/search-core.endpoints.generativedirectanswer.md @@ -4,7 +4,7 @@ ## Endpoints.generativeDirectAnswer property -Signature: +**Signature:** ```typescript generativeDirectAnswer?: string; diff --git a/docs/search-core.endpoints.md b/docs/search-core.endpoints.md index 482496e7..b445ebb1 100644 --- a/docs/search-core.endpoints.md +++ b/docs/search-core.endpoints.md @@ -14,6 +14,8 @@ export interface Endpoints ## Properties + + + +
+ Property @@ -51,6 +53,25 @@ string _(Optional)_ +
+ +[generativeDirectAnswer?](./search-core.endpoints.generativedirectanswer.md) + + + + + + + +string + + + + +_(Optional)_ + +
diff --git a/docs/search-core.generativedirectanswerrequest.md b/docs/search-core.generativedirectanswerrequest.md index dfb35480..7554584d 100644 --- 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. -Signature: +**Signature:** ```typescript export interface GenerativeDirectAnswerRequest extends SearchRequest ``` -Extends: [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. | + + + + +
+Property + + + + +Modifiers + + + + +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. + + +
diff --git a/docs/search-core.generativedirectanswerrequest.results.md b/docs/search-core.generativedirectanswerrequest.results.md index 0f17c0fe..62a563ef 100644 --- a/docs/search-core.generativedirectanswerrequest.results.md +++ b/docs/search-core.generativedirectanswerrequest.results.md @@ -6,7 +6,7 @@ The complete set of Search Results -Signature: +**Signature:** ```typescript results: VerticalResults[]; diff --git a/docs/search-core.generativedirectanswerrequest.searchid.md b/docs/search-core.generativedirectanswerrequest.searchid.md index a7890807..98950e7b 100644 --- a/docs/search-core.generativedirectanswerrequest.searchid.md +++ b/docs/search-core.generativedirectanswerrequest.searchid.md @@ -6,7 +6,7 @@ The ID of the search request. -Signature: +**Signature:** ```typescript searchId: string; diff --git a/docs/search-core.generativedirectanswerrequest.searchterm.md b/docs/search-core.generativedirectanswerrequest.searchterm.md index be456fe0..cf877815 100644 --- 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. -Signature: +**Signature:** ```typescript searchTerm: string; diff --git a/docs/search-core.generativedirectanswerresponse.citations.md b/docs/search-core.generativedirectanswerresponse.citations.md index c6a7049c..e5277cfc 100644 --- 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. -Signature: +**Signature:** ```typescript citations: string[]; diff --git a/docs/search-core.generativedirectanswerresponse.directanswer.md b/docs/search-core.generativedirectanswerresponse.directanswer.md index 0a2627e1..59f4a648 100644 --- 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. -Signature: +**Signature:** ```typescript directAnswer: string; diff --git a/docs/search-core.generativedirectanswerresponse.md b/docs/search-core.generativedirectanswerresponse.md index f4aae47d..0dc65119 100644 --- a/docs/search-core.generativedirectanswerresponse.md +++ b/docs/search-core.generativedirectanswerresponse.md @@ -6,7 +6,7 @@ A representation of a generative direct answer response. -Signature: +**Signature:** ```typescript export interface GenerativeDirectAnswerResponse @@ -14,9 +14,82 @@ 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. | + + + + +
+Property + + + + +Modifiers + + + + +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. + + +
diff --git a/docs/search-core.generativedirectanswerresponse.resultstatus.md b/docs/search-core.generativedirectanswerresponse.resultstatus.md index 22699fa3..80938178 100644 --- 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. -Signature: +**Signature:** ```typescript resultStatus: string; diff --git a/docs/search-core.generativedirectanswerservice.generateanswer.md b/docs/search-core.generativedirectanswerservice.generateanswer.md index 03de412a..a3816c25 100644 --- a/docs/search-core.generativedirectanswerservice.generateanswer.md +++ b/docs/search-core.generativedirectanswerservice.generateanswer.md @@ -6,7 +6,7 @@ Generates an answer to a search query. -Signature: +**Signature:** ```typescript generateAnswer(request: GenerativeDirectAnswerRequest): Promise; @@ -14,11 +14,38 @@ generateAnswer(request: GenerativeDirectAnswerRequest): Promise
-Returns: +Parameter + + + + +Type + + + + +Description + + +
+ +request + + + + +[GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) + + + + + +
+**Returns:** Promise<[GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md)> diff --git a/docs/search-core.generativedirectanswerservice.md b/docs/search-core.generativedirectanswerservice.md index 510a5b1a..90a19e74 100644 --- a/docs/search-core.generativedirectanswerservice.md +++ b/docs/search-core.generativedirectanswerservice.md @@ -6,7 +6,7 @@ A service for generative direct answer requests. -Signature: +**Signature:** ```typescript export interface GenerativeDirectAnswerService @@ -14,7 +14,26 @@ export interface GenerativeDirectAnswerService ## Methods -| Method | Description | -| --- | --- | -| [generateAnswer(request)](./search-core.generativedirectanswerservice.generateanswer.md) | Generates an answer to a search query. | + + +
+Method + + + + +Description + + +
+ +[generateAnswer(request)](./search-core.generativedirectanswerservice.generateanswer.md) + + + + +Generates an answer to a search query. + + +
diff --git a/docs/search-core.md b/docs/search-core.md index ad22981e..267d1e9f 100644 --- a/docs/search-core.md +++ b/docs/search-core.md @@ -271,6 +271,8 @@ The entrypoint to the search-core library. ## Interfaces + + + + + +
+ Interface @@ -631,6 +633,39 @@ Options for a filtersearch request. 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. + +
diff --git a/docs/search-core.searchcore._constructor_.md b/docs/search-core.searchcore._constructor_.md index 03a45551..d59e29b2 100644 --- a/docs/search-core.searchcore._constructor_.md +++ b/docs/search-core.searchcore._constructor_.md @@ -14,6 +14,7 @@ constructor(searchService: SearchService, questionSubmissionService: QuestionSub ## Parameters + +
Parameter @@ -70,5 +71,19 @@ autoCompleteService +
+ +generativeDirectAnswerService + + + + +[GenerativeDirectAnswerService](./search-core.generativedirectanswerservice.md) + + + + +
diff --git a/docs/search-core.searchcore.generativedirectanswer.md b/docs/search-core.searchcore.generativedirectanswer.md index 4b1e6c3f..27bbf305 100644 --- a/docs/search-core.searchcore.generativedirectanswer.md +++ b/docs/search-core.searchcore.generativedirectanswer.md @@ -6,7 +6,7 @@ Performs a generative direct answer request. -Signature: +**Signature:** ```typescript generativeDirectAnswer(request: GenerativeDirectAnswerRequest): Promise; @@ -14,11 +14,40 @@ generativeDirectAnswer(request: GenerativeDirectAnswerRequest): Promise
-Returns: +Parameter + + + + +Type + + + + +Description + + +
+ +request + + + + +[GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) + + + + +Generative direct answer request options + + +
+**Returns:** Promise<[GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md)> diff --git a/docs/search-core.searchcore.md b/docs/search-core.searchcore.md index 3a405b5c..9cff47dc 100644 --- a/docs/search-core.searchcore.md +++ b/docs/search-core.searchcore.md @@ -14,6 +14,152 @@ export declare class SearchCore ## Constructors + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(searchService, questionSubmissionService, autoCompleteService, generativeDirectAnswerService)](./search-core.searchcore._constructor_.md) + + + + + + + +Constructs a new instance of the `SearchCore` class + + +
+ +## Methods + + + + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[filterSearch(request)](./search-core.searchcore.filtersearch.md) + + + + + + + +Performs a filtersearch request against specified fields within a single vertical. + + +
+ +[generativeDirectAnswer(request)](./search-core.searchcore.generativedirectanswer.md) + + + + + + + +Performs a generative direct answer request. + + +
+ +[submitQuestion(request)](./search-core.searchcore.submitquestion.md) + + + + + + + +Submits a custom question to the Search API. + + +
+ +[universalAutocomplete(request)](./search-core.searchcore.universalautocomplete.md) + + + + + + + +Performs an autocomplete request across all verticals. + + +
+ +[universalSearch(request)](./search-core.searchcore.universalsearch.md) + + + + + + + +Performs a search across all verticals. + + +
+ +[verticalAutocomplete(request)](./search-core.searchcore.verticalautocomplete.md) + + + + + + + +Performs an autocomplete request for a single vertical. + + +
+ +[verticalSearch(request)](./search-core.searchcore.verticalsearch.md) + + + + + + + +Performs a search for a single vertical. +
diff --git a/docs/search-core.source.md b/docs/search-core.source.md index 00e5e807..6a14045d 100644 --- a/docs/search-core.source.md +++ b/docs/search-core.source.md @@ -14,7 +14,7 @@ export declare enum Source ## Enumeration Members - + +
Member @@ -61,6 +61,22 @@ DocumentVertical The result is from a document vertical. +
+ +FunctionVertical + + + + +`"FUNCTION_VERTICAL"` + + + + +The result is from a function vertical. + +
diff --git a/docs/search-core.verticalresults.md b/docs/search-core.verticalresults.md index 154667ca..df19e645 100644 --- a/docs/search-core.verticalresults.md +++ b/docs/search-core.verticalresults.md @@ -14,7 +14,7 @@ export interface VerticalResults ## Properties - +
Property @@ -56,7 +56,7 @@ A array of [AppliedQueryFilter](./search-core.appliedqueryfilter.md)s wh
-[queryDurationMillis](./search-core.verticalresults.querydurationmillis.md) +[queryDurationMillis?](./search-core.verticalresults.querydurationmillis.md) @@ -69,7 +69,7 @@ number -The duration of the query in milliseconds. +_(Optional)_ The duration of the query in milliseconds