Release 5.0.0

Breaking changes

• Migrate from prompt_text to prompt_template by @cjcenizal in #36

Release 4.3.0

What's Changed

• Surface StreamQueryClient error message when request fails. by @cjcenizal in #34

4.2.0

What's Changed

• added chain reranker support by

Full Changelog: 4.1.0...4.2.0

Release 4.1.0

FEATURES

• Adds support for user-defined function reranker
• Reduces package size

Release 4.0.0

Breaking changes

• Migrate from prompt_name to generation_preset_name #28

3.2.0

What's Changed

• send multiple corpora in query by @adeelehsan in #27

Full Changelog: 3.1.0...3.2.0

3.1.0

What's Changed

• Add v2 support for response headers. by @mrderyk in #23
• Fix StreamQueryClient handling of HTTP errors and add support for None reranker and GenerationInfo event. by @cjcenizal in #24

Full Changelog: 3.0.0...3.1.0

3.0.0

What's changed

Support for Query API v2!

Breaking changes

The package interface is now:

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

Requests are now configured with the same objects and fields as described in the Corpus Query docs.

The endpoint prop is renamed to domain.

New features

• Errors are emitted as regular events to the onStreamEvent handler.
• Calling streamQueryV2 returns { cancelStream, request, status }. Use cancelStream to cancel the stream. Use request to inspect the underlying API v2 request. Use status to determine the initial HTTP response code sent in response to the request.
• Added authToken config option to support authenticating with a JWT instead of an API key.
• Exported API types under ApiV1 and ApiV2 namespaces.
• New GenerationEndEvent is emitted to signify when the generated response is complete.
• New UnexpectedEvent surfaces any stream events that were unexpected. This provides future-proofing against stream events that might be added to the API in the future.
• New RequestErrorEvent (server responds with non-200), GenericErrorEvent (when the buffer logic throws a JS error, which shouldn't happen), and UnexpectedErrorEvent (catch-all for other error cases) surface additional error cases.

Bug fixes

• Events might be very large, e.g. many or large search results, which causes them to be split across multiple chunks. Original code didn't accommodate for this, and risked a JSON.parse error. The client now buffers these chunks until it detects the completion of the event, at which point it emits the buffered event to the consumer.

Full Changelog: 2.1.0...3.0.0

2.1.2

What's Changed

• Mark details type as optional.
• added 2 letter language codes in summary languages.
• version upgraded.

Full Changelog: 2.0.1...2.1.2

2.1.0

What's Changed

• version upgraded.

Full Changelog: 2.1.2...2.1.0