Skip to content

Latest commit

 

History

History
72 lines (55 loc) · 3.27 KB

README.md

File metadata and controls

72 lines (55 loc) · 3.27 KB
Raw

Welcome to Stream-Query-Client

Stream-Query-Client

Stream-Query-Client is the easiest way to use Vectara's streaming query API in your JavaScript applications. Simply provide a query configuration and a callback to instantly receive stream updates.

Tip

Looking for something else? Try another open-source project:

  • React-Search: Add Vectara semantic search to your React apps with a few lines of code.
  • React-Chatbot: Add a compact Vectara-powered chatbot widget chat to your React apps.
  • Create-UI: The fastest way to generate a working React codebase for a range of generative and semantic search UIs.
  • Vectara Answer: Demo app for Summarized Semantic Search with advanced configuration options.
  • Vectara Ingest: Sample templates and crawlers for pulling data from many popular data sources.

How it works

When executed, streamQuery sends a request to Vectara's streaming query API. As the endpoint returns data chunks to the browser, the supplied onStreamUpdate is executed with relevant data from the most recent chunk. You can then use this latest data in your application however you wish.

Use it in your application

Install Stream-Query-Client

npm install --save @vectara/stream-query-client

Then use it in your application like this:

import { streamQueryV2, ApiV2 } from "@vectara/stream-query-client";

const sendQuery = async () => {
  const configurationOptions: ApiV2.StreamQueryConfig = {
    // Required fields.
    customerId: "customerIdValue",
    apiKey: "zqt_apiKeyValue",
    // To run queries against multiple corpora, use a comma-separated list of corpus keys. For example: "corpus_1,corpus_2".
    corpusKey: "corpora_1",
    query: "How many coconuts can an African swallow carry?",
    search: {
      offset: 0,
      limit: 5,
      metadataFilter: ""
    },
    generation: {
      maxUsedSearchResults: 5,
      responseLanguage: "eng",
      enableFactualConsistencyScore: true,
      generationPreset: "generation-preset-name"
    }
  };

  const onStreamUpdate = (update: ApiV2.StreamUpdate) => {
    // Perform operations on returned data, e.g. update state.
    console.log(update.updatedText);
  };

  streamQueryV2(configurationOptions, onStreamUpdate);
};

For more information on configuration options and callback types, see the type definitions and our Query API documentation.

License

Stream-Query-Client is an open-sourced software licensed under the Apache 2.0 license.

This repository contains sample code that can help you build UIs powered by Vectara, and is licensed under the Apache 2.0 License. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.