Merge main (v3.1.0) into develop

docs/search-ui-react.aisignposticon.md

@@ -0,0 +1,68 @@
+<!-- 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; [AISignpostIcon](./search-ui-react.aisignposticon.md)
+
+## AISignpostIcon() function
+
+Default icon for the AI signpost.
+
+**Signature:**
+
+```typescript
+declare function AISignpostIcon(input: {
+    className?: string;
+}): React.JSX.Element;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+{ className }
+
+
+</td><td>
+
+(not declared)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+input
+
+
+</td><td>
+
+{ className?: string; }
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+React.JSX.Element
+

docs/search-ui-react.aisignpostprops.icon.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; [AISignpostProps](./search-ui-react.aisignpostprops.md) &gt; [icon](./search-ui-react.aisignpostprops.icon.md)
+
+## AISignpostProps.icon property
+
+Icon displayed before the signpost label. Defaults to the SDK's AI signpost icon.
+
+**Signature:**
+
+```typescript
+icon?: React.JSX.Element;
+```

docs/search-ui-react.aisignpostprops.label.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; [AISignpostProps](./search-ui-react.aisignpostprops.md) &gt; [label](./search-ui-react.aisignpostprops.label.md)
+
+## AISignpostProps.label property
+
+Label displayed in the signpost button. Defaults to "AI-Generated".
+
+**Signature:**
+
+```typescript
+label?: string;
+```

docs/search-ui-react.aisignpostprops.md

@@ -0,0 +1,115 @@
+<!-- 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; [AISignpostProps](./search-ui-react.aisignpostprops.md)
+
+## AISignpostProps interface
+
+Props for the built-in AI signpost component.
+
+**Signature:**
+
+```typescript
+interface AISignpostProps 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[icon?](./search-ui-react.aisignpostprops.icon.md)
+
+
+</td><td>
+
+
+</td><td>
+
+React.JSX.Element
+
+
+</td><td>
+
+_(Optional)_ Icon displayed before the signpost label. Defaults to the SDK's AI signpost icon.
+
+
+</td></tr>
+<tr><td>
+
+[label?](./search-ui-react.aisignpostprops.label.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ Label displayed in the signpost button. Defaults to "AI-Generated".
+
+
+</td></tr>
+<tr><td>
+
+[popoverBody?](./search-ui-react.aisignpostprops.popoverbody.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ Body displayed in the signpost popover.
+
+
+</td></tr>
+<tr><td>
+
+[popoverHeader?](./search-ui-react.aisignpostprops.popoverheader.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ Header displayed in the signpost popover. Defaults to "AI-Generated Content".
+
+
+</td></tr>
+</tbody></table>
+

docs/search-ui-react.aisignpostprops.popoverbody.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; [AISignpostProps](./search-ui-react.aisignpostprops.md) &gt; [popoverBody](./search-ui-react.aisignpostprops.popoverbody.md)
+
+## AISignpostProps.popoverBody property
+
+Body displayed in the signpost popover.
+
+**Signature:**
+
+```typescript
+popoverBody?: string;
+```

docs/search-ui-react.aisignpostprops.popoverheader.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; [AISignpostProps](./search-ui-react.aisignpostprops.md) &gt; [popoverHeader](./search-ui-react.aisignpostprops.popoverheader.md)
+
+## AISignpostProps.popoverHeader property
+
+Header displayed in the signpost popover. Defaults to "AI-Generated Content".
+
+**Signature:**
+
+```typescript
+popoverHeader?: string;
+```

docs/search-ui-react.generativedirectanswer.md

@@ -32,7 +32,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-{ customCssClasses, answerHeader, citationsHeader, CitationCard, CitationsContainer, }
+{ customCssClasses, answerHeader, hideAISignpost, aiSignpostProps, citationsHeader, CitationCard, CitationsContainer, }
 
 
 </td><td>

docs/search-ui-react.generativedirectanswerprops.aisignpostprops.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; [aiSignpostProps](./search-ui-react.generativedirectanswerprops.aisignpostprops.md)
+
+## GenerativeDirectAnswerProps.aiSignpostProps property
+
+The props to pass to the AI signpost component.
+
+**Signature:**
+
+```typescript
+aiSignpostProps?: AISignpostProps;
+```

docs/search-ui-react.generativedirectanswerprops.hideaisignpost.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; [hideAISignpost](./search-ui-react.generativedirectanswerprops.hideaisignpost.md)
+
+## GenerativeDirectAnswerProps.hideAISignpost property
+
+Whether to hide the AI signpost for the generative direct answer.
+
+**Signature:**
+
+```typescript
+hideAISignpost?: boolean;
+```

docs/search-ui-react.generativedirectanswerprops.md

@@ -37,6 +37,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[aiSignpostProps?](./search-ui-react.generativedirectanswerprops.aisignpostprops.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[AISignpostProps](./search-ui-react.aisignpostprops.md)
+
+
+</td><td>
+
+_(Optional)_ The props to pass to the AI signpost component.
+
+
+</td></tr>
+<tr><td>
+
 [answerHeader?](./search-ui-react.generativedirectanswerprops.answerheader.md)
 
 
@@ -129,6 +148,25 @@ _(Optional)_ The header for the citations section of the generative direct answe
 _(Optional)_ CSS classes for customizing the component styling.
 
 
+</td></tr>
+<tr><td>
+
+[hideAISignpost?](./search-ui-react.generativedirectanswerprops.hideaisignpost.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to hide the AI signpost for the generative direct answer.
+
+
 </td></tr>
 </tbody></table>
 

docs/search-ui-react.md

@@ -19,6 +19,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[AISignpostIcon({ className }, input)](./search-ui-react.aisignposticon.md)
+
+
+</td><td>
+
+Default icon for the AI signpost.
+
+
+</td></tr>
+<tr><td>
+
 [AlternativeVerticals({ currentVerticalLabel, verticalConfigMap, displayAllOnNoResults, customCssClasses }, input)](./search-ui-react.alternativeverticals.md)
 
 
@@ -151,7 +162,7 @@ A component which allows a user to search for filters associated with specific e
 </td></tr>
 <tr><td>
 
-[GenerativeDirectAnswer({ customCssClasses, answerHeader, citationsHeader, CitationCard, CitationsContainer, }, input)](./search-ui-react.generativedirectanswer.md)
+[GenerativeDirectAnswer({ customCssClasses, answerHeader, hideAISignpost, aiSignpostProps, citationsHeader, CitationCard, CitationsContainer, }, input)](./search-ui-react.generativedirectanswer.md)
 
 
 </td><td>
@@ -504,6 +515,17 @@ Description
 The parameters that are passed into [FilterSearchProps.afterDropdownInputFocus](./search-ui-react.filtersearchprops.afterdropdowninputfocus.md)<!-- -->.
 
 
+</td></tr>
+<tr><td>
+
+[AISignpostProps](./search-ui-react.aisignpostprops.md)
+
+
+</td><td>
+
+Props for the built-in AI signpost component.
+
+
 </td></tr>
 <tr><td>