@distilled.cloud/typesense 0.30.3 → 1.0.0-rc.10

package/src/operations/retrieveAllPresets.ts

@@ -1,188 +0,0 @@
-import * as Schema from "effect/Schema";
-import { API } from "../client.ts";
-import * as T from "../traits.ts";
-
-// Input Schema
-export interface RetrieveAllPresetsInput {}
-export const RetrieveAllPresetsInput =
-  /*@__PURE__*/ Schema.Struct({}).pipe(
-    T.Http({ method: "GET", path: "/presets" }),
-  ) as unknown as Schema.Codec<RetrieveAllPresetsInput>;
-
-// Output Schema
-export interface RetrieveAllPresetsOutput {
-  presets: {
-    value:
-      | {
-          q?: string;
-          query_by?: string;
-          validate_field_names?: boolean;
-          nl_query?: boolean;
-          nl_model_id?: string;
-          query_by_weights?: string;
-          text_match_type?: string;
-          prefix?: string;
-          infix?: string;
-          max_extra_prefix?: number;
-          max_extra_suffix?: number;
-          filter_by?: string;
-          max_filter_by_candidates?: number;
-          sort_by?: string;
-          facet_by?: string;
-          max_facet_values?: number;
-          facet_query?: string;
-          num_typos?: string;
-          page?: number;
-          per_page?: number;
-          limit?: number;
-          offset?: number;
-          group_by?: string;
-          group_limit?: number;
-          group_missing_values?: boolean;
-          include_fields?: string;
-          exclude_fields?: string;
-          highlight_full_fields?: string;
-          highlight_affix_num_tokens?: number;
-          highlight_start_tag?: string;
-          highlight_end_tag?: string;
-          enable_highlight_v1?: boolean;
-          enable_analytics?: boolean;
-          snippet_threshold?: number;
-          synonym_sets?: string;
-          drop_tokens_threshold?: number;
-          drop_tokens_mode?: "right_to_left" | "left_to_right" | "both_sides:3";
-          typo_tokens_threshold?: number;
-          enable_typos_for_alpha_numerical_tokens?: boolean;
-          filter_curated_hits?: boolean;
-          enable_synonyms?: boolean;
-          synonym_prefix?: boolean;
-          synonym_num_typos?: number;
-          pinned_hits?: string;
-          hidden_hits?: string;
-          curation_tags?: string;
-          highlight_fields?: string;
-          split_join_tokens?: string;
-          pre_segmented_query?: boolean;
-          preset?: string;
-          enable_curations?: boolean;
-          prioritize_exact_match?: boolean;
-          max_candidates?: number;
-          prioritize_token_position?: boolean;
-          prioritize_num_matching_fields?: boolean;
-          enable_typos_for_numerical_tokens?: boolean;
-          exhaustive_search?: boolean;
-          search_cutoff_ms?: number;
-          use_cache?: boolean;
-          cache_ttl?: number;
-          min_len_1typo?: number;
-          min_len_2typo?: number;
-          vector_query?: string;
-          remote_embedding_timeout_ms?: number;
-          remote_embedding_num_tries?: number;
-          facet_strategy?: string;
-          stopwords?: string;
-          facet_return_parent?: string;
-          voice_query?: string;
-          conversation?: boolean;
-          conversation_model_id?: string;
-          conversation_id?: string;
-        }
-      | {
-          union?: boolean;
-          searches: {
-            q?: string;
-            query_by?: string;
-            query_by_weights?: string;
-            text_match_type?: string;
-            prefix?: string;
-            infix?: string;
-            max_extra_prefix?: number;
-            max_extra_suffix?: number;
-            filter_by?: string;
-            sort_by?: string;
-            facet_by?: string;
-            max_facet_values?: number;
-            facet_query?: string;
-            num_typos?: string;
-            page?: number;
-            per_page?: number;
-            limit?: number;
-            offset?: number;
-            group_by?: string;
-            group_limit?: number;
-            group_missing_values?: boolean;
-            include_fields?: string;
-            exclude_fields?: string;
-            highlight_full_fields?: string;
-            highlight_affix_num_tokens?: number;
-            highlight_start_tag?: string;
-            highlight_end_tag?: string;
-            snippet_threshold?: number;
-            drop_tokens_threshold?: number;
-            drop_tokens_mode?:
-              | "right_to_left"
-              | "left_to_right"
-              | "both_sides:3";
-            typo_tokens_threshold?: number;
-            enable_typos_for_alpha_numerical_tokens?: boolean;
-            filter_curated_hits?: boolean;
-            enable_synonyms?: boolean;
-            enable_analytics?: boolean;
-            synonym_prefix?: boolean;
-            synonym_num_typos?: number;
-            pinned_hits?: string;
-            hidden_hits?: string;
-            curation_tags?: string;
-            highlight_fields?: string;
-            pre_segmented_query?: boolean;
-            preset?: string;
-            enable_curations?: boolean;
-            prioritize_exact_match?: boolean;
-            prioritize_token_position?: boolean;
-            prioritize_num_matching_fields?: boolean;
-            enable_typos_for_numerical_tokens?: boolean;
-            exhaustive_search?: boolean;
-            search_cutoff_ms?: number;
-            use_cache?: boolean;
-            cache_ttl?: number;
-            min_len_1typo?: number;
-            min_len_2typo?: number;
-            vector_query?: string;
-            remote_embedding_timeout_ms?: number;
-            remote_embedding_num_tries?: number;
-            facet_strategy?: string;
-            stopwords?: string;
-            facet_return_parent?: string;
-            voice_query?: string;
-            conversation?: boolean;
-            conversation_model_id?: string;
-            conversation_id?: string;
-            validate_field_names?: boolean;
-            collection?: string;
-            "x-typesense-api-key"?: string;
-            rerank_hybrid_matches?: boolean;
-          }[];
-        };
-    name: string;
-  }[];
-}
-export const RetrieveAllPresetsOutput =
-  /*@__PURE__*/ Schema.Struct({
-    presets: Schema.Array(
-      Schema.Struct({
-        value: Schema.Unknown,
-        name: Schema.String,
-      }),
-    ),
-  }) as unknown as Schema.Codec<RetrieveAllPresetsOutput>;
-
-// The operation
-/**
- * Retrieves all presets.
- *
- * Retrieve the details of all presets
- */
-export const retrieveAllPresets = /*@__PURE__*/ API.make(() => ({
-  inputSchema: RetrieveAllPresetsInput,
-  outputSchema: RetrieveAllPresetsOutput,
-}));

