updated README and removed unused code (#54)

* updated README and removed unused code * fixed corpus key bug
vectara · Jul 24, 2024 · 43f01d6 · 43f01d6
1 parent 86ef8d7
commit 43f01d6
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ import { ReactChatbot } from "@vectara/react-chatbot";
 
 <ReactChatbot
   customerId="CUSTOMER_ID"
-  corpusKeys={["CORPUS_KEY_1", "CORPUS_KEY_2", "CORPUS_KEY_N"]}
+  corpusKeys={"CORPUS_KEY_1,CORPUS_KEY_2,CORPUS_KEY_N"}
   apiKey="API_KEY"
   title="My Chatbot"
   placeholder="Chat with your AI assistant"
@@ -163,7 +163,7 @@ import { useChat } from "@vectara/react-chatbot/lib/useChat";
 const { sendMessage, activeMessage, messageHistory, isLoading, isStreamingResponse, hasError, startNewConversation } =
   useChat({
     customerId: "CUSTOMER_ID",
-    corpusIds: ["CORPUS_ID_1", "CORPUS_ID_2", "CORPUS_ID_N"],
+    corpusKeys: "CORPUS_ID_1,CORPUS_ID_2,CORPUS_ID_N",
     apiKey: "API_KEY",
     enableStreaming: true, // Enable streaming, false otherwise. Defaults to true.
     language: "fra" // Response language. Defaults to "eng" for English. See our types for more information.
@@ -231,7 +231,7 @@ export const App = (props: Props): ReactNode => {
       setChatWidget(
         <ReactChatbot
           customerId="CUSTOMER_ID"
-          corpusKeys={["CORPUS_KEY_1", "CORPUS_KEY_2", "CORPUS_KEY_N"]}
+          corpusKeys={"CORPUS_KEY_1,CORPUS_KEY_2,CORPUS_KEY_N"}
           apiKey="API_KEY"
         />
       );

diff --git a/docs/src/components/ConfigurationDrawer.tsx b/docs/src/components/ConfigurationDrawer.tsx
@@ -120,7 +120,7 @@ export const ConfigurationDrawer = ({
 
       <VuiSpacer size="m" />
 
-      <VuiFormGroup label="Corpus Key" labelFor="corpusId">
+      <VuiFormGroup label="Corpus Key" labelFor="corpusKey">
         <VuiTextInput value={corpusKeys} onChange={onUpdateCorpusKeys} />
       </VuiFormGroup>
 

diff --git a/docs/src/index.tsx b/docs/src/index.tsx
@@ -115,7 +115,7 @@ const App = () => {
   const [placeholder, setPlaceholder] = useState<string>(DEFAULT_PLACEHOLDER);
   const [inputSize, setInputSize] = useState<"large" | "medium">("large");
   const [isStreamingEnabled, setIsStreamingEnabled] = useState<boolean>(true);
-  const [numberOfSearchResults, setNumberOfSearchResults] = useState<number>(15);
+  const [numberOfSearchResults, setNumberOfSearchResults] = useState<number>(10);
   const [language, setLanguage] = useState<SummaryLanguage>("eng");
   const [emptyStateJsx, setEmptyStateJsx] = useState<string>("");
   const [exampleQuestions, setExampleQuestions] = useState<string>("What is Vectara?, How does RAG work?");
@@ -308,7 +308,7 @@ export const App = () => {
     corpusKeys: DEFAULT_CORPUS_KEY,
     apiKey: DEFAULT_API_KEY,
     enableStreaming: true, // Enable streaming, false otherwise. Defaults to true.
-    numberOfSearchResults: 15, // Number of search results to use for summary.
+    numberOfSearchResults: 10, // Number of search results to use for summary.
     language: "fra" // Response language. Defaults to "eng" for English.
   });
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@vectara/react-chatbot",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "A Vectara-powered Chatbot component",
   "main": "lib/index.js",
   "module": "lib/index.js",

diff --git a/src/index.tsx b/src/index.tsx
@@ -69,7 +69,7 @@ class ReactChatbotWebComponent extends HTMLElement {
 
   public connectedCallback() {
     const customerId = this.getAttribute("customerId") ?? "";
-    const corpusKeys = (this.getAttribute("corpuskey") ?? "");
+    const corpusKeys = (this.getAttribute("corpuskeys") ?? "");
     const apiKey = this.getAttribute("apiKey") ?? "";
     const title = this.getAttribute("title") ?? undefined;
     const placeholder = this.getAttribute("placeholder") ?? undefined;
@@ -88,6 +88,7 @@ class ReactChatbotWebComponent extends HTMLElement {
     const enableStreaming =
         this.getAttribute("enableStreaming") !== null ? this.getAttribute("enableStreaming") == "true" : undefined;
 
+    console.log(corpusKeys)
     ReactDOM.render(
       <div>
         <ChatView
@@ -138,11 +139,7 @@ export const ReactChatbot = (props: Props) => {
   const typedProps = props as Record<string, any>;
   const updatedProps = Object.keys(props).reduce((acc: Record<string, string>, propName: string) => {
     if (propName === "emptyStateDisplay") return acc;
-    if (propName === "corpusIds") {
-      acc[propName] = typedProps["corpusIds"].join(" ");
-    } else {
-      acc[propName] = typedProps[propName];
-    }
+    acc[propName] = typedProps[propName];
 
     return acc;
   }, {});

diff --git a/src/types.ts b/src/types.ts
@@ -14,42 +14,6 @@ export type SearchResultWithSnippet = SearchResult & {
   };
 };
 
-
-
-export type DocMetadata = {
-  name: string;
-  value: string;
-};
-
-export type SearchResponse = {
-  document: SearchResponseDoc[];
-  response: SearchResponseResult[];
-  summary: SearchResponseSummary[];
-};
-
-type SearchResponseDoc = {
-  id: string;
-  metadata: DocMetadata[];
-};
-
-type SearchResponseResult = {
-  corpusKey: {
-    corpusId: string;
-    customerId: string;
-    dim: string[];
-  };
-  documentIndex: string;
-  resultLength: number;
-  resultOffset: number;
-  score: number;
-  text: string;
-};
-
-type SearchResponseSummary = {
-  text?: string;
-  status?: string;
-};
-
 export const SUMMARY_LANGUAGES = [
   "auto",
   "eng",