Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/develop' into dev/merge-v1.6.1-9…
Browse files Browse the repository at this point in the history
…b282d9-into-develop
  • Loading branch information
Fondryext committed Aug 13, 2024
2 parents 9b282d9 + 7f69cf9 commit d995a3e
Show file tree
Hide file tree
Showing 43 changed files with 4,269 additions and 1,018 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2,774 changes: 2,223 additions & 551 deletions THIRD-PARTY-NOTICES

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions docs/search-ui-react.citationprops.cssclasses.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-ui-react](./search-ui-react.md) &gt; [CitationProps](./search-ui-react.citationprops.md) &gt; [cssClasses](./search-ui-react.citationprops.cssclasses.md)

## CitationProps.cssClasses property

**Signature:**

```typescript
cssClasses: GenerativeDirectAnswerCssClasses;
```
21 changes: 21 additions & 0 deletions docs/search-ui-react.citationprops.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [CitationProps](./search-ui-react.citationprops.md)

## CitationProps interface

Props for citation card.

**Signature:**

```typescript
interface CitationProps
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [cssClasses](./search-ui-react.citationprops.cssclasses.md) | | [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) | |
| [searchResult](./search-ui-react.citationprops.searchresult.md) | | Result | |

11 changes: 11 additions & 0 deletions docs/search-ui-react.citationprops.searchresult.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-ui-react](./search-ui-react.md) &gt; [CitationProps](./search-ui-react.citationprops.md) &gt; [searchResult](./search-ui-react.citationprops.searchresult.md)

## CitationProps.searchResult property

**Signature:**

```typescript
searchResult: Result;
```
13 changes: 13 additions & 0 deletions docs/search-ui-react.citationsprops.citationcard.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-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md) &gt; [CitationCard](./search-ui-react.citationsprops.citationcard.md)

## CitationsProps.CitationCard property

The component for citation card

**Signature:**

```typescript
CitationCard?: (props: CitationProps) => JSX.Element | null;
```
13 changes: 13 additions & 0 deletions docs/search-ui-react.citationsprops.citationsheader.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-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md) &gt; [citationsHeader](./search-ui-react.citationsprops.citationsheader.md)

## CitationsProps.citationsHeader property

The header for the citations section generative direct answer.

**Signature:**

```typescript
citationsHeader?: string | JSX.Element;
```
13 changes: 13 additions & 0 deletions docs/search-ui-react.citationsprops.cssclasses.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-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md) &gt; [cssClasses](./search-ui-react.citationsprops.cssclasses.md)

## CitationsProps.cssClasses property

CSS classes for customizing the component styling.

**Signature:**

```typescript
cssClasses: GenerativeDirectAnswerCssClasses;
```
13 changes: 13 additions & 0 deletions docs/search-ui-react.citationsprops.gdaresponse.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-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md) &gt; [gdaResponse](./search-ui-react.citationsprops.gdaresponse.md)

## CitationsProps.gdaResponse property

Response object containing generative direct answer info.

**Signature:**

```typescript
gdaResponse: GenerativeDirectAnswerResponse;
```
24 changes: 24 additions & 0 deletions docs/search-ui-react.citationsprops.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-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md)

## CitationsProps interface

Props for citations component.

**Signature:**

```typescript
interface CitationsProps
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [CitationCard?](./search-ui-react.citationsprops.citationcard.md) | | (props: [CitationProps](./search-ui-react.citationprops.md)<!-- -->) =&gt; JSX.Element \| null | _(Optional)_ The component for citation card |
| [citationsHeader?](./search-ui-react.citationsprops.citationsheader.md) | | string \| JSX.Element | _(Optional)_ The header for the citations section generative direct answer. |
| [cssClasses](./search-ui-react.citationsprops.cssclasses.md) | | [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) | CSS classes for customizing the component styling. |
| [gdaResponse](./search-ui-react.citationsprops.gdaresponse.md) | | GenerativeDirectAnswerResponse | Response object containing generative direct answer info. |
| [searchResults](./search-ui-react.citationsprops.searchresults.md) | | Result\[\] | Returned results relevant to the users' query to be used in Citations. |

13 changes: 13 additions & 0 deletions docs/search-ui-react.citationsprops.searchresults.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-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md) &gt; [searchResults](./search-ui-react.citationsprops.searchresults.md)

## CitationsProps.searchResults property

Returned results relevant to the users' query to be used in Citations.

**Signature:**

```typescript
searchResults: Result[];
```
24 changes: 24 additions & 0 deletions docs/search-ui-react.executegenerativedirectanswer.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-ui-react](./search-ui-react.md) &gt; [executeGenerativeDirectAnswer](./search-ui-react.executegenerativedirectanswer.md)

## executeGenerativeDirectAnswer() function

Executes a generative direct answer and return the corresponding response.

**Signature:**

```typescript
declare function executeGenerativeDirectAnswer(searchActions: SearchActions): Promise<GenerativeDirectAnswerResponse | undefined>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| searchActions | SearchActions | |

**Returns:**

Promise&lt;GenerativeDirectAnswerResponse \| undefined&gt;

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

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswer](./search-ui-react.generativedirectanswer.md)

## GenerativeDirectAnswer() function

Displays the AI generated answer of a generative direct answer.

**Signature:**

```typescript
declare function GenerativeDirectAnswer({ customCssClasses, answerHeader, citationsHeader, CitationCard, CitationsContainer, }: GenerativeDirectAnswerProps): JSX.Element | null;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| { customCssClasses, answerHeader, citationsHeader, CitationCard, CitationsContainer, } | [GenerativeDirectAnswerProps](./search-ui-react.generativedirectanswerprops.md) | |