package/src/operations/retrieveAnalyticsRule.ts

@@ -1,71 +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 RetrieveAnalyticsRuleInput {
-  ruleName: string;
-}
-export const RetrieveAnalyticsRuleInput =
-  /*@__PURE__*/ Schema.Struct({
-    ruleName: Schema.String.pipe(T.PathParam()),
-  }).pipe(
-    T.Http({ method: "GET", path: "/analytics/rules/{ruleName}" }),
-  ) as unknown as Schema.Codec<RetrieveAnalyticsRuleInput>;
-
-// Output Schema
-export interface RetrieveAnalyticsRuleOutput {
-  name: string;
-  type: "popular_queries" | "nohits_queries" | "counter" | "log";
-  collection: string;
-  event_type: string;
-  rule_tag?: string;
-  params?: {
-    destination_collection?: string;
-    limit?: number;
-    capture_search_requests?: boolean;
-    meta_fields?: string[];
-    expand_query?: boolean;
-    counter_field?: string;
-    weight?: number;
-  };
-}
-export const RetrieveAnalyticsRuleOutput =
-  /*@__PURE__*/ Schema.Struct({
-    name: Schema.String,
-    type: Schema.Literals([
-      "popular_queries",
-      "nohits_queries",
-      "counter",
-      "log",
-    ]),
-    collection: Schema.String,
-    event_type: Schema.String,
-    rule_tag: Schema.optional(Schema.String),
-    params: Schema.optional(
-      Schema.Struct({
-        destination_collection: Schema.optional(Schema.String),
-        limit: Schema.optional(Schema.Number),
-        capture_search_requests: Schema.optional(Schema.Boolean),
-        meta_fields: Schema.optional(Schema.Array(Schema.String)),
-        expand_query: Schema.optional(Schema.Boolean),
-        counter_field: Schema.optional(Schema.String),
-        weight: Schema.optional(Schema.Number),
-      }),
-    ),
-  }) as unknown as Schema.Codec<RetrieveAnalyticsRuleOutput>;
-
-// The operation
-/**
- * Retrieves an analytics rule
- *
- * Retrieve the details of an analytics rule, given it's name
- *
- * @param ruleName - The name of the analytics rule to retrieve
- */
-export const retrieveAnalyticsRule = /*@__PURE__*/ API.make(() => ({
-  inputSchema: RetrieveAnalyticsRuleInput,
-  outputSchema: RetrieveAnalyticsRuleOutput,
-  errors: [NotFound] as const,
-}));

