Merge pull request #81 from AddSearch/sc-11492/conversational-search-to-be-named-as-ai-answers

[sc-11492] refactor: "conversational search" to become "ai answers"

Author: haoAddsearch

README.md

@@ -500,6 +500,38 @@ function callback(configurationObject) {
 client.setApiRequestInterceptor(callback, option);
 ```
 
+## AI Answers API
+
+#### Fetch AI answers
+
+```js
+// Get AI generated answer with a question
+client.aiAnswers('A question to get AI generated answers', callback);
+```
+
+Example of callback function and how the response looks like:
+```js
+callbackFn = function (response) {
+  
+  console.log(response);
+  
+  // response object contains the answer
+  // {
+  //   "answer": "The answer to the question",
+  //   "conversation_id": "31f33b53-1fe1-4734-884f-fefa470f1389",
+  //   "ids": <array of ids belonging to source documents>, for example ['073010f023db7c6d558123f73a9b4f82', '821f7bea12daf0eda17ba2755979f7a5'],
+  //   "source_documents": <documents that provide context for AI generated answers, the object of this field looks similarly to the response of regular SearchApi result>
+  // }
+};
+````
+
+#### Send Sentiment Analysis
+
+```js
+// possible sentiment_value: positive, negative
+client.putSentimentClick('conversation_id', 'sentiment_value');
+```
+
 ## Indexing API
 
 With the Indexing API, you can fetch, create, update, and delete single documents or batches of

src/conversational-search-interactions-api.ts renamed to src/ai-answers-interactions-api.ts

@@ -1,7 +1,7 @@
 'use strict';
 
 import 'es6-promise/auto';
-import { RESPONSE_SERVER_ERROR, conversationalSearchInteractionsInstance } from './api';
+import { RESPONSE_SERVER_ERROR, aiAnswersInteractionsInstance } from './api';
 
 const putSentimentClick = (
   apiHostname: string,
@@ -10,7 +10,7 @@ const putSentimentClick = (
   sentimentValue: 'positive' | 'negative' | 'neutral'
 ): Promise<boolean> => {
   return new Promise((resolve, reject) => {
-    conversationalSearchInteractionsInstance
+    aiAnswersInteractionsInstance
       .put(`https://${apiHostname}/v2/indices/${sitekey}/conversations/${conversationId}/rating`, {
         value: sentimentValue === 'positive' ? 1 : sentimentValue === 'negative' ? -1 : 0
       })

src/api.ts

@@ -2,7 +2,7 @@ import axios, { AxiosInstance, InternalAxiosRequestConfig } from 'axios';
 
 const apiInstance: AxiosInstance = axios.create();
 const statsInstance: AxiosInstance = axios.create();
-const conversationalSearchInteractionsInstance: AxiosInstance = axios.create();
+const aiAnswersInteractionsInstance: AxiosInstance = axios.create();
 
 const RESPONSE_BAD_REQUEST = 400;
 const RESPONSE_SERVER_ERROR = 500;
@@ -38,7 +38,7 @@ const setRequestInterceptor = (
 export {
   apiInstance,
   statsInstance,
-  conversationalSearchInteractionsInstance,
+  aiAnswersInteractionsInstance,
   setRequestInterceptor,
   RESPONSE_BAD_REQUEST,
   RESPONSE_SERVER_ERROR

src/apifetch.ts

@@ -108,7 +108,7 @@ const executeApiFetch: ExecuteApiFetch = function (
   // Validate query type
   if (
     type !== 'search' &&
-    type !== 'conversational-search' &&
+    type !== 'ai-answers' &&
     type !== 'suggest' &&
     type !== 'autocomplete' &&
     type !== 'recommend'
@@ -259,8 +259,8 @@ const executeApiFetch: ExecuteApiFetch = function (
       queryParamsString;
   }
 
-  // Conversational Search
-  else if (type === 'conversational-search') {
+  // Ai Answers
+  else if (type === 'ai-answers') {
     // TODO use apiHostname instead of hardcoded URL
     apiInstance
       .post(`https://api.addsearch.com/v2/indices/${sitekey}/conversations`, {
@@ -273,7 +273,7 @@ const executeApiFetch: ExecuteApiFetch = function (
           cb({
             error: {
               response: RESPONSE_SERVER_ERROR,
-              message: 'Could not get conversational search response in the expected data format'
+              message: 'Could not get ai-answers response in the expected data format'
             }
           });
         }
@@ -347,7 +347,7 @@ const executeApiFetch: ExecuteApiFetch = function (
     apiEndpoint = 'https://' + apiHostname + '/v1/' + apiPath;
   }
 
-  if (type !== 'conversational-search') {
+  if (type !== 'ai-answers') {
     apiInstance
       .get(apiEndpoint as string)
       .then(function (response: AxiosResponse<GenericApiResponse>) {

src/index.ts

@@ -11,7 +11,7 @@ import {
   deleteDocument
 } from './indexingapi';
 import sendStats from './stats';
-import { putSentimentClick } from './conversational-search-interactions-api';
+import { putSentimentClick } from './ai-answers-interactions-api';
 import SettingsManager, {
   Settings,
   PersonalizationEvent,
@@ -66,7 +66,7 @@ class AddSearchClient {
   private userTokenInPersonalization: string;
   private useStatsSessionId = false;
   private throttledSearchFetch?: ExecuteApiFetch;
-  private throttledConversationalSearchFetch?: ExecuteApiFetch;
+  private throttledAiAnswersFetch?: ExecuteApiFetch;
   private throttledSuggestionsFetch?: ExecuteApiFetch;
   private throttledRecommendationFetch?: ExecuteApiFetch;
   private throttledAutocompleteFetch?: ExecuteApiFetch;
@@ -123,21 +123,21 @@ class AddSearchClient {
     );
   }
 
-  conversationalSearch(keyword: string, callback: ApiFetchCallback): void {
+  aiAnswers(keyword: string, callback: ApiFetchCallback): void {
     this.settings.setCallback(() => callback);
     this.settings.setKeyword(keyword);
 
-    if (!this.throttledConversationalSearchFetch) {
-      this.throttledConversationalSearchFetch = throttle(
+    if (!this.throttledAiAnswersFetch) {
+      this.throttledAiAnswersFetch = throttle(
         this.settings.getSettings().throttleTimeMs,
         executeApiFetch
       );
     }
 
-    this.throttledConversationalSearchFetch(
+    this.throttledAiAnswersFetch(
       this.apiHostname,
       this.sitekey,
-      'conversational-search',
+      'ai-answers',
       this.settings.getSettings(),
       callback
     );