Merge branch 'develop' into dev/merge-v1.7.1-19ad6ad-into-develop

docs/search-ui-react.citationprops.cssclasses.md

@@ -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;
+```

docs/search-ui-react.citationprops.md

@@ -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 |  |
+

docs/search-ui-react.citationprops.searchresult.md

@@ -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;
+```

docs/search-ui-react.citationsprops.citationcard.md

@@ -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;
+```

docs/search-ui-react.citationsprops.citationsheader.md

@@ -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;
+```

docs/search-ui-react.citationsprops.cssclasses.md

@@ -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;
+```

docs/search-ui-react.citationsprops.gdaresponse.md

@@ -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;
+```

docs/search-ui-react.citationsprops.md

@@ -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. |
+

docs/search-ui-react.citationsprops.searchresults.md

@@ -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[];
+```

docs/search-ui-react.executegenerativedirectanswer.md

@@ -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;
+

docs/search-ui-react.generativedirectanswer.md

@@ -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
+

docs/search-ui-react.generativedirectanswercssclasses.answertext.md

@@ -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;
+```

docs/search-ui-react.generativedirectanswercssclasses.citation.md

@@ -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;
+```

docs/search-ui-react.generativedirectanswercssclasses.citationscontainer.md

@@ -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;
+```

docs/search-ui-react.generativedirectanswercssclasses.citationsnippet.md

@@ -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;
+```

docs/search-ui-react.generativedirectanswercssclasses.citationtitle.md

@@ -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;
+```

docs/search-ui-react.generativedirectanswercssclasses.container.md

@@ -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;
+```

docs/search-ui-react.generativedirectanswercssclasses.divider.md

@@ -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;
+```

docs/search-ui-react.generativedirectanswercssclasses.header.md

@@ -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;
+```

docs/search-ui-react.generativedirectanswercssclasses.md

@@ -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)_ |
+

docs/search-ui-react.generativedirectanswerprops.answerheader.md

@@ -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;
+```

docs/search-ui-react.generativedirectanswerprops.citationcard.md

@@ -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 citation card component for customizing how each citation is displayed.
+
+**Signature:**
+
+```typescript
+CitationCard?: (props: CitationProps) => JSX.Element | null;
+```

docs/search-ui-react.generativedirectanswerprops.citationscontainer.md

@@ -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 citations container component for customizing the logic that determines which results can be rendered. By default, a section for citations is displayed if the results that correspond to the citations have the default minimum required info, which is `rawData.uid` and `rawData.name`<!-- -->.
+
+**Signature:**
+
+```typescript
+CitationsContainer?: (props: CitationsProps) => JSX.Element | null;
+```

docs/search-ui-react.generativedirectanswerprops.citationsheader.md

@@ -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;
+```

docs/search-ui-react.generativedirectanswerprops.customcssclasses.md

@@ -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;
+```