Skip to main content

@wildix/wim-knowledge-base-client > ListSearchQueriesHistoryCommand

ListSearchQueriesHistoryCommand class​

You can use this endpoint to retrieve the search history.

Signature:

export declare class ListSearchQueriesHistoryCommand extends ListSearchQueriesHistoryCommand_base

Extends: ListSearchQueriesHistoryCommand_base

Example​

Use a bare-bones client and the command you need to make an API call.

import { KnowledgeBaseClient, ListSearchQueriesHistoryCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
// const { KnowledgeBaseClient, ListSearchQueriesHistoryCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
const client = new KnowledgeBaseClient(config);
const input = { // ListSearchQueriesHistoryInput
  companyId: "STRING_VALUE",
  limit: Number("int"),
  offset: Number("int"),
  sort: "STRING_VALUE",
  filter: { // SearchHistoryFilter
    knowledgeBaseId: "STRING_VALUE",
    dataSourceId: "STRING_VALUE",
    sessionId: "STRING_VALUE",
    sessionUri: "STRING_VALUE",
    sessionUser: "STRING_VALUE",
    withEmptyResults: true || false,
  },
  search: "STRING_VALUE",
  withContent: true || false,
};
const command = new ListSearchQueriesHistoryCommand(input);
const response = await client.send(command);
// { // ListSearchQueriesHistoryOutput
//   history: [ // SearchHistoryList // required
//     { // SearchHistoryItem
//       sessionId: "STRING_VALUE", // required
//       companyId: "STRING_VALUE", // required
//       request: { // SearchHistoryRequest
//         query: "STRING_VALUE", // required
//         sessionUser: "STRING_VALUE", // required
//         sessionUri: "STRING_VALUE", // required
//         knowledgeBaseId: "STRING_VALUE", // required
//         searchStrategy: "bm25" || "vector" || "hybrid", // required
//         searchLimit: Number("int"), // required
//         searchThreshold: Number("double"), // required
//       },
//       stages: { // SearchHistoryStages
//         overall: { // SearchHistoryOverallStage
//           startTime: Number("long"), // required
//           endTime: Number("long"), // required
//           duration: Number("int"), // required
//         },
//         transformQuery: { // SearchHistoryTransformQueryStage
//           startTime: Number("long"), // required
//           endTime: Number("long"), // required
//           duration: Number("int"), // required
//           model: "STRING_VALUE", // required
//           inputTokens: Number("int"), // required
//           outputTokens: Number("int"), // required
//           transformedQuery: "STRING_VALUE", // required
//         },
//         generateQueryEmbedding: { // SearchHistoryEmbeddingStage
//           startTime: Number("long"), // required
//           endTime: Number("long"), // required
//           duration: Number("int"), // required
//           model: "STRING_VALUE", // required
//           inputTokens: Number("int"), // required
//           outputTokens: Number("int"), // required
//         },
//         search: { // SearchHistorySearchStage
//           startTime: Number("long"), // required
//           endTime: Number("long"), // required
//           duration: Number("int"), // required
//         },
//         enrichData: { // SearchEnrichDataStage
//           startTime: Number("long"), // required
//           endTime: Number("long"), // required
//           duration: Number("int"), // required
//         },
//       },
//       results: [ // SearchHistoryResultsList // required
//         { // SearchHistoryResultItem
//           chunkId: "STRING_VALUE", // required
//           documentId: "STRING_VALUE", // required
//           documentTitle: "STRING_VALUE", // required
//           documentUrl: "STRING_VALUE", // required
//           dataSourceId: "STRING_VALUE", // required
//           dataSourceType: "files" || "confluence" || "gdrive", // required
//           score: Number("double"), // required
//           fullTextScore: Number("double"),
//           semanticScore: Number("double"),
//           documentHierarchy: [ // StringList
//             "STRING_VALUE",
//           ],
//           content: "STRING_VALUE",
//         },
//       ],
//       createdAt: "STRING_VALUE", // required
//       totalDuration: Number("int"), // required
//       resultsCount: Number("int"), // required
//     },
//   ],
//   metadata: { // PaginationMetadata
//     total: Number("int"), // required
//     limit: Number("int"),
//     offset: Number("int"),
//   },
// };