Skip to content

Commit

Permalink
Merge master (v2.6.0-beta) into develop (#264)
Browse files Browse the repository at this point in the history
Add generativeDirectAnswer service (#263)

J=CLIP-1226
TEST=auto,manual

Co-authored-by: Yen Truong <[email protected]>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
2 people authored and Fondryext committed Dec 9, 2024
1 parent 12b65c8 commit fedef35
Show file tree
Hide file tree
Showing 45 changed files with 1,098 additions and 1,946 deletions.
11 changes: 11 additions & 0 deletions docs/search-core.endpoints.generativedirectanswer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Endpoints](./search-core.endpoints.md) &gt; [generativeDirectAnswer](./search-core.endpoints.generativedirectanswer.md)

## Endpoints.generativeDirectAnswer property

<b>Signature:</b>

```typescript
generativeDirectAnswer?: string;
```
13 changes: 13 additions & 0 deletions docs/search-core.endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,20 @@ export interface Endpoints

## Properties

<<<<<<< HEAD
<table><thead><tr><th>
=======
| 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> |
| [universalSearch?](./search-core.endpoints.universalsearch.md) | string | <i>(Optional)</i> |
| [verticalAutocomplete?](./search-core.endpoints.verticalautocomplete.md) | string | <i>(Optional)</i> |
| [verticalSearch?](./search-core.endpoints.verticalsearch.md) | string | <i>(Optional)</i> |
>>>>>>> d7c4b92 (Merge master (v2.6.0-beta) into develop (#264))

Property

Expand Down
23 changes: 23 additions & 0 deletions docs/search-core.generativedirectanswerrequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md)

## GenerativeDirectAnswerRequest interface

Options which can be specified for a generative direct answer request.

<b>Signature:</b>

```typescript
export interface GenerativeDirectAnswerRequest extends SearchRequest
```
<b>Extends:</b> [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. |
13 changes: 13 additions & 0 deletions docs/search-core.generativedirectanswerrequest.results.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) &gt; [results](./search-core.generativedirectanswerrequest.results.md)

## GenerativeDirectAnswerRequest.results property

The complete set of Search Results

<b>Signature:</b>

```typescript
results: VerticalResults[];
```
13 changes: 13 additions & 0 deletions docs/search-core.generativedirectanswerrequest.searchid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) &gt; [searchId](./search-core.generativedirectanswerrequest.searchid.md)

## GenerativeDirectAnswerRequest.searchId property

The ID of the search request.

<b>Signature:</b>

```typescript
searchId: string;
```
13 changes: 13 additions & 0 deletions docs/search-core.generativedirectanswerrequest.searchterm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) &gt; [searchTerm](./search-core.generativedirectanswerrequest.searchterm.md)

## GenerativeDirectAnswerRequest.searchTerm property

The text of the user-written query that prompted Search results.

<b>Signature:</b>

```typescript
searchTerm: string;
```
13 changes: 13 additions & 0 deletions docs/search-core.generativedirectanswerresponse.citations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md) &gt; [citations](./search-core.generativedirectanswerresponse.citations.md)

## GenerativeDirectAnswerResponse.citations property

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[];
```
13 changes: 13 additions & 0 deletions docs/search-core.generativedirectanswerresponse.directanswer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md) &gt; [directAnswer](./search-core.generativedirectanswerresponse.directanswer.md)

## GenerativeDirectAnswerResponse.directAnswer property

The text of the final generated response.

<b>Signature:</b>

```typescript
directAnswer: string;
```
22 changes: 22 additions & 0 deletions docs/search-core.generativedirectanswerresponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md)

## GenerativeDirectAnswerResponse interface

A representation of a generative direct answer response.

<b>Signature:</b>

```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. |

13 changes: 13 additions & 0 deletions docs/search-core.generativedirectanswerresponse.resultstatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md) &gt; [resultStatus](./search-core.generativedirectanswerresponse.resultstatus.md)

## GenerativeDirectAnswerResponse.resultStatus property

A string representing whether there was a result found within the given invocation.

<b>Signature:</b>

```typescript
resultStatus: string;
```
24 changes: 24 additions & 0 deletions docs/search-core.generativedirectanswerservice.generateanswer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerService](./search-core.generativedirectanswerservice.md) &gt; [generateAnswer](./search-core.generativedirectanswerservice.generateanswer.md)

## GenerativeDirectAnswerService.generateAnswer() method

Generates an answer to a search query.

<b>Signature:</b>

```typescript
generateAnswer(request: GenerativeDirectAnswerRequest): Promise<GenerativeDirectAnswerResponse>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| request | [GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) | |

<b>Returns:</b>

Promise&lt;[GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md)<!-- -->&gt;

20 changes: 20 additions & 0 deletions docs/search-core.generativedirectanswerservice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [GenerativeDirectAnswerService](./search-core.generativedirectanswerservice.md)

## GenerativeDirectAnswerService interface

A service for generative direct answer requests.

<b>Signature:</b>

```typescript
export interface GenerativeDirectAnswerService
```

## Methods

| Method | Description |
| --- | --- |
| [generateAnswer(request)](./search-core.generativedirectanswerservice.generateanswer.md) | Generates an answer to a search query. |

Loading

0 comments on commit fedef35

Please sign in to comment.