package/src/operations/retrieveAnalyticsRules.ts

@@ -1,71 +0,0 @@
-import * as Schema from "effect/Schema";
-import { API } from "../client.ts";
-import * as T from "../traits.ts";
-
-// Input Schema
-export interface RetrieveAnalyticsRulesInput {
-  rule_tag?: string;
-}
-export const RetrieveAnalyticsRulesInput =
-  /*@__PURE__*/ Schema.Struct({
-    rule_tag: Schema.optional(Schema.String),
-  }).pipe(
-    T.Http({ method: "GET", path: "/analytics/rules" }),
-  ) as unknown as Schema.Codec<RetrieveAnalyticsRulesInput>;
-
-// Output Schema
-export type RetrieveAnalyticsRulesOutput = {
-  name: string;
-  type: "popular_queries" | "nohits_queries" | "counter" | "log";
-  collection: string;
-  event_type: string;
-  rule_tag?: string;
-  params?: {
-    destination_collection?: string;
-    limit?: number;
-    capture_search_requests?: boolean;
-    meta_fields?: string[];
-    expand_query?: boolean;
-    counter_field?: string;
-    weight?: number;
-  };
-}[];
-export const RetrieveAnalyticsRulesOutput =
-  /*@__PURE__*/ Schema.Array(
-    Schema.Struct({
-      name: Schema.String,
-      type: Schema.Literals([
-        "popular_queries",
-        "nohits_queries",
-        "counter",
-        "log",
-      ]),
-      collection: Schema.String,
-      event_type: Schema.String,
-      rule_tag: Schema.optional(Schema.String),
-      params: Schema.optional(
-        Schema.Struct({
-          destination_collection: Schema.optional(Schema.String),
-          limit: Schema.optional(Schema.Number),
-          capture_search_requests: Schema.optional(Schema.Boolean),
-          meta_fields: Schema.optional(Schema.Array(Schema.String)),
-          expand_query: Schema.optional(Schema.Boolean),
-          counter_field: Schema.optional(Schema.String),
-          weight: Schema.optional(Schema.Number),
-        }),
-      ),
-    }),
-  ) as unknown as Schema.Codec<RetrieveAnalyticsRulesOutput>;
-
-// The operation
-/**
- * Retrieve analytics rules
- *
- * Retrieve all analytics rules. Use the optional rule_tag filter to narrow down results.
- *
- * @param rule_tag - Filter rules by rule_tag
- */
-export const retrieveAnalyticsRules = /*@__PURE__*/ API.make(() => ({
-  inputSchema: RetrieveAnalyticsRulesInput,
-  outputSchema: RetrieveAnalyticsRulesOutput,
-}));

package/src/operations/retrieveConversationModel.ts

@@ -1,36 +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 RetrieveConversationModelInput {
-  modelId: string;
-}
-export const RetrieveConversationModelInput =
-  /*@__PURE__*/ Schema.Struct({
-    modelId: Schema.String.pipe(T.PathParam()),
-  }).pipe(
-    T.Http({ method: "GET", path: "/conversations/models/{modelId}" }),
-  ) as unknown as Schema.Codec<RetrieveConversationModelInput>;
-
-// Output Schema
-export interface RetrieveConversationModelOutput {
-  id: string;
-}
-export const RetrieveConversationModelOutput =
-  /*@__PURE__*/ Schema.Struct({
-    id: Schema.String,
-  }) as unknown as Schema.Codec<RetrieveConversationModelOutput>;
-
-// The operation
-/**
- * Retrieve a conversation model
- *
- * @param modelId - The id of the conversation model to retrieve
- */
-export const retrieveConversationModel = /*@__PURE__*/ API.make(() => ({
-  inputSchema: RetrieveConversationModelInput,
-  outputSchema: RetrieveConversationModelOutput,
-  errors: [NotFound] as const,
-}));

package/src/operations/retrieveCurationSet.ts

