twe-knowledge-ask v0.0.10

twe-knowledge-ask

This package is part of the confiance.ai Knowledge Hub System. It provides a way to search for documents in the Knowledge Hub using a similarity search algorithm.

This package depends on the pinia. To install this package, you will need to follow the instructions on the pinia website: https://pinia.vuejs.org/ssr/nuxt.html

Install

npm install twe-knowledge-ask

Usage

import { reactive, useSimilaritySearch } from '#imports';

export type SimilaritySearchRequest = {
  maxItems: number;
  query: string;
  knowledgeHubURL: string;
};

const searchRequest = reactive<SimilaritySearchRequest>({
  maxItems: 5,
  query: '',
  knowledgeHubURL: 'http://localhost:8000',
});

const similaritySearchStore = useSimilaritySearch();

const submitSearch = () => {
  if (!searchRequest.maxItems || !searchRequest.query || !searchRequest.knowledgeHubURL) return;

  similaritySearchStore.similaritySearch(searchRequest);
  searchRequest.query = '';
};

Example Usage

<script lang="ts" setup>
import { reactive, useSimilaritySearch } from '#imports';

export type SimilaritySearchRequest = {
  maxItems: number;
  query: string;
  knowledgeHubURL: string;
};

const searchRequest = reactive<SimilaritySearchRequest>({
  maxItems: 5,
  query: '',
  knowledgeHubURL: 'http://localhost:8000',
});

const similaritySearchStore = useSimilaritySearch();

const submitSearch = () => {
  if (!searchRequest.maxItems || !searchRequest.query || !searchRequest.knowledgeHubURL) return;

  similaritySearchStore.similaritySearch(searchRequest);
  searchRequest.query = '';
};

</script>

<template>
  <input
    v-model="searchRequest.query"
    type="text"
    @keyup.enter="submitSearch"
  />
  <SimilaritySearchResponseProvider
    v-slot="data"
  >
    <div>Search Response:</div>
    <ul v-for="document in data.vectorDocumentList" :key="document.id">
      <li>
        <pre>{{ document.embedding_metadata }}</pre>
      </li>
    </ul>
    <div>error: {{ data.error }}</div>
    <div>pending: {{ data.pending }}</div>
    <div>originalQuery: {{ data.originalQuery }}</div>
  </SimilaritySearchResponseProvider>
</template>

Contributing

tbd

License

tbd