@docsearch/js 4.1.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8387,6 +8387,13 @@ type DocSearchTransformClient = {
8387
8387
  addAlgoliaAgent: LiteClient['addAlgoliaAgent'];
8388
8388
  transporter: Pick<LiteClient['transporter'], 'algoliaAgent'>;
8389
8389
  };
8390
+ type AskAiSearchParameters = {
8391
+ facetFilters?: string[];
8392
+ filters?: string;
8393
+ attributesToRetrieve?: string[];
8394
+ restrictSearchableAttributes?: string[];
8395
+ distinct?: boolean;
8396
+ };
8390
8397
  type DocSearchAskAi = {
8391
8398
  /**
8392
8399
  * The index name to use for the ask AI feature. Your assistant will search this index for relevant documents.
@@ -8410,9 +8417,7 @@ type DocSearchAskAi = {
8410
8417
  /**
8411
8418
  * The search parameters to use for the ask AI feature.
8412
8419
  */
8413
- searchParameters?: {
8414
- facetFilters?: SearchParamsObject['facetFilters'];
8415
- };
8420
+ searchParameters?: AskAiSearchParameters;
8416
8421
  };
8417
8422
  interface DocSearchIndex {
8418
8423
  name: string;
@@ -8548,6 +8553,11 @@ type FooterTranslations = Partial<{
8548
8553
  poweredByText: string;
8549
8554
  }>;
8550
8555
 
8556
+ type NewConversationTranslations = Partial<{
8557
+ newConversationTitle: string;
8558
+ newConversationDescription: string;
8559
+ }>;
8560
+
8551
8561
  type AskAiScreenTranslations = Partial<{
8552
8562
  disclaimerText: string;
8553
8563
  relatedSourcesText: string;
@@ -8577,6 +8587,10 @@ type AskAiScreenTranslations = Partial<{
8577
8587
  lastSeparator?: string;
8578
8588
  after?: string;
8579
8589
  };
8590
+ /**
8591
+ * Message that's shown when user has stopped the streaming of a message.
8592
+ */
8593
+ stoppedStreamingText: string;
8580
8594
  }>;
8581
8595
 
8582
8596
  type ErrorScreenTranslations = Partial<{
@@ -8593,6 +8607,7 @@ type NoResultsScreenTranslations = Partial<{
8593
8607
 
8594
8608
  type ResultsScreenTranslations = Partial<{
8595
8609
  askAiPlaceholder: string;
8610
+ noResultsAskAiPlaceholder: string;
8596
8611
  }>;
8597
8612
 
8598
8613
  type StartScreenTranslations = Partial<{
@@ -8612,6 +8627,7 @@ type ScreenStateTranslations = Partial<{
8612
8627
  noResultsScreen: NoResultsScreenTranslations;
8613
8628
  resultsScreen: ResultsScreenTranslations;
8614
8629
  askAiScreen: AskAiScreenTranslations;
8630
+ newConversation: NewConversationTranslations;
8615
8631
  }>;
8616
8632
 
8617
8633
  type SearchBoxTranslations = Partial<{
@@ -8627,10 +8643,15 @@ type SearchBoxTranslations = Partial<{
8627
8643
  searchInputLabel: string;
8628
8644
  backToKeywordSearchButtonText: string;
8629
8645
  backToKeywordSearchButtonAriaLabel: string;
8646
+ newConversationPlaceholder: string;
8647
+ conversationHistoryTitle: string;
8648
+ startNewConversationText: string;
8649
+ viewConversationHistoryText: string;
8630
8650
  }>;
8631
8651
 
8632
8652
  type ModalTranslations = Partial<{
8633
8653
  searchBox: SearchBoxTranslations;
8654
+ newConversation: NewConversationTranslations;
8634
8655
  footer: FooterTranslations;
8635
8656
  }> & ScreenStateTranslations;
8636
8657