prompt_name (#57)

* updated various configs
added prompt_name to configuration

* minor updates

* minor updates

README.md

@@ -186,13 +186,18 @@ The way summarization works can be configured as follows:
 ux: "summary"
 
 # Default language for summary response (if not specified defaults to "auto")
-summary_default_language: "en"
+summary_default_language: "eng"
 
 # Number of sentences before and after relevant text segment used for summarization
 summary_num_sentences: 3
 
 # Number of results used for summarization
 summary_num_results: 10
+
+# The name of the summarization prompt in Vectara
+# If you are a Vectara scale customer you can use custom prompts.
+# This field names a custom prompt, otherwise it uses the default for the account.
+summary_prompt_name: vectara-summary-ext-v1.2.0
 ```
 
 #### Reranking (optional)

docker/server/index.js

@@ -62,6 +62,7 @@ app.post("/config", (req, res) => {
     summary_default_language,
     summary_num_results,
     summary_num_sentences,
+    summary_prompt_name,
 
     // rerank
     rerank,
@@ -114,6 +115,7 @@ app.post("/config", (req, res) => {
     summary_default_language,
     summary_num_results,
     summary_num_sentences,
+    summary_prompt_name,
 
     // rerank
     rerank,

package.json

@@ -12,8 +12,8 @@
     "@types/lodash": "^4.14.195",
     "@types/node": "^16.18.12",
     "@types/prismjs": "^1.26.0",
-    "@types/react": "^18.0.28",
-    "@types/react-dom": "^18.0.11",
+    "@types/react": "^18.2.21",
+    "@types/react-dom": "^18.2.7",
     "axios": "^0.27.2",
     "classnames": "^2.3.2",
     "dotenv": "^16.0.3",
@@ -43,8 +43,7 @@
     "inline-source-cli": "^2.0.0",
     "prettier": "2.8.3",
     "pretty-quick": "^3.1.3",
-    "sass": "^1.58.0",
-    "typescript": "^4.9.5"
+    "sass": "^1.58.0"
   },
   "scripts": {
     "start": "PORT=4444 react-scripts start",

server/index.js

@@ -61,6 +61,7 @@ app.post("/config", (req, res) => {
     summary_default_language,
     summary_num_results,
     summary_num_sentences,
+    summary_prompt_name,
 
     // rerank
     rerank,
@@ -113,6 +114,7 @@ app.post("/config", (req, res) => {
     summary_default_language,
     summary_num_results,
     summary_num_sentences,
+    summary_prompt_name,
 
     // rerank
     rerank,

src/contexts/ConfigurationContext.tsx

@@ -59,6 +59,7 @@ interface Config {
   config_summary_default_language?: string;
   config_summary_num_results?: number;
   config_summary_num_sentences?: number;
+  config_summary_prompt_name?: string
 
   // rerank
   config_rerank?: string;
@@ -107,6 +108,7 @@ type Summary = {
   defaultLanguage: string;
   summaryNumResults: number;
   summaryNumSentences: number;
+  summaryPromptName: string;
 };
 
 type SearchHeader = {
@@ -242,6 +244,7 @@ export const ConfigContextProvider = ({ children }: Props) => {
     defaultLanguage: "auto",
     summaryNumResults: 7,
     summaryNumSentences: 3,
+    summaryPromptName: "vectara-summary-ext-v1.2.0",
   });
 
   useEffect(() => {
@@ -328,6 +331,7 @@ export const ConfigContextProvider = ({ children }: Props) => {
         config_summary_default_language,
         config_summary_num_results,
         config_summary_num_sentences,
+        config_summary_prompt_name,
       } = config;
 
       setSearch({
@@ -391,6 +395,7 @@ export const ConfigContextProvider = ({ children }: Props) => {
         ),
         summaryNumResults: config_summary_num_results ?? 7,
         summaryNumSentences: config_summary_num_sentences ?? 3,
+        summaryPromptName: config_summary_prompt_name ?? "vectara-summary-ext-v1.2.0",
       });
 
       setSearchHeader({

src/contexts/SearchContext.tsx

@@ -50,6 +50,7 @@ interface SearchContextType {
   language: SummaryLanguage;
   summaryNumResults: number;
   summaryNumSentences: number;
+  summaryPromptName: string;
   history: HistoryItem[];
   clearHistory: () => void;
   searchResultsRef: React.MutableRefObject<HTMLElement[] | null[]>;
@@ -238,6 +239,7 @@ export const SearchContextProvider = ({ children }: Props) => {
             rerankNumResults: rerank.numResults,
             summaryNumResults: summary.summaryNumResults,
             summaryNumSentences: summary.summaryNumSentences,
+            summaryPromptName: summary.summaryPromptName,
             language,
             customerId: search.customerId!,
             corpusId: search.corpusId!,
@@ -293,6 +295,7 @@ export const SearchContextProvider = ({ children }: Props) => {
         language: getLanguage(),
         summaryNumResults: summary.summaryNumResults,
         summaryNumSentences: summary.summaryNumSentences,
+        summaryPromptName: summary.summaryPromptName,
         history,
         clearHistory,
         searchResultsRef,

src/contexts/sendSearchRequest.ts

@@ -11,6 +11,7 @@ type Config = {
   rerankNumResults?: number;
   summaryNumResults?: number;
   summaryNumSentences?: number;
+  summaryPromptName?: string;
   customerId: string;
   corpusId: string;
   endpoint: string;
@@ -26,14 +27,15 @@ export const sendSearchRequest = async ({
   rerankNumResults,
   summaryNumResults,
   summaryNumSentences,
+  summaryPromptName,
   customerId,
   corpusId,
   endpoint,
   apiKey,
 }: Config) => {
   const lambda =
-    typeof query_str === "undefined" || query_str.trim().split(" ").length > 1
-      ? 0.025
+    typeof query_str === "undefined" || query_str.trim().split(" ").length > 2
+      ? 0
       : 0.1;
   const corpusKeyList = corpusId.split(",").map((id) => {
     return {
@@ -65,6 +67,7 @@ export const sendSearchRequest = async ({
                 {
                   responseLang: language,
                   maxSummarizedResults: summaryNumResults,
+                  summarizer_prompt_name: summaryPromptName,
                 },
               ],
             }
@@ -120,6 +123,13 @@ export const sendSearchRequest = async ({
     ) {
       throw new Error(`BAD REQUEST: Too much text for the summarizer to summarize. Please try reducing the number of search results to summarize, or the context of each result by adjusting the 'summary_num_sentences', and 'summary_num_results' parameters respectively.`);
     }
+    if (
+      summaryStatus.length > 0 &&
+      summaryStatus[0]["code"] === "NOT_FOUND" &&
+      summaryStatus[0]["statusDetail"] === "Failed to retrieve summarizer."
+    ) {
+      throw new Error(`BAD REQUEST: summarizer ${summaryPromptName} is invalid for this account.`);
+    }
   }
 
   return result["data"]["responseSet"][0];

src/views/search/types.ts

@@ -79,6 +79,18 @@ export const SUMMARY_LANGUAGES = [
   "jpn",
   "pol",
   "tur",
+  "heb",
+  "vie",
+  "ind",
+  "ces",
+  "ukr",
+  "ell",
+  "fas",
+  "hin",
+  "urd",
+  "swe",
+  "ben",
+  "msa",
 ] as const;
 
 export type SummaryLanguage = (typeof SUMMARY_LANGUAGES)[number];
@@ -100,6 +112,18 @@ const codeToLanguageMap: Record<SummaryLanguage, string> = {
   jpn: "Japanese",
   pol: "Polish",
   tur: "Turkish",
+  heb: "Hebrew",
+  vie: "Vietnamese",
+  ind: "Indonesian",
+  ces: "Czech",
+  ukr: "Ukrainian",
+  ell: "Greek",
+  fas: "Farsi",
+  hin: "Hindi",
+  urd: "Urdu",
+  swe: "Swedish",
+  ben: "Bengali",
+  msa: "Malay",
 } as const;
 
 export const humanizeLanguage = (language: SummaryLanguage): string => {