@distilled.cloud/typesense 0.30.2 → 1.0.0-rc.1

package/src/operations/searchCollection.ts

@@ -1,309 +0,0 @@
-import * as Schema from "effect/Schema";
-import { API } from "../client.ts";
-import * as T from "../traits.ts";
-import { BadRequest, NotFound } from "../errors.ts";
-
-// Input Schema
-export interface SearchCollectionInput {
-  collectionName: string;
-  searchParameters: string;
-}
-export const SearchCollectionInput = /*@__PURE__*/ Schema.Struct({
-  collectionName: Schema.String.pipe(T.PathParam()),
-  searchParameters: Schema.String,
-}).pipe(
-  T.Http({
-    method: "GET",
-    path: "/collections/{collectionName}/documents/search",
-  }),
-) as unknown as Schema.Codec<SearchCollectionInput>;
-
-// Output Schema
-export interface SearchCollectionOutput {
-  facet_counts?: {
-    counts?: {
-      count?: number;
-      highlighted?: string;
-      value?: string;
-      parent?: unknown;
-    }[];
-    field_name?: string;
-    sampled?: boolean;
-    stats?: {
-      max?: number;
-      min?: number;
-      sum?: number;
-      total_values?: number;
-      avg?: number;
-    };
-  }[];
-  found?: number;
-  found_docs?: number;
-  search_time_ms?: number;
-  out_of?: number;
-  search_cutoff?: boolean;
-  page?: number;
-  grouped_hits?: {
-    found?: number;
-    group_key: unknown[];
-    hits: {
-      highlights?: {
-        field?: string;
-        snippet?: string;
-        snippets?: string[];
-        value?: string;
-        values?: string[];
-        indices?: number[];
-        matched_tokens?: unknown[];
-      }[];
-      highlight?: Record<string, unknown>;
-      document?: Record<string, unknown>;
-      text_match?: number;
-      text_match_info?: {
-        best_field_score?: string;
-        best_field_weight?: number;
-        fields_matched?: number;
-        num_tokens_dropped?: number;
-        score?: string;
-        tokens_matched?: number;
-        typo_prefix_score?: number;
-      };
-      geo_distance_meters?: Record<string, number>;
-      vector_distance?: number;
-      hybrid_search_info?: { rank_fusion_score?: number };
-      search_index?: number;
-    }[];
-  }[];
-  hits?: {
-    highlights?: {
-      field?: string;
-      snippet?: string;
-      snippets?: string[];
-      value?: string;
-      values?: string[];
-      indices?: number[];
-      matched_tokens?: unknown[];
-    }[];
-    highlight?: Record<string, unknown>;
-    document?: Record<string, unknown>;
-    text_match?: number;
-    text_match_info?: {
-      best_field_score?: string;
-      best_field_weight?: number;
-      fields_matched?: number;
-      num_tokens_dropped?: number;
-      score?: string;
-      tokens_matched?: number;
-      typo_prefix_score?: number;
-    };
-    geo_distance_meters?: Record<string, number>;
-    vector_distance?: number;
-    hybrid_search_info?: { rank_fusion_score?: number };
-    search_index?: number;
-  }[];
-  request_params?: {
-    collection_name: string;
-    first_q?: string;
-    q: string;
-    per_page: number;
-    voice_query?: { transcribed_query?: string };
-  };
-  conversation?: {
-    answer: string;
-    conversation_history: unknown[];
-    conversation_id: string;
-    query: string;
-  };
-  union_request_params?: {
-    collection_name: string;
-    first_q?: string;
-    q: string;
-    per_page: number;
-    voice_query?: { transcribed_query?: string };
-  }[];
-  metadata?: Record<string, unknown>;
-}
-export const SearchCollectionOutput = /*@__PURE__*/ Schema.Struct({
-  facet_counts: Schema.optional(
-    Schema.Array(
-      Schema.Struct({
-        counts: Schema.optional(
-          Schema.Array(
-            Schema.Struct({
-              count: Schema.optional(Schema.Number),
-              highlighted: Schema.optional(Schema.String),
-              value: Schema.optional(Schema.String),
-              parent: Schema.optional(Schema.Unknown),
-            }),
-          ),
-        ),
-        field_name: Schema.optional(Schema.String),
-        sampled: Schema.optional(Schema.Boolean),
-        stats: Schema.optional(
-          Schema.Struct({
-            max: Schema.optional(Schema.Number),
-            min: Schema.optional(Schema.Number),
-            sum: Schema.optional(Schema.Number),
-            total_values: Schema.optional(Schema.Number),
-            avg: Schema.optional(Schema.Number),
-          }),
-        ),
-      }),
-    ),
-  ),
-  found: Schema.optional(Schema.Number),
-  found_docs: Schema.optional(Schema.Number),
-  search_time_ms: Schema.optional(Schema.Number),
-  out_of: Schema.optional(Schema.Number),
-  search_cutoff: Schema.optional(Schema.Boolean),
-  page: Schema.optional(Schema.Number),
-  grouped_hits: Schema.optional(
-    Schema.Array(
-      Schema.Struct({
-        found: Schema.optional(Schema.Number),
-        group_key: Schema.Array(Schema.Unknown),
-        hits: Schema.Array(
-          Schema.Struct({
-            highlights: Schema.optional(
-              Schema.Array(
-                Schema.Struct({
-                  field: Schema.optional(Schema.String),
-                  snippet: Schema.optional(Schema.String),
-                  snippets: Schema.optional(Schema.Array(Schema.String)),
-                  value: Schema.optional(Schema.String),
-                  values: Schema.optional(Schema.Array(Schema.String)),
-                  indices: Schema.optional(Schema.Array(Schema.Number)),
-                  matched_tokens: Schema.optional(Schema.Array(Schema.Unknown)),
-                }),
-              ),
-            ),
-            highlight: Schema.optional(
-              Schema.Record(Schema.String, Schema.Unknown),
-            ),
-            document: Schema.optional(
-              Schema.Record(Schema.String, Schema.Unknown),
-            ),
-            text_match: Schema.optional(Schema.Number),
-            text_match_info: Schema.optional(
-              Schema.Struct({
-                best_field_score: Schema.optional(Schema.String),
-                best_field_weight: Schema.optional(Schema.Number),
-                fields_matched: Schema.optional(Schema.Number),
-                num_tokens_dropped: Schema.optional(Schema.Number),
-                score: Schema.optional(Schema.String),
-                tokens_matched: Schema.optional(Schema.Number),
-                typo_prefix_score: Schema.optional(Schema.Number),
-              }),
-            ),
-            geo_distance_meters: Schema.optional(
-              Schema.Record(Schema.String, Schema.Number),
-            ),
-            vector_distance: Schema.optional(Schema.Number),
-            hybrid_search_info: Schema.optional(
-              Schema.Struct({
-                rank_fusion_score: Schema.optional(Schema.Number),
-              }),
-            ),
-            search_index: Schema.optional(Schema.Number),
-          }),
-        ),
-      }),
-    ),
-  ),
-  hits: Schema.optional(
-    Schema.Array(
-      Schema.Struct({
-        highlights: Schema.optional(
-          Schema.Array(
-            Schema.Struct({
-              field: Schema.optional(Schema.String),
-              snippet: Schema.optional(Schema.String),
-              snippets: Schema.optional(Schema.Array(Schema.String)),
-              value: Schema.optional(Schema.String),
-              values: Schema.optional(Schema.Array(Schema.String)),
-              indices: Schema.optional(Schema.Array(Schema.Number)),
-              matched_tokens: Schema.optional(Schema.Array(Schema.Unknown)),
-            }),
-          ),
-        ),
-        highlight: Schema.optional(
-          Schema.Record(Schema.String, Schema.Unknown),
-        ),
-        document: Schema.optional(Schema.Record(Schema.String, Schema.Unknown)),
-        text_match: Schema.optional(Schema.Number),
-        text_match_info: Schema.optional(
-          Schema.Struct({
-            best_field_score: Schema.optional(Schema.String),
-            best_field_weight: Schema.optional(Schema.Number),
-            fields_matched: Schema.optional(Schema.Number),
-            num_tokens_dropped: Schema.optional(Schema.Number),
-            score: Schema.optional(Schema.String),
-            tokens_matched: Schema.optional(Schema.Number),
-            typo_prefix_score: Schema.optional(Schema.Number),
-          }),
-        ),
-        geo_distance_meters: Schema.optional(
-          Schema.Record(Schema.String, Schema.Number),
-        ),
-        vector_distance: Schema.optional(Schema.Number),
-        hybrid_search_info: Schema.optional(
-          Schema.Struct({
-            rank_fusion_score: Schema.optional(Schema.Number),
-          }),
-        ),
-        search_index: Schema.optional(Schema.Number),
-      }),
-    ),
-  ),
-  request_params: Schema.optional(
-    Schema.Struct({
-      collection_name: Schema.String,
-      first_q: Schema.optional(Schema.String),
-      q: Schema.String,
-      per_page: Schema.Number,
-      voice_query: Schema.optional(
-        Schema.Struct({
-          transcribed_query: Schema.optional(Schema.String),
-        }),
-      ),
-    }),
-  ),
-  conversation: Schema.optional(
-    Schema.Struct({
-      answer: Schema.String,
-      conversation_history: Schema.Array(Schema.Unknown),
-      conversation_id: Schema.String,
-      query: Schema.String,
-    }),
-  ),
-  union_request_params: Schema.optional(
-    Schema.Array(
-      Schema.Struct({
-        collection_name: Schema.String,
-        first_q: Schema.optional(Schema.String),
-        q: Schema.String,
-        per_page: Schema.Number,
-        voice_query: Schema.optional(
-          Schema.Struct({
-            transcribed_query: Schema.optional(Schema.String),
-          }),
-        ),
-      }),
-    ),
-  ),
-  metadata: Schema.optional(Schema.Record(Schema.String, Schema.Unknown)),
-}) as unknown as Schema.Codec<SearchCollectionOutput>;
-
-// The operation
-/**
- * Search for documents in a collection
- *
- * Search for documents in a collection that match the search criteria.
- *
- * @param collectionName - The name of the collection to search for the document under
- */
-export const searchCollection = /*@__PURE__*/ API.make(() => ({
-  inputSchema: SearchCollectionInput,
-  outputSchema: SearchCollectionOutput,
-  errors: [BadRequest, NotFound] as const,
-}));

package/src/operations/takeSnapshot.ts

@@ -1,34 +0,0 @@
-import * as Schema from "effect/Schema";
-import { API } from "../client.ts";
-import * as T from "../traits.ts";
-
-// Input Schema
-export interface TakeSnapshotInput {
-  snapshot_path: string;
-}
-export const TakeSnapshotInput = /*@__PURE__*/ Schema.Struct({
-  snapshot_path: Schema.String,
-}).pipe(
-  T.Http({ method: "POST", path: "/operations/snapshot" }),
-) as unknown as Schema.Codec<TakeSnapshotInput>;
-
-// Output Schema
-export interface TakeSnapshotOutput {
-  success: boolean;
-}
-export const TakeSnapshotOutput = /*@__PURE__*/ Schema.Struct({
-  success: Schema.Boolean,
-}) as unknown as Schema.Codec<TakeSnapshotOutput>;
-
-// The operation
-/**
- * Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory.
- *
- * Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory. You can then backup the snapshot directory that gets created and later restore it as a data directory, as needed.
- *
- * @param snapshot_path - The directory on the server where the snapshot should be saved.
- */
-export const takeSnapshot = /*@__PURE__*/ API.make(() => ({
-  inputSchema: TakeSnapshotInput,
-  outputSchema: TakeSnapshotOutput,
-}));

package/src/operations/toggleSlowRequestLog.ts

@@ -1,34 +0,0 @@
-import * as Schema from "effect/Schema";
-import { API } from "../client.ts";
-import * as T from "../traits.ts";
-
-// Input Schema
-export interface ToggleSlowRequestLogInput {
-  "log-slow-requests-time-ms": number;
-}
-export const ToggleSlowRequestLogInput =
-  /*@__PURE__*/ Schema.Struct({
-    "log-slow-requests-time-ms": Schema.Number,
-  }).pipe(
-    T.Http({ method: "POST", path: "/config" }),
-  ) as unknown as Schema.Codec<ToggleSlowRequestLogInput>;
-
-// Output Schema
-export interface ToggleSlowRequestLogOutput {
-  success: boolean;
-}
-export const ToggleSlowRequestLogOutput =
-  /*@__PURE__*/ Schema.Struct({
-    success: Schema.Boolean,
-  }) as unknown as Schema.Codec<ToggleSlowRequestLogOutput>;
-
-// The operation
-/**
- * Toggle Slow Request Log
- *
- * Enable logging of requests that take over a defined threshold of time. Default is `-1` which disables slow request logging. Slow requests are logged to the primary log file, with the prefix SLOW REQUEST.
- */
-export const toggleSlowRequestLog = /*@__PURE__*/ API.make(() => ({
-  inputSchema: ToggleSlowRequestLogInput,
-  outputSchema: ToggleSlowRequestLogOutput,
-}));

package/src/operations/updateCollection.ts

@@ -1,200 +0,0 @@
-import * as Schema from "effect/Schema";
-import { API } from "../client.ts";
-import * as T from "../traits.ts";
-import { BadRequest, NotFound } from "../errors.ts";
-import { SensitiveString, SensitiveOutputString } from "../sensitive.ts";
-import * as Redacted from "effect/Redacted";
-
-// Input Schema
-export interface UpdateCollectionInput {
-  collectionName: string;
-  fields?: {
-    name: string;
-    type: string;
-    optional?: boolean;
-    facet?: boolean;
-    index?: boolean;
-    locale?: string;
-    sort?: boolean;
-    infix?: boolean;
-    reference?: string;
-    async_reference?: boolean;
-    num_dim?: number;
-    drop?: boolean;
-    store?: boolean;
-    vec_dist?: string;
-    range_index?: boolean;
-    stem?: boolean;
-    stem_dictionary?: string;
-    token_separators?: string[];
-    symbols_to_index?: string[];
-    embed?: {
-      from: string[];
-      model_config: {
-        model_name: string;
-        api_key?: string | Redacted.Redacted<string>;
-        url?: string;
-        access_token?: string | Redacted.Redacted<string>;
-        refresh_token?: string | Redacted.Redacted<string>;
-        client_id?: string;
-        client_secret?: string | Redacted.Redacted<string>;
-        project_id?: string;
-        indexing_prefix?: string;
-        query_prefix?: string;
-      };
-    };
-  }[];
-  synonym_sets?: string[];
-  metadata?: unknown;
-}
-export const UpdateCollectionInput = /*@__PURE__*/ Schema.Struct({
-  collectionName: Schema.String.pipe(T.PathParam()),
-  fields: Schema.optional(
-    Schema.Array(
-      Schema.Struct({
-        name: Schema.String,
-        type: Schema.String,
-        optional: Schema.optional(Schema.Boolean),
-        facet: Schema.optional(Schema.Boolean),
-        index: Schema.optional(Schema.Boolean),
-        locale: Schema.optional(Schema.String),
-        sort: Schema.optional(Schema.Boolean),
-        infix: Schema.optional(Schema.Boolean),
-        reference: Schema.optional(Schema.String),
-        async_reference: Schema.optional(Schema.Boolean),
-        num_dim: Schema.optional(Schema.Number),
-        drop: Schema.optional(Schema.Boolean),
-        store: Schema.optional(Schema.Boolean),
-        vec_dist: Schema.optional(Schema.String),
-        range_index: Schema.optional(Schema.Boolean),
-        stem: Schema.optional(Schema.Boolean),
-        stem_dictionary: Schema.optional(Schema.String),
-        token_separators: Schema.optional(Schema.Array(Schema.String)),
-        symbols_to_index: Schema.optional(Schema.Array(Schema.String)),
-        embed: Schema.optional(
-          Schema.Struct({
-            from: Schema.Array(Schema.String),
-            model_config: Schema.Struct({
-              model_name: Schema.String,
-              api_key: Schema.optional(SensitiveString),
-              url: Schema.optional(Schema.String),
-              access_token: Schema.optional(SensitiveString),
-              refresh_token: Schema.optional(SensitiveString),
-              client_id: Schema.optional(Schema.String),
-              client_secret: Schema.optional(SensitiveString),
-              project_id: Schema.optional(Schema.String),
-              indexing_prefix: Schema.optional(Schema.String),
-              query_prefix: Schema.optional(Schema.String),
-            }),
-          }),
-        ),
-      }),
-    ),
-  ),
-  synonym_sets: Schema.optional(Schema.Array(Schema.String)),
-  metadata: Schema.optional(Schema.Unknown),
-}).pipe(
-  T.Http({ method: "PATCH", path: "/collections/{collectionName}" }),
-) as unknown as Schema.Codec<UpdateCollectionInput>;
-
-// Output Schema
-export interface UpdateCollectionOutput {
-  fields?: {
-    name: string;
-    type: string;
-    optional?: boolean;
-    facet?: boolean;
-    index?: boolean;
-    locale?: string;
-    sort?: boolean;
-    infix?: boolean;
-    reference?: string;
-    async_reference?: boolean;
-    num_dim?: number;
-    drop?: boolean;
-    store?: boolean;
-    vec_dist?: string;
-    range_index?: boolean;
-    stem?: boolean;
-    stem_dictionary?: string;
-    token_separators?: string[];
-    symbols_to_index?: string[];
-    embed?: {
-      from: string[];
-      model_config: {
-        model_name: string;
-        api_key?: Redacted.Redacted<string>;
-        url?: string;
-        access_token?: Redacted.Redacted<string>;
-        refresh_token?: Redacted.Redacted<string>;
-        client_id?: string;
-        client_secret?: Redacted.Redacted<string>;
-        project_id?: string;
-        indexing_prefix?: string;
-        query_prefix?: string;
-      };
-    };
-  }[];
-  synonym_sets?: string[];
-  metadata?: unknown;
-}
-export const UpdateCollectionOutput = /*@__PURE__*/ Schema.Struct({
-  fields: Schema.optional(
-    Schema.Array(
-      Schema.Struct({
-        name: Schema.String,
-        type: Schema.String,
-        optional: Schema.optional(Schema.Boolean),
-        facet: Schema.optional(Schema.Boolean),
-        index: Schema.optional(Schema.Boolean),
-        locale: Schema.optional(Schema.String),
-        sort: Schema.optional(Schema.Boolean),
-        infix: Schema.optional(Schema.Boolean),
-        reference: Schema.optional(Schema.String),
-        async_reference: Schema.optional(Schema.Boolean),
-        num_dim: Schema.optional(Schema.Number),
-        drop: Schema.optional(Schema.Boolean),
-        store: Schema.optional(Schema.Boolean),
-        vec_dist: Schema.optional(Schema.String),
-        range_index: Schema.optional(Schema.Boolean),
-        stem: Schema.optional(Schema.Boolean),
-        stem_dictionary: Schema.optional(Schema.String),
-        token_separators: Schema.optional(Schema.Array(Schema.String)),
-        symbols_to_index: Schema.optional(Schema.Array(Schema.String)),
-        embed: Schema.optional(
-          Schema.Struct({
-            from: Schema.Array(Schema.String),
-            model_config: Schema.Struct({
-              model_name: Schema.String,
-              api_key: Schema.optional(SensitiveOutputString),
-              url: Schema.optional(Schema.String),
-              access_token: Schema.optional(SensitiveOutputString),
-              refresh_token: Schema.optional(SensitiveOutputString),
-              client_id: Schema.optional(Schema.String),
-              client_secret: Schema.optional(SensitiveOutputString),
-              project_id: Schema.optional(Schema.String),
-              indexing_prefix: Schema.optional(Schema.String),
-              query_prefix: Schema.optional(Schema.String),
-            }),
-          }),
-        ),
-      }),
-    ),
-  ),
-  synonym_sets: Schema.optional(Schema.Array(Schema.String)),
-  metadata: Schema.optional(Schema.Unknown),
-}) as unknown as Schema.Codec<UpdateCollectionOutput>;
-
-// The operation
-/**
- * Update a collection
- *
- * Update a collection's schema to modify the fields and their types.
- *
- * @param collectionName - The name of the collection to update
- */
-export const updateCollection = /*@__PURE__*/ API.make(() => ({
-  inputSchema: UpdateCollectionInput,
-  outputSchema: UpdateCollectionOutput,
-  errors: [BadRequest, NotFound] as const,
-}));

package/src/operations/updateConversationModel.ts

@@ -1,56 +0,0 @@
-import * as Schema from "effect/Schema";
-import { API } from "../client.ts";
-import * as T from "../traits.ts";
-import { BadRequest, NotFound } from "../errors.ts";
-import { SensitiveString } from "../sensitive.ts";
-import * as Redacted from "effect/Redacted";
-
-// Input Schema
-export interface UpdateConversationModelInput {
-  modelId: string;
-  id?: string;
-  model_name?: string;
-  api_key?: string | Redacted.Redacted<string>;
-  history_collection?: string;
-  account_id?: string;
-  system_prompt?: string;
-  ttl?: number;
-  max_bytes?: number;
-  vllm_url?: string;
-}
-export const UpdateConversationModelInput =
-  /*@__PURE__*/ Schema.Struct({
-    modelId: Schema.String.pipe(T.PathParam()),
-    id: Schema.optional(Schema.String),
-    model_name: Schema.optional(Schema.String),
-    api_key: Schema.optional(SensitiveString),
-    history_collection: Schema.optional(Schema.String),
-    account_id: Schema.optional(Schema.String),
-    system_prompt: Schema.optional(Schema.String),
-    ttl: Schema.optional(Schema.Number),
-    max_bytes: Schema.optional(Schema.Number),
-    vllm_url: Schema.optional(Schema.String),
-  }).pipe(
-    T.Http({ method: "PUT", path: "/conversations/models/{modelId}" }),
-  ) as unknown as Schema.Codec<UpdateConversationModelInput>;
-
-// Output Schema
-export interface UpdateConversationModelOutput {
-  id: string;
-}
-export const UpdateConversationModelOutput =
-  /*@__PURE__*/ Schema.Struct({
-    id: Schema.String,
-  }) as unknown as Schema.Codec<UpdateConversationModelOutput>;
-
-// The operation
-/**
- * Update a conversation model
- *
- * @param modelId - The id of the conversation model to update
- */
-export const updateConversationModel = /*@__PURE__*/ API.make(() => ({
-  inputSchema: UpdateConversationModelInput,
-  outputSchema: UpdateConversationModelOutput,
-  errors: [BadRequest, NotFound] as const,
-}));

package/src/operations/updateDocument.ts

@@ -1,42 +0,0 @@
-import * as Schema from "effect/Schema";
-import { API } from "../client.ts";
-import * as T from "../traits.ts";
-import { NotFound } from "../errors.ts";
-
-// Input Schema
-export interface UpdateDocumentInput {
-  collectionName: string;
-  documentId: string;
-  dirty_values?: string;
-}
-export const UpdateDocumentInput = /*@__PURE__*/ Schema.Struct({
-  collectionName: Schema.String.pipe(T.PathParam()),
-  documentId: Schema.String.pipe(T.PathParam()),
-  dirty_values: Schema.optional(Schema.String),
-}).pipe(
-  T.Http({
-    method: "PATCH",
-    path: "/collections/{collectionName}/documents/{documentId}",
-  }),
-) as unknown as Schema.Codec<UpdateDocumentInput>;
-
-// Output Schema
-export type UpdateDocumentOutput = unknown;
-export const UpdateDocumentOutput =
-  /*@__PURE__*/ Schema.Unknown as unknown as Schema.Codec<UpdateDocumentOutput>;
-
-// The operation
-/**
- * Update a document
- *
- * Update an individual document from a collection by using its ID. The update can be partial.
- *
- * @param collectionName - The name of the collection to search for the document under
- * @param documentId - The Document ID
- * @param dirty_values - Dealing with Dirty Data
- */
-export const updateDocument = /*@__PURE__*/ API.make(() => ({
-  inputSchema: UpdateDocumentInput,
-  outputSchema: UpdateDocumentOutput,
-  errors: [NotFound] as const,
-}));