Knowmax Quest Types

Contains types used for consuming data returned from Knowmax Quest.

Usage

The intelligence Document Insight and Index Research APIs each have a streaming (Server-Sent Events) variant in addition to their regular request/response endpoint. Events emitted by these streaming endpoints are typed using the generic IIntelligenceStreamEvent<TResponse> interface, with IDocumentInsightStreamEvent and IIndexResearchStreamEvent provided as ready-made specializations:

import type { IDocumentInsightStreamEvent } from 'knowmax-quest-types'

const handleEvent = (event: IDocumentInsightStreamEvent) => {
  switch (event.type) {
    case 'Progress':
      console.log(event.phase, event.message);
      break;
    case 'Text':
      console.log(event.delta);
      break;
    case 'Complete':
    case 'Error':
      console.log(event.response);
      break;
  }
}

Combine this with readIntelligenceStream from knowmax-quest-utils to consume the raw fetch response stream.

File attachments

User chat messages may optionally include base64 encoded file attachments, and the models endpoint reports whether a model supports attachments together with the applicable limits:

import type { IIntelligenceModel, IIntelligenceChatMessage } from 'knowmax-quest-types'

const canUpload = (model: IIntelligenceModel) => model.supportsAttachments;

const message: IIntelligenceChatMessage = {
  origin: 'User',
  text: 'What does this document say about warranty terms?',
  attachments: [{ name: 'contract.pdf', contentType: 'application/pdf', data: '...base64...' }]
};

Use validateIntelligenceAttachments and createIntelligenceChatMessageAttachmentRequest from knowmax-quest-utils to validate files against model.attachments and build the base64 payload.

License

This repository is licensed MIT, which waives all copyright restrictions.