@docsearch/react 4.1.0 → 4.2.0

package/dist/esm/DocSearchModal.d.ts

@@ -115,6 +115,13 @@ type DocSearchTransformClient = {
     addAlgoliaAgent: LiteClient['addAlgoliaAgent'];
     transporter: Pick<LiteClient['transporter'], 'algoliaAgent'>;
 };
+type AskAiSearchParameters = {
+    facetFilters?: string[];
+    filters?: string;
+    attributesToRetrieve?: string[];
+    restrictSearchableAttributes?: string[];
+    distinct?: boolean;
+};
 type DocSearchAskAi = {
     /**
      * The index name to use for the ask AI feature. Your assistant will search this index for relevant documents.
@@ -138,9 +145,7 @@ type DocSearchAskAi = {
     /**
      * The search parameters to use for the ask AI feature.
      */
-    searchParameters?: {
-        facetFilters?: SearchParamsObject['facetFilters'];
-    };
+    searchParameters?: AskAiSearchParameters;
 };
 interface DocSearchIndex {
     name: string;
@@ -271,6 +276,11 @@ type FooterTranslations = Partial<{
     poweredByText: string;
 }>;
 
+type NewConversationTranslations = Partial<{
+    newConversationTitle: string;
+    newConversationDescription: string;
+}>;
+
 type AskAiScreenTranslations = Partial<{
     disclaimerText: string;
     relatedSourcesText: string;
@@ -300,6 +310,10 @@ type AskAiScreenTranslations = Partial<{
         lastSeparator?: string;
         after?: string;
     };
+    /**
+     * Message that's shown when user has stopped the streaming of a message.
+     */
+    stoppedStreamingText: string;
 }>;
 
 type ErrorScreenTranslations = Partial<{
@@ -316,6 +330,7 @@ type NoResultsScreenTranslations = Partial<{
 
 type ResultsScreenTranslations = Partial<{
     askAiPlaceholder: string;
+    noResultsAskAiPlaceholder: string;
 }>;
 
 type StartScreenTranslations = Partial<{
@@ -335,6 +350,7 @@ type ScreenStateTranslations = Partial<{
     noResultsScreen: NoResultsScreenTranslations;
     resultsScreen: ResultsScreenTranslations;
     askAiScreen: AskAiScreenTranslations;
+    newConversation: NewConversationTranslations;
 }>;
 
 type SearchBoxTranslations = Partial<{
@@ -350,10 +366,15 @@ type SearchBoxTranslations = Partial<{
     searchInputLabel: string;
     backToKeywordSearchButtonText: string;
     backToKeywordSearchButtonAriaLabel: string;
+    newConversationPlaceholder: string;
+    conversationHistoryTitle: string;
+    startNewConversationText: string;
+    viewConversationHistoryText: string;
 }>;
 
 type ModalTranslations = Partial<{
     searchBox: SearchBoxTranslations;
+    newConversation: NewConversationTranslations;
     footer: FooterTranslations;
 }> & ScreenStateTranslations;
 type DocSearchModalProps = DocSearchProps & {