Skip to main content

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

GenerateSearchAnswerCommand class​

Query a knowledge base by its ID and return the answer from the LLM

Signature:

export declare class GenerateSearchAnswerCommand extends GenerateSearchAnswerCommand_base

Extends: GenerateSearchAnswerCommand_base

Example​

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

import { KnowledgeBaseClient, GenerateSearchAnswerCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
// const { KnowledgeBaseClient, GenerateSearchAnswerCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
const client = new KnowledgeBaseClient(config);
const input = { // GenerateSearchAnswerInput
  companyId: "STRING_VALUE",
  searchQuery: "STRING_VALUE", // required
  searchResults: [ // SearchKnowledgeBaseResultsList // required
    { // SearchKnowledgeBaseResultItem
      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", // required
      metadata: "DOCUMENT_VALUE",
    },
  ],
  model: "STRING_VALUE",
  temperature: Number("double"),
  maxOutputTokens: Number("int"),
  systemPrompt: "STRING_VALUE",
};
const command = new GenerateSearchAnswerCommand(input);
const response = await client.send(command);
// { // GenerateSearchAnswerOutput
//   answer: "STRING_VALUE", // required
//   metadata: { // AnswerMetadata
//     model: "STRING_VALUE", // required
//     inputTokens: Number("int"), // required
//     outputTokens: Number("int"), // required
//     duration: Number("int"), // required
//   },
//   sources: [ // SearchKnowledgeBaseResultsList // required
//     { // SearchKnowledgeBaseResultItem
//       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", // required
//       metadata: "DOCUMENT_VALUE",
//     },
//   ],
// };