@or-sdk/lookup 1.1.0-beta.1830.0

package/src/types.ts

@@ -0,0 +1,629 @@
+import { OrderOptions, PaginationOptions, Token } from '@or-sdk/base';
+
+export type { OrNetworkError } from './error-parser';
+
+export type SearchMode = 'vector' | 'bm25';
+
+export type LookupConfig = {
+  /**
+   * token
+   */
+  token: Token;
+
+  /**
+   * Url of OneReach service discovery api
+   */
+  discoveryUrl?: string;
+
+  /**
+   * Account ID for cross-account requests (super admin only)
+   */
+  accountId?: string;
+
+  /**
+   * Url of OneReach lookup api
+   */
+  serviceUrl?: string;
+};
+
+/**
+ * Document creation parameters
+ */
+export type LoadDocument = {
+  /**
+   * Document name
+   */
+  name: string;
+
+  /**
+   * Document URL
+   */
+  url?: string;
+
+  /**
+   * Document description
+   */
+  description?: string;
+
+  /**
+   * Default custom properties for document passages.
+   * Note that these properties should be listed in collection properties
+   */
+  defaultProperties: Record<string, unknown>;
+};
+
+export type Property = {
+  /**
+   * Property name. e.g. `nameOfTheAuthor`
+   */
+  name: string;
+
+  /**
+   * Property type. See https://weaviate.io/developers/weaviate/config-refs/schema#datatypes for the available types
+   */
+  dataType: string;
+
+  /**
+   * Property description
+   */
+  description?: string;
+};
+
+/**
+ * CreateCollection parameters
+ */
+export type CreateCollection = UpdateCollection & {
+  /**
+   * Collection name
+   * Can start only with a letter.
+   * Minimum length: 5, Maximum length: 100
+   */
+  name: string;
+
+  /**
+   * Custom properties (Optional)
+   * Type: Array<Property>
+   */
+  properties?: Property[];
+};
+
+/**
+ * Search parameters
+ */
+export type Search = {
+  /**
+   * Search query
+   */
+  query: string;
+
+  /**
+   * Limit the number of results.
+   */
+  limit?: number;
+
+  /**
+   * Weaviate where filter. See https://weaviate.io/developers/weaviate/api/graphql/filters
+   */
+  where?: Record<string, unknown>;
+
+  /**
+   * Array of the custom properties to select.
+   */
+  select?: string[];
+
+  /**
+   * Filter out passages that are further than maxDistance from the question or context by cosine metric.
+   * Default: 0
+   * Range: 0 - 1
+   */
+  maxDistance?: number;
+};
+
+export type MessageRole = 'user' | 'assistant';
+export type AskMode = 'conversation' | 'ask';
+
+/**
+ * Message data for completion request
+ */
+export type CompletionRequestMessage = {
+  /**
+   * Role of the message sender (either "user" or "assistant")
+   */
+  role: MessageRole;
+
+  /**
+   * Content of the message
+   */
+  content: string;
+};
+
+/**
+ * Ask question parameters
+ */
+export type Ask = {
+  /**
+   * Question to ask
+   */
+  question: string;
+
+  /**
+   * Previous chat messages
+   * Default: []
+   */
+  messages?: CompletionRequestMessage[];
+
+  /**
+   * Limit the number of results.
+   * Default: 5
+   * Range: 1 - 100
+   */
+  limit?: number;
+
+  /**
+   * Weaviate where filter. See https://weaviate.io/developers/weaviate/api/graphql/filters
+   * Optional
+   */
+  where?: Record<string, unknown>;
+
+  /**
+   * Array of the custom properties to select.
+   * Optional
+   */
+  select?: string[];
+
+  /**
+   * Question mode.
+   * Default: 'conversation'
+   * Values: 'conversation', 'ask'
+   */
+  mode?: AskMode;
+
+  /**
+   * A summarization instruction used to generate correct answer.
+   * Maximum Length: 1000 characters
+   * Optional
+   */
+  answerInstruction?: string | null;
+
+  /**
+   * A summarization instruction used to generate correct search query.
+   * Maximum Length: 1000 characters
+   * Optional
+   */
+  questionInstruction?: string | null;
+
+  /**
+   * What sampling temperature to use.
+   * Default: 1
+   * Range: 0 - 2
+   */
+  temperature?: number;
+
+  /**
+   * Maximum output length from the LLM
+   * Default: 1024
+   * Range: 128 - 2048
+   */
+  maxTokens?: number;
+
+  /**
+   * Positive values penalize new tokens based on their existing frequency in the text so far.
+   * Default: 0
+   * Range: -2 - 2
+   */
+  frequencyPenalty?: number;
+
+  /**
+   * Penalize new tokens based on whether they appear in the text so far.
+   * Default: 0
+   * Range: -2 - 2
+   */
+  presencePenalty?: number;
+
+  /**
+   * Filter out passages that are further than maxDistance from the question or context by cosine metric.
+   * Default: 0
+   * Range: 0 - 1
+   */
+  maxDistance?: number;
+};
+
+/**
+ * DocumentStatus represents the loading status of a document.
+ */
+export enum DocumentStatus {
+  NEW = 'NEW',
+  LOADING = 'LOADING',
+  READY = 'READY',
+  ERROR = 'ERROR',
+}
+
+/**
+ * Document represents a document object.
+ */
+export type Document = {
+  /**
+   * Document ID
+   */
+  id: string;
+
+  /**
+   * Collection ID
+   */
+  collection: string;
+
+  /**
+   * Document name
+   */
+  name: string;
+
+  /**
+   * Document description
+   */
+  description: string;
+
+  /**
+   * Document loading status or error message
+   */
+  status: DocumentStatus | string;
+
+  /**
+   * Creation Date
+   */
+  createdAt: string;
+
+  /**
+   * Updating Date
+   */
+  updatedAt: string;
+
+  /**
+   * Number of passages in the document.
+   */
+  countPassages?: number;
+
+  /**
+   * The URL of the source this document is downloaded from if provided.
+   */
+  sourceUrl?: string;
+};
+
+/**
+ * Collection represents a collection object.
+ */
+export type Collection = {
+  /**
+   * Collection ID
+   */
+  id: string;
+
+  /**
+   * Account ID
+   */
+  accountId: string;
+
+  /**
+   * Collection name
+   * Can start only with a letter.
+   * Minimum length: 5, Maximum length: 100
+   */
+  name: string;
+
+  /**
+   * Collection description (Optional)
+   * Minimum length: 3, Maximum length: 500
+   */
+  description?: string;
+
+  /**
+   * A collection thumbnail image URL (Optional)
+   * Minimum length: 3, Maximum length: 2048
+   */
+  imageUrl?: string;
+
+  /**
+   * A summarization instruction used to generate a correct answer (Optional)
+   * Maximum length: 1000
+   */
+  answerInstruction?: string | null;
+
+  /**
+   * A summarization instruction used to generate a correct search query (Optional)
+   * Maximum length: 1000
+   */
+  questionInstruction?: string | null;
+
+  /**
+   * A summarization instruction used to generate a correct first message (Optional)
+   * Maximum length: 1000
+   */
+  greetingInstruction?: string | null;
+
+  /**
+   * Custom properties (Optional)
+   * Type: Array<Property>
+   */
+  properties?: Property[];
+
+  /**
+   * Creation Date
+   */
+  createdAt: string | Date;
+
+  /**
+   * Updating Date
+   */
+  updatedAt: string | Date;
+
+  /**
+   * What sampling temperature to use.
+   * Minimum value: 0, Maximum value: 2
+   */
+  temperature?: number;
+
+  /**
+   * Max output length from the LLM
+   * Minimum value: 128, Maximum value: 2048
+   */
+  maxTokens?: number;
+
+  /**
+   * Positive values penalize new tokens based on their existing frequency in the text so far.
+   * Minimum value: -2, Maximum value: 2
+   */
+  frequencyPenalty?: number;
+
+  /**
+   * Penalize new tokens based on whether they appear in the text so far.
+   * Minimum value: -2, Maximum value: 2
+   */
+  presencePenalty?: number;
+
+  /**
+   * Filter out passages that are further then maxDistance from the question or context by cosine metric.
+   * Minimum value: 0, Maximum value: 1
+   */
+  maxDistance?: number;
+
+  /**
+   * Large language model name.
+   */
+  modelName?: string;
+
+  /**
+   * Number of passages in the collection.
+   */
+  countPassages?: number;
+};
+
+/**
+ * SearchResult represents a document found as a result of a search query.
+ */
+export type SearchResult = {
+  /**
+   * Found passage ID
+   */
+  id: string;
+
+  /**
+   * Cosine distance between search query and result.
+   */
+  distance: string;
+
+  /**
+   * Found passage content.
+   */
+  content: string;
+
+  /**
+   * SourceUrl
+   */
+  sourceUrl: string;
+
+  /**
+   * Found passage metadata.
+   */
+  loaderMetadata: Record<string, unknown>;
+
+  /**
+   * Found passage metadata.
+   */
+  document: {
+    id: string;
+    name: string;
+  };
+};
+
+/**
+ * AskResults represents the response from an ask question query.
+ */
+export type AskResults = {
+  /**
+   * Generated answer from the chat completion.
+   */
+  result: CompletionRequestMessage;
+
+  /**
+   * Search result for the input question.
+   */
+  searchResult: SearchResult;
+};
+
+
+/**
+ * UpdateDocument parameters
+ */
+export type UpdateDocument = {
+  /**
+   * Document description
+   */
+  description?: string;
+
+  /**
+   * Document status or loading error message
+   */
+  status?: DocumentStatus | string;
+};
+
+/**
+ * UpdateCollection parameters
+ */
+export type UpdateCollection = {
+  /**
+   * Collection description (Optional)
+   * Minimum length: 3, Maximum length: 500
+   */
+  description?: string;
+
+  /**
+   * A collection thumbnail image URL (Optional)
+   * Minimum length: 3, Maximum length: 2048
+   */
+  imageUrl?: string;
+
+  /**
+   * A summarization instruction used to generate a correct answer (Optional)
+   * Maximum length: 1000
+   */
+  answerInstruction?: string;
+
+  /**
+   * A summarization instruction used to generate a correct search query (Optional)
+   * Maximum length: 1000
+   */
+  questionInstruction?: string;
+
+  /**
+   * A summarization instruction used to generate a correct first message (Optional)
+   * Maximum length: 1000
+   */
+  greetingInstruction?: string;
+
+  /**
+   * What sampling temperature to use (Optional)
+   * Default value: 1, Range: [0, 2]
+   */
+  temperature?: number;
+
+  /**
+   * Max output length from the LLM (Optional)
+   * Range: [128, 2048]
+   */
+  maxTokens?: number;
+
+  /**
+   * Positive values penalize new tokens based on their existing frequency in the text so far (Optional)
+   * Range: [-2, 2]
+   */
+  frequencyPenalty?: number;
+
+  /**
+   * Penalize new tokens based on whether they appear in the text so far (Optional)
+   * Range: [-2, 2]
+   */
+  presencePenalty?: number;
+
+  /**
+   * Filter out passages that are further then maxDistance from the question or context by
+   * cosine metric (Optional)
+   * Range: [0, 1]
+   */
+  maxDistance?: number;
+
+  /**
+   * Large language model name (Optional)
+   * Maximum length: 64
+   */
+  modelName?: string;
+};
+
+/**
+ * Find parameters
+ */
+export type Find = Partial<PaginationOptions> & Partial<OrderOptions> & {
+  /**
+   * Search query
+  */
+  query?: string;
+
+  /**
+   * Search mode: bm25 for full-text search and vector for vector similarity search.
+   */
+  mode?: SearchMode;
+};
+
+/**
+ * Find passages parameters
+ */
+export type FindPassages = Find & {
+  /**
+   * Weaviate where filter. See https://weaviate.io/developers/weaviate/api/graphql/filters
+   */
+  where?: Record<string, unknown>;
+};
+
+/**
+ * Passage creation parameters. The properties other than listed are considered custom properties.
+ */
+export type CreatePassage<T extends Record<string, unknown> = Record<string, unknown>> = {
+  /**
+   * Content of the passage
+   */
+  content: string;
+
+  /**
+   * Document ID
+   */
+  documentId: string;
+
+  /**
+   * Custom loader metadata. Non filterable property
+   */
+  loaderMetadata?: Record<string, unknown>;
+} & T;
+
+/**
+ * Passage represents a passage object.
+ */
+export type Passage<T extends Record<string, unknown> = Record<string, unknown>> = {
+  /**
+   * Passage ID
+   */
+  id: string;
+
+  /**
+   * Passage Content
+   */
+  content: string;
+
+  /**
+   * Creation Date
+   */
+  createdAt: string;
+
+  /**
+   * Updating Date
+   */
+  updatedAt: string;
+} & T;
+
+
+/**
+ * Update passage parameters
+ */
+export type UpdatePassage<T extends Record<string, unknown> = Record<string, unknown>> = {
+  /**
+   * Updated content of the passage
+   */
+  content: string;
+} & T;
+
+/**
+ * Represents a deleted passage.
+ */
+export type DeletedPassage = {
+  /**
+   * The ID of the deleted passage.
+   */
+  id: string;
+};

package/tsconfig.dev.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.esm.json",
+  "compilerOptions": {
+    "declarationDir": "./dist/types",
+    "rootDir": "./src",
+     "declaration": true
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/esm",
+    "declarationDir": "./dist/types",
+    "module": "ES6",
+    "target": "es6",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true
+  }
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/cjs/",
+    "rootDir": "./src"
+  }
+}

package/tsconfig.types.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/types",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true
+  }
+}

package/vitest.config.js

@@ -0,0 +1,24 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    reporters: ['junit', 'basic'],
+    outputFile: 'test-results/junit.xml',
+    coverage: {
+      all: true,
+      reporter: ['text', 'json', 'html', 'cobertura', 'text-summary'],
+      clean: true,
+      include: [
+        'src/**',
+      ],
+      exclude: [
+        'src/types.ts',
+        '**/*.spec.ts',
+      ],
+    },
+    globals: true,
+    environment: 'node',
+    clearMocks: true,
+    watch: false,
+  },
+});