-
Notifications
You must be signed in to change notification settings - Fork 5
/
use-search.ts
73 lines (67 loc) · 1.92 KB
/
use-search.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
import { useContext, useEffect, useState } from 'react';
import { DoptAiContext } from './context';
import {
AnswerChunk,
AssistantSearchRequestBody,
} from '@dopt/ai-assistant-definition';
import { AssistantContextProps } from '@dopt/ai-assistant-javascript';
/**
* A React hook for getting search results from an AI assistant
*
* @example
* ```tsx
* import { useSearch } from '@dopt/ai-assistant-react';
*
* export function Application() {
* const results = useSearch("HNWvcT78tyTwygnbzU6SW", { query, context });
* }
* ```
* @param sid - {@link Assistant['sid']}
* @param query - string, the query to be passed to the assistant
* @param context.document - boolean, whether to use page level context like title and URL (default false)
* @param context.element - the element the user is interacting with (default undefined)
* @param context.visual - boolean, whether to use a screenshot of the page (default false)
* this param accepts the user defined identifier (sid)
*
* @returns a collection of `documents`
*/
export function useSearch(
sid: string,
{
query,
context: { document, element, visual },
}: {
query: AssistantSearchRequestBody['query'];
context: {
document?: AssistantContextProps['document'];
element?: AssistantContextProps['element'];
visual?: AssistantContextProps['visual'];
};
}
) {
const { assistant } = useContext(DoptAiContext);
const [documents, setDocuments] = useState<AnswerChunk['sources'] | null>(
null
);
useEffect(() => {
if (!query) {
return;
}
setDocuments(null);
(async () => {
const results = await assistant.search(sid, {
query,
context: {
document,
element,
semantic: element != null,
visual,
},
});
setDocuments(results || []);
})();
}, [assistant, document, element, visual, query, sid]);
return {
documents,
};
}