Skip to content

Commit 9631f67

Browse files
tharropoulostharropoulos
committed
fix(example): fix example usage for typesense
1 parent 5602d25 commit 9631f67

15 files changed

Lines changed: 117 additions & 71 deletions

‎examples/demo-js/src/main.ts‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,18 @@ function logSidepanelState(instance: SidepanelInstance, label: string): void {
3030
});
3131
}
3232

33+
const typesenseServerConfig = {
34+
apiKey: 'xyz',
35+
nodes: [{ host: 'localhost', port: 8108, protocol: 'http' as const }],
36+
};
37+
3338
const sidepanelInstance = sidepanel({
3439
container: '#docsearch-sidepanel',
35-
indexName: 'docsearch',
36-
appId: 'PMZUYBQDAK',
37-
apiKey: '24b09689d5b4223813d9b8e48563c8f6',
38-
assistantId: 'askAIDemo',
40+
typesenseCollectionName: 'docsearch',
41+
typesenseServerConfig,
42+
askAi: {
43+
conversationModelId: 'askAIDemo',
44+
},
3945
onReady: () => {
4046
// eslint-disable-next-line no-console
4147
console.log('[demo-js] sidepanel onReady()');
@@ -65,10 +71,12 @@ logSidepanelState(sidepanelInstance, 'sidepanel initial state');
6571

6672
const docsearchInstance = docsearch({
6773
container: '#docsearch',
68-
indexName: 'docsearch',
69-
appId: 'PMZUYBQDAK',
70-
apiKey: '24b09689d5b4223813d9b8e48563c8f6',
71-
askAi: 'askAIDemo',
74+
typesenseCollectionName: 'docsearch',
75+
typesenseServerConfig,
76+
typesenseSearchParameters: {},
77+
askAi: {
78+
conversationModelId: 'askAIDemo',
79+
},
7280
interceptAskAiEvent: (initialMessage: InitialAskAiMessage) => {
7381
docsearchInstance.close();
7482
sidepanelInstance.open(initialMessage);

‎examples/demo-react/src/App.tsx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import MultiIndex from './examples/multi-index';
1818
import WHitComponent from './examples/w-hit-component';
1919
import WTransformItems from './examples/w-hit-transformItems';
2020
import WResultsFooter from './examples/w-results-footer';
21+
import { defaultAskAi, defaultCollection, typesenseServerConfig } from './config';
2122

2223
function App(): JSX.Element {
2324
return (
@@ -100,7 +101,7 @@ function App(): JSX.Element {
100101
</section>
101102

102103
<section className="demo-section">
103-
<p className="section-description">Agent Studio</p>
104+
<p className="section-description">Ask AI</p>
104105
<div className="search-wrapper column">
105106
<AgentStudioExample />
106107
</div>
@@ -109,12 +110,11 @@ function App(): JSX.Element {
109110
</div>
110111

111112
<DocSearchSidepanel
112-
assistantId="askAIDemo"
113-
indexName="docsearch"
114-
appId="PMZUYBQDAK"
115-
apiKey="24b09689d5b4223813d9b8e48563c8f6"
113+
typesenseServerConfig={typesenseServerConfig}
114+
typesenseCollectionName={defaultCollection}
115+
askAi={defaultAskAi}
116116
panel={{
117-
suggestedQuestions: true,
117+
suggestedQuestions: ["test suggestion"],
118118
}}
119119
/>
120120
</div>

‎examples/demo-react/src/config.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
export const typesenseServerConfig = {
2+
apiKey: 'xyz',
3+
nodes: [{ host: 'localhost', port: 8108, protocol: 'http' as const }],
4+
};
5+
6+
export const defaultCollection = 'docsearch';
7+
8+
export const defaultSearchParameters = {};
9+
10+
export const defaultAskAi = {
11+
conversationModelId: 'askAIDemo',
12+
};

‎examples/demo-react/src/examples/agent-studio.tsx‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import { SidepanelButton } from 'typesense-docsearch-sidepanel/button';
66
import { Sidepanel } from 'typesense-docsearch-sidepanel/sidepanel';
77
import type { JSX } from 'react';
88

9+
import { defaultAskAi, defaultCollection, defaultSearchParameters, typesenseServerConfig } from '../config';
10+
911
export function AgentStudioExample(): JSX.Element {
1012
return (
1113
<>
@@ -16,13 +18,10 @@ export function AgentStudioExample(): JSX.Element {
1618
}}
1719
/>
1820
<DocSearchModal
19-
indexName="docsearch"
20-
appId="PMZUYBQDAK"
21-
apiKey="a00716d83c64f6c61905c078b7d5ab66"
22-
askAi={{
23-
assistantId: 'ccdec697-e3fe-465b-a1c3-657e7bf18aef',
24-
agentStudio: true,
25-
}}
21+
typesenseCollectionName={defaultCollection}
22+
typesenseServerConfig={typesenseServerConfig}
23+
typesenseSearchParameters={defaultSearchParameters}
24+
askAi={defaultAskAi}
2625
/>
2726
</DocSearch>
2827

@@ -34,11 +33,9 @@ export function AgentStudioExample(): JSX.Element {
3433
}}
3534
/>
3635
<Sidepanel
37-
indexName="docsearch-markdown"
38-
appId="PMZUYBQDAK"
39-
apiKey="a00716d83c64f6c61905c078b7d5ab66"
40-
assistantId="ccdec697-e3fe-465b-a1c3-657e7bf18aef"
41-
agentStudio={true}
36+
typesenseCollectionName={defaultCollection}
37+
typesenseServerConfig={typesenseServerConfig}
38+
askAi={defaultAskAi}
4239
/>
4340
</DocSearch>
4441
</>

‎examples/demo-react/src/examples/basic-askai.tsx‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,20 @@
22
import { DocSearch } from 'typesense-docsearch-react';
33
import type { JSX } from 'react';
44

5+
import { defaultCollection, defaultSearchParameters, typesenseServerConfig } from '../config';
6+
57
export default function BasicAskAI(): JSX.Element {
68
return (
79
<DocSearch
8-
indexName="docsearch"
9-
appId="PMZUYBQDAK"
10-
apiKey="24b09689d5b4223813d9b8e48563c8f6"
10+
typesenseCollectionName={defaultCollection}
11+
typesenseServerConfig={typesenseServerConfig}
12+
typesenseSearchParameters={defaultSearchParameters}
1113
askAi={{
12-
assistantId: 'askAIDemo',
14+
conversationModelId: 'askAIDemo',
1315
searchParameters: {
14-
facetFilters: ['language:en'],
16+
filter_by: 'language:en',
1517
},
16-
suggestedQuestions: true,
18+
suggestedQuestions: ["test"],
1719
}}
1820
insights={true}
1921
translations={{ button: { buttonText: 'Search with Ask AI' } }}

‎examples/demo-react/src/examples/basic.tsx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
import { DocSearch } from 'typesense-docsearch-react';
33
import type { JSX } from 'react';
44

5+
import { defaultCollection, defaultSearchParameters, typesenseServerConfig } from '../config';
6+
57
export default function Basic(): JSX.Element {
68
return (
79
<DocSearch
8-
indexName="docsearch"
9-
appId="PMZUYBQDAK"
10-
apiKey="24b09689d5b4223813d9b8e48563c8f6"
10+
typesenseCollectionName={defaultCollection}
11+
typesenseServerConfig={typesenseServerConfig}
12+
typesenseSearchParameters={defaultSearchParameters}
1113
translations={{ button: { buttonText: 'Keyword search' } }}
1214
insights={true}
1315
/>

‎examples/demo-react/src/examples/composable.tsx‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,20 @@ import { DocSearch } from 'typesense-docsearch-core';
33
import { DocSearchButton, DocSearchModal } from 'typesense-docsearch-modal';
44
import { type JSX } from 'react';
55

6+
import { defaultCollection, defaultSearchParameters, typesenseServerConfig } from '../config';
7+
68
export default function Composable(): JSX.Element {
79
return (
810
<DocSearch>
911
<DocSearchButton translations={{ buttonText: 'Composable API' }} />
1012
<DocSearchModal
11-
indexName="docsearch"
12-
appId="PMZUYBQDAK"
13-
apiKey="24b09689d5b4223813d9b8e48563c8f6"
13+
typesenseCollectionName={defaultCollection}
14+
typesenseServerConfig={typesenseServerConfig}
15+
typesenseSearchParameters={defaultSearchParameters}
1416
askAi={{
15-
assistantId: 'askAIDemo',
17+
conversationModelId: 'askAIDemo',
1618
searchParameters: {
17-
facetFilters: ['language:en'],
19+
filter_by: 'language:en',
1820
},
1921
}}
2022
/>

‎examples/demo-react/src/examples/default.tsx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22
import { DocSearch } from 'typesense-docsearch-react';
33
import type { JSX } from 'react';
44

5+
import { defaultCollection, defaultSearchParameters, typesenseServerConfig } from '../config';
6+
57
export default function DefaultExperience(): JSX.Element {
6-
return <DocSearch indexName="docsearch" appId="PMZUYBQDAK" apiKey="24b09689d5b4223813d9b8e48563c8f6" />;
8+
return (
9+
<DocSearch
10+
typesenseCollectionName={defaultCollection}
11+
typesenseServerConfig={typesenseServerConfig}
12+
typesenseSearchParameters={defaultSearchParameters}
13+
/>
14+
);
715
}

‎examples/demo-react/src/examples/dynamic-import-modal.tsx‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ import type { DocSearchModal as DocSearchModalType } from 'typesense-docsearch-r
55
import { useCallback, useRef, useState, type JSX } from 'react';
66
import { createPortal } from 'react-dom';
77

8+
import { defaultCollection, defaultSearchParameters, typesenseServerConfig } from '../config';
9+
810
let DocSearchModal: typeof DocSearchModalType | null = null;
911

1012
function importDocSearchModalIfNeeded(): Promise<void> {
@@ -87,13 +89,13 @@ function DocSearch(): JSX.Element {
8789
searchContainer.current &&
8890
createPortal(
8991
<DocSearchModal
90-
indexName="docsearch"
91-
appId="PMZUYBQDAK"
92-
apiKey="24b09689d5b4223813d9b8e48563c8f6"
92+
typesenseCollectionName={defaultCollection}
93+
typesenseServerConfig={typesenseServerConfig}
94+
typesenseSearchParameters={defaultSearchParameters}
9395
askAi={{
94-
assistantId: 'askAIDemo',
96+
conversationModelId: 'askAIDemo',
9597
searchParameters: {
96-
facetFilters: ['language:en'],
98+
filter_by: 'language:en',
9799
},
98100
}}
99101
initialScrollY={window.scrollY}

‎examples/demo-react/src/examples/hybrid.tsx‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,29 @@ import { DocSearchButton, DocSearchModal } from 'typesense-docsearch-modal';
44
import { Sidepanel, SidepanelButton } from 'typesense-docsearch-sidepanel';
55
import type { JSX } from 'react';
66

7+
import { defaultSearchParameters, typesenseServerConfig } from '../config';
8+
79
export default function BasicHybrid(): JSX.Element {
810
return (
911
<DocSearch>
1012
<DocSearchButton />
1113
<DocSearchModal
12-
indexName="docsearch"
13-
appId="beta3G7FSQDJR3"
14-
apiKey="0faad3eae2ba413c16355a0f8670c201"
14+
typesenseCollectionName="docsearch"
15+
typesenseServerConfig={typesenseServerConfig}
16+
typesenseSearchParameters={defaultSearchParameters}
1517
askAi={{
16-
assistantId: 'e3Kl4lTCBlSA',
17-
indexName: 'docsearch-markdown',
18+
conversationModelId: 'e3Kl4lTCBlSA',
19+
collection: 'docsearch-markdown',
1820
}}
1921
/>
2022

2123
<SidepanelButton />
2224
<Sidepanel
23-
indexName="docsearch-markdown"
24-
appId="beta3G7FSQDJR3"
25-
apiKey="0faad3eae2ba413c16355a0f8670c201"
26-
assistantId="e3Kl4lTCBlSA"
25+
typesenseCollectionName="docsearch-markdown"
26+
typesenseServerConfig={typesenseServerConfig}
27+
askAi={{
28+
conversationModelId: 'e3Kl4lTCBlSA',
29+
}}
2730
/>
2831
</DocSearch>
2932
);

0 commit comments

Comments
 (0)