@@ -1,95 +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 RetrieveCurationSetInput {
-  curationSetName: string;
-}
-export const RetrieveCurationSetInput =
-  /*@__PURE__*/ Schema.Struct({
-    curationSetName: Schema.String.pipe(T.PathParam()),
-  }).pipe(
-    T.Http({ method: "GET", path: "/curation_sets/{curationSetName}" }),
-  ) as unknown as Schema.Codec<RetrieveCurationSetInput>;
-
-// Output Schema
-export interface RetrieveCurationSetOutput {
-  items: {
-    rule: {
-      tags?: string[];
-      query?: string;
-      match?: "exact" | "contains";
-      filter_by?: string;
-    };
-    includes?: { id: string; position: number }[];
-    excludes?: { id: string }[];
-    filter_by?: string;
-    remove_matched_tokens?: boolean;
-    metadata?: unknown;
-    sort_by?: string;
-    replace_query?: string;
-    filter_curated_hits?: boolean;
-    effective_from_ts?: number;
-    effective_to_ts?: number;
-    stop_processing?: boolean;
-    id?: string;
-  }[];
-  description?: string;
-  name: string;
-}
-export const RetrieveCurationSetOutput =
-  /*@__PURE__*/ Schema.Struct({
-    items: Schema.Array(
-      Schema.Struct({
-        rule: Schema.Struct({
-          tags: Schema.optional(Schema.Array(Schema.String)),
-          query: Schema.optional(Schema.String),
-          match: Schema.optional(Schema.Literals(["exact", "contains"])),
-          filter_by: Schema.optional(Schema.String),
-        }),
-        includes: Schema.optional(
-          Schema.Array(
-            Schema.Struct({
-              id: Schema.String,
-              position: Schema.Number,
-            }),
-          ),
-        ),
-        excludes: Schema.optional(
-          Schema.Array(
-            Schema.Struct({
-              id: Schema.String,
-            }),
-          ),
-        ),
-        filter_by: Schema.optional(Schema.String),
-        remove_matched_tokens: Schema.optional(Schema.Boolean),
-        metadata: Schema.optional(Schema.Unknown),
-        sort_by: Schema.optional(Schema.String),
-        replace_query: Schema.optional(Schema.String),
-        filter_curated_hits: Schema.optional(Schema.Boolean),
-        effective_from_ts: Schema.optional(Schema.Number),
-        effective_to_ts: Schema.optional(Schema.Number),
-        stop_processing: Schema.optional(Schema.Boolean),
-        id: Schema.optional(Schema.String),
-      }),
-    ),
-    description: Schema.optional(Schema.String),
-    name: Schema.String,
-  }) as unknown as Schema.Codec<RetrieveCurationSetOutput>;
-
-// The operation
-/**
- * Retrieve a curation set
- *
- * Retrieve a specific curation set by its name
- *
- * @param curationSetName - The name of the curation set to retrieve
- */
-export const retrieveCurationSet = /*@__PURE__*/ API.make(() => ({
-  inputSchema: RetrieveCurationSetInput,
-  outputSchema: RetrieveCurationSetOutput,
-  errors: [NotFound] as const,
-}));

package/src/operations/retrieveCurationSetItem.ts

@@ -1,91 +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 RetrieveCurationSetItemInput {
-  curationSetName: string;
-  itemId: string;
-}
-export const RetrieveCurationSetItemInput =
-  /*@__PURE__*/ Schema.Struct({
-    curationSetName: Schema.String.pipe(T.PathParam()),
-    itemId: Schema.String.pipe(T.PathParam()),
-  }).pipe(
-    T.Http({
-      method: "GET",
-      path: "/curation_sets/{curationSetName}/items/{itemId}",
-    }),
-  ) as unknown as Schema.Codec<RetrieveCurationSetItemInput>;
-
-// Output Schema
-export interface RetrieveCurationSetItemOutput {
-  rule: {
-    tags?: string[];
-    query?: string;
-    match?: "exact" | "contains";
-    filter_by?: string;
-  };
-  includes?: { id: string; position: number }[];
-  excludes?: { id: string }[];
-  filter_by?: string;
-  remove_matched_tokens?: boolean;
-  metadata?: unknown;
-  sort_by?: string;
-  replace_query?: string;
-  filter_curated_hits?: boolean;
-  effective_from_ts?: number;
-  effective_to_ts?: number;
-  stop_processing?: boolean;
-  id: string;
-}
-export const RetrieveCurationSetItemOutput =
-  /*@__PURE__*/ Schema.Struct({
-    rule: Schema.Struct({
-      tags: Schema.optional(Schema.Array(Schema.String)),
-      query: Schema.optional(Schema.String),
-      match: Schema.optional(Schema.Literals(["exact", "contains"])),
-      filter_by: Schema.optional(Schema.String),
-    }),
-    includes: Schema.optional(
-      Schema.Array(
-        Schema.Struct({
-          id: Schema.String,
-          position: Schema.Number,
-        }),
-      ),
-    ),
-    excludes: Schema.optional(
-      Schema.Array(
-        Schema.Struct({
-          id: Schema.String,
-        }),
-      ),
-    ),
-    filter_by: Schema.optional(Schema.String),
-    remove_matched_tokens: Schema.optional(Schema.Boolean),
-    metadata: Schema.optional(Schema.Unknown),
-    sort_by: Schema.optional(Schema.String),
-    replace_query: Schema.optional(Schema.String),
-    filter_curated_hits: Schema.optional(Schema.Boolean),
-    effective_from_ts: Schema.optional(Schema.Number),
-    effective_to_ts: Schema.optional(Schema.Number),
-    stop_processing: Schema.optional(Schema.Boolean),
-    id: Schema.String,
-  }) as unknown as Schema.Codec<RetrieveCurationSetItemOutput>;
-
-// The operation
-/**
- * Retrieve a curation set item
- *
- * Retrieve a specific curation item by its id
- *
- * @param curationSetName - The name of the curation set
- * @param itemId - The id of the curation item to retrieve
- */
-export const retrieveCurationSetItem = /*@__PURE__*/ API.make(() => ({
-  inputSchema: RetrieveCurationSetItemInput,
-  outputSchema: RetrieveCurationSetItemOutput,
-  errors: [NotFound] as const,
-}));