**Returns:**

JSX.Element \| null

A React element for the generative direct answer, or null if there is no generated answer

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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) &gt; [answerText](./search-ui-react.generativedirectanswercssclasses.answertext.md)

## GenerativeDirectAnswerCssClasses.answerText property

**Signature:**

```typescript
answerText?: string;
```
11 changes: 11 additions & 0 deletions docs/search-ui-react.generativedirectanswercssclasses.citation.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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) &gt; [citation](./search-ui-react.generativedirectanswercssclasses.citation.md)

## GenerativeDirectAnswerCssClasses.citation property

**Signature:**

```typescript
citation?: string;
```
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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) &gt; [citationsContainer](./search-ui-react.generativedirectanswercssclasses.citationscontainer.md)

## GenerativeDirectAnswerCssClasses.citationsContainer property

**Signature:**

```typescript
citationsContainer?: string;
```
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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) &gt; [citationSnippet](./search-ui-react.generativedirectanswercssclasses.citationsnippet.md)

## GenerativeDirectAnswerCssClasses.citationSnippet property

**Signature:**

```typescript
citationSnippet?: string;
```
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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) &gt; [citationTitle](./search-ui-react.generativedirectanswercssclasses.citationtitle.md)

## GenerativeDirectAnswerCssClasses.citationTitle property

**Signature:**

```typescript
citationTitle?: string;
```
11 changes: 11 additions & 0 deletions docs/search-ui-react.generativedirectanswercssclasses.container.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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) &gt; [container](./search-ui-react.generativedirectanswercssclasses.container.md)

## GenerativeDirectAnswerCssClasses.container property

**Signature:**

```typescript
container?: string;
```
11 changes: 11 additions & 0 deletions docs/search-ui-react.generativedirectanswercssclasses.divider.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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) &gt; [divider](./search-ui-react.generativedirectanswercssclasses.divider.md)

## GenerativeDirectAnswerCssClasses.divider property

**Signature:**

```typescript
divider?: string;
```
11 changes: 11 additions & 0 deletions docs/search-ui-react.generativedirectanswercssclasses.header.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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) &gt; [header](./search-ui-react.generativedirectanswercssclasses.header.md)

## GenerativeDirectAnswerCssClasses.header property

**Signature:**

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

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md)

## GenerativeDirectAnswerCssClasses interface

The CSS class interface used for [GenerativeDirectAnswer()](./search-ui-react.generativedirectanswer.md)<!-- -->.

**Signature:**

```typescript
interface GenerativeDirectAnswerCssClasses
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [answerText?](./search-ui-react.generativedirectanswercssclasses.answertext.md) | | string | _(Optional)_ |
| [citation?](./search-ui-react.generativedirectanswercssclasses.citation.md) | | string | _(Optional)_ |
| [citationsContainer?](./search-ui-react.generativedirectanswercssclasses.citationscontainer.md) | | string | _(Optional)_ |
| [citationSnippet?](./search-ui-react.generativedirectanswercssclasses.citationsnippet.md) | | string | _(Optional)_ |
| [citationTitle?](./search-ui-react.generativedirectanswercssclasses.citationtitle.md) | | string | _(Optional)_ |
| [container?](./search-ui-react.generativedirectanswercssclasses.container.md) | | string | _(Optional)_ |
| [divider?](./search-ui-react.generativedirectanswercssclasses.divider.md) | | string | _(Optional)_ |
| [header?](./search-ui-react.generativedirectanswercssclasses.header.md) | | string | _(Optional)_ |

13 changes: 13 additions & 0 deletions docs/search-ui-react.generativedirectanswerprops.answerheader.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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerProps](./search-ui-react.generativedirectanswerprops.md) &gt; [answerHeader](./search-ui-react.generativedirectanswerprops.answerheader.md)

## GenerativeDirectAnswerProps.answerHeader property

The header for the answer section of the generative direct answer.

**Signature:**

```typescript
answerHeader?: string | JSX.Element;
```
13 changes: 13 additions & 0 deletions docs/search-ui-react.generativedirectanswerprops.citationcard.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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerProps](./search-ui-react.generativedirectanswerprops.md) &gt; [CitationCard](./search-ui-react.generativedirectanswerprops.citationcard.md)

## GenerativeDirectAnswerProps.CitationCard property

The component for citation card

**Signature:**

```typescript
CitationCard?: (props: CitationProps) => JSX.Element | null;
```
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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerProps](./search-ui-react.generativedirectanswerprops.md) &gt; [CitationsContainer](./search-ui-react.generativedirectanswerprops.citationscontainer.md)

## GenerativeDirectAnswerProps.CitationsContainer property

The component for citations container

**Signature:**

```typescript
CitationsContainer?: (props: CitationsProps) => JSX.Element | null;
```
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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerProps](./search-ui-react.generativedirectanswerprops.md) &gt; [citationsHeader](./search-ui-react.generativedirectanswerprops.citationsheader.md)

## GenerativeDirectAnswerProps.citationsHeader property

The header for the citations section of the generative direct answer.

**Signature:**

```typescript
citationsHeader?: string | JSX.Element;
```
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-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerProps](./search-ui-react.generativedirectanswerprops.md) &gt; [customCssClasses](./search-ui-react.generativedirectanswerprops.customcssclasses.md)

## GenerativeDirectAnswerProps.customCssClasses property

CSS classes for customizing the component styling.

**Signature:**

```typescript
customCssClasses?: GenerativeDirectAnswerCssClasses;
```
Loading

0 comments on commit d995a3e

Please sign in to comment.