package/src/operations/retrieveCurationSetItems.ts

@@ -1,87 +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 RetrieveCurationSetItemsInput {
-  curationSetName: string;
-}
-export const RetrieveCurationSetItemsInput =
-  /*@__PURE__*/ Schema.Struct({
-    curationSetName: Schema.String.pipe(T.PathParam()),
-  }).pipe(
-    T.Http({ method: "GET", path: "/curation_sets/{curationSetName}/items" }),
-  ) as unknown as Schema.Codec<RetrieveCurationSetItemsInput>;
-
-// Output Schema
-export type RetrieveCurationSetItemsOutput = {
-  rule: {
-    tags?: string[];
-    query?: string;
-    match?: "exact" | "contains";
-    filter_by?: string;
-  };
-  includes?: { id: string; position: number }[];
-  excludes?: { id: string }[];
-  filter_by?: string;
-  remove_matched_tokens?: boolean;
-  metadata?: unknown;
-  sort_by?: string;
-  replace_query?: string;
-  filter_curated_hits?: boolean;
-  effective_from_ts?: number;
-  effective_to_ts?: number;
-  stop_processing?: boolean;
-  id: string;
-}[];
-export const RetrieveCurationSetItemsOutput =
-  /*@__PURE__*/ Schema.Array(
-    Schema.Struct({
-      rule: Schema.Struct({
-        tags: Schema.optional(Schema.Array(Schema.String)),
-        query: Schema.optional(Schema.String),
-        match: Schema.optional(Schema.Literals(["exact", "contains"])),
-        filter_by: Schema.optional(Schema.String),
-      }),
-      includes: Schema.optional(
-        Schema.Array(
-          Schema.Struct({
-            id: Schema.String,
-            position: Schema.Number,
-          }),
-        ),
-      ),
-      excludes: Schema.optional(
-        Schema.Array(
-          Schema.Struct({
-            id: Schema.String,
-          }),
-        ),
-      ),
-      filter_by: Schema.optional(Schema.String),
-      remove_matched_tokens: Schema.optional(Schema.Boolean),
-      metadata: Schema.optional(Schema.Unknown),
-      sort_by: Schema.optional(Schema.String),
-      replace_query: Schema.optional(Schema.String),
-      filter_curated_hits: Schema.optional(Schema.Boolean),
-      effective_from_ts: Schema.optional(Schema.Number),
-      effective_to_ts: Schema.optional(Schema.Number),
-      stop_processing: Schema.optional(Schema.Boolean),
-      id: Schema.String,
-    }),
-  ) as unknown as Schema.Codec<RetrieveCurationSetItemsOutput>;
-
-// The operation
-/**
- * List items in a curation set
- *
- * Retrieve all curation items in a set
- *
- * @param curationSetName - The name of the curation set to retrieve items for
- */
-export const retrieveCurationSetItems = /*@__PURE__*/ API.make(() => ({
-  inputSchema: RetrieveCurationSetItemsInput,
-  outputSchema: RetrieveCurationSetItemsOutput,
-  errors: [NotFound] as const,
-}));