@distilled.cloud/typesense 0.0.0 → 0.14.0

package/src/operations/multiSearch.ts

@@ -0,0 +1,288 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { BadRequest } from "../errors.ts";
+
+// Input Schema
+export const MultiSearchInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  multiSearchParameters: Schema.String,
+  union: Schema.optional(Schema.Boolean),
+  searches: Schema.Array(
+    Schema.Struct({
+      q: Schema.optional(Schema.String),
+      query_by: Schema.optional(Schema.String),
+      query_by_weights: Schema.optional(Schema.String),
+      text_match_type: Schema.optional(Schema.String),
+      prefix: Schema.optional(Schema.String),
+      infix: Schema.optional(Schema.String),
+      max_extra_prefix: Schema.optional(Schema.Number),
+      max_extra_suffix: Schema.optional(Schema.Number),
+      filter_by: Schema.optional(Schema.String),
+      sort_by: Schema.optional(Schema.String),
+      facet_by: Schema.optional(Schema.String),
+      max_facet_values: Schema.optional(Schema.Number),
+      facet_query: Schema.optional(Schema.String),
+      num_typos: Schema.optional(Schema.String),
+      page: Schema.optional(Schema.Number),
+      per_page: Schema.optional(Schema.Number),
+      limit: Schema.optional(Schema.Number),
+      offset: Schema.optional(Schema.Number),
+      group_by: Schema.optional(Schema.String),
+      group_limit: Schema.optional(Schema.Number),
+      group_missing_values: Schema.optional(Schema.Boolean),
+      include_fields: Schema.optional(Schema.String),
+      exclude_fields: Schema.optional(Schema.String),
+      highlight_full_fields: Schema.optional(Schema.String),
+      highlight_affix_num_tokens: Schema.optional(Schema.Number),
+      highlight_start_tag: Schema.optional(Schema.String),
+      highlight_end_tag: Schema.optional(Schema.String),
+      snippet_threshold: Schema.optional(Schema.Number),
+      drop_tokens_threshold: Schema.optional(Schema.Number),
+      drop_tokens_mode: Schema.optional(
+        Schema.Literals(["right_to_left", "left_to_right", "both_sides:3"]),
+      ),
+      typo_tokens_threshold: Schema.optional(Schema.Number),
+      enable_typos_for_alpha_numerical_tokens: Schema.optional(Schema.Boolean),
+      filter_curated_hits: Schema.optional(Schema.Boolean),
+      enable_synonyms: Schema.optional(Schema.Boolean),
+      enable_analytics: Schema.optional(Schema.Boolean),
+      synonym_prefix: Schema.optional(Schema.Boolean),
+      synonym_num_typos: Schema.optional(Schema.Number),
+      pinned_hits: Schema.optional(Schema.String),
+      hidden_hits: Schema.optional(Schema.String),
+      curation_tags: Schema.optional(Schema.String),
+      highlight_fields: Schema.optional(Schema.String),
+      pre_segmented_query: Schema.optional(Schema.Boolean),
+      preset: Schema.optional(Schema.String),
+      enable_curations: Schema.optional(Schema.Boolean),
+      prioritize_exact_match: Schema.optional(Schema.Boolean),
+      prioritize_token_position: Schema.optional(Schema.Boolean),
+      prioritize_num_matching_fields: Schema.optional(Schema.Boolean),
+      enable_typos_for_numerical_tokens: Schema.optional(Schema.Boolean),
+      exhaustive_search: Schema.optional(Schema.Boolean),
+      search_cutoff_ms: Schema.optional(Schema.Number),
+      use_cache: Schema.optional(Schema.Boolean),
+      cache_ttl: Schema.optional(Schema.Number),
+      min_len_1typo: Schema.optional(Schema.Number),
+      min_len_2typo: Schema.optional(Schema.Number),
+      vector_query: Schema.optional(Schema.String),
+      remote_embedding_timeout_ms: Schema.optional(Schema.Number),
+      remote_embedding_num_tries: Schema.optional(Schema.Number),
+      facet_strategy: Schema.optional(Schema.String),
+      stopwords: Schema.optional(Schema.String),
+      facet_return_parent: Schema.optional(Schema.String),
+      voice_query: Schema.optional(Schema.String),
+      conversation: Schema.optional(Schema.Boolean),
+      conversation_model_id: Schema.optional(Schema.String),
+      conversation_id: Schema.optional(Schema.String),
+      validate_field_names: Schema.optional(Schema.Boolean),
+      collection: Schema.optional(Schema.String),
+      "x-typesense-api-key": Schema.optional(Schema.String),
+      rerank_hybrid_matches: Schema.optional(Schema.Boolean),
+    }),
+  ),
+}).pipe(T.Http({ method: "POST", path: "/multi_search" }));
+export type MultiSearchInput = typeof MultiSearchInput.Type;
+
+// Output Schema
+export const MultiSearchOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  results: Schema.Array(
+    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)),
+      code: Schema.optional(Schema.Number),
+      error: 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,
+    }),
+  ),
+});
+export type MultiSearchOutput = typeof MultiSearchOutput.Type;
+
+// The operation
+/**
+ * send multiple search requests in a single HTTP request
+ *
+ * This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can also use this feature to do a federated search across multiple collections in a single HTTP request.
+ */
+export const multiSearch = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: MultiSearchInput,
+  outputSchema: MultiSearchOutput,
+  errors: [BadRequest] as const,
+}));

package/src/operations/retrieveAPIStats.ts

@@ -0,0 +1,40 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const RetrieveAPIStatsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {},
+).pipe(T.Http({ method: "GET", path: "/stats.json" }));
+export type RetrieveAPIStatsInput = typeof RetrieveAPIStatsInput.Type;
+
+// Output Schema
+export const RetrieveAPIStatsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {
+    delete_latency_ms: Schema.optional(Schema.Number),
+    delete_requests_per_second: Schema.optional(Schema.Number),
+    import_latency_ms: Schema.optional(Schema.Number),
+    import_requests_per_second: Schema.optional(Schema.Number),
+    latency_ms: Schema.optional(Schema.Unknown),
+    overloaded_requests_per_second: Schema.optional(Schema.Number),
+    pending_write_batches: Schema.optional(Schema.Number),
+    requests_per_second: Schema.optional(Schema.Unknown),
+    search_latency_ms: Schema.optional(Schema.Number),
+    search_requests_per_second: Schema.optional(Schema.Number),
+    total_requests_per_second: Schema.optional(Schema.Number),
+    write_latency_ms: Schema.optional(Schema.Number),
+    write_requests_per_second: Schema.optional(Schema.Number),
+  },
+);
+export type RetrieveAPIStatsOutput = typeof RetrieveAPIStatsOutput.Type;
+
+// The operation
+/**
+ * Get stats about API endpoints.
+ *
+ * Retrieve the stats about API endpoints.
+ */
+export const retrieveAPIStats = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RetrieveAPIStatsInput,
+  outputSchema: RetrieveAPIStatsOutput,
+}));

package/src/operations/retrieveAllConversationModels.ts

@@ -0,0 +1,33 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const RetrieveAllConversationModelsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+    T.Http({ method: "GET", path: "/conversations/models" }),
+  );
+export type RetrieveAllConversationModelsInput =
+  typeof RetrieveAllConversationModelsInput.Type;
+
+// Output Schema
+export const RetrieveAllConversationModelsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+    Schema.Struct({
+      id: Schema.String,
+    }),
+  );
+export type RetrieveAllConversationModelsOutput =
+  typeof RetrieveAllConversationModelsOutput.Type;
+
+// The operation
+/**
+ * List all conversation models
+ *
+ * Retrieve all conversation models
+ */
+export const retrieveAllConversationModels =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: RetrieveAllConversationModelsInput,
+    outputSchema: RetrieveAllConversationModelsOutput,
+  }));

package/src/operations/retrieveAllNLSearchModels.ts

@@ -0,0 +1,34 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const RetrieveAllNLSearchModelsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+    T.Http({ method: "GET", path: "/nl_search_models" }),
+  );
+export type RetrieveAllNLSearchModelsInput =
+  typeof RetrieveAllNLSearchModelsInput.Type;
+
+// Output Schema
+export const RetrieveAllNLSearchModelsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+    Schema.Struct({
+      id: Schema.String,
+    }),
+  );
+export type RetrieveAllNLSearchModelsOutput =
+  typeof RetrieveAllNLSearchModelsOutput.Type;
+
+// The operation
+/**
+ * List all NL search models
+ *
+ * Retrieve all NL search models.
+ */
+export const retrieveAllNLSearchModels = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveAllNLSearchModelsInput,
+    outputSchema: RetrieveAllNLSearchModelsOutput,
+  }),
+);

package/src/operations/retrieveAllPresets.ts

@@ -0,0 +1,33 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const RetrieveAllPresetsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+    T.Http({ method: "GET", path: "/presets" }),
+  );
+export type RetrieveAllPresetsInput = typeof RetrieveAllPresetsInput.Type;
+
+// Output Schema
+export const RetrieveAllPresetsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    presets: Schema.Array(
+      Schema.Struct({
+        value: Schema.Unknown,
+        name: Schema.String,
+      }),
+    ),
+  });
+export type RetrieveAllPresetsOutput = typeof RetrieveAllPresetsOutput.Type;
+
+// The operation
+/**
+ * Retrieves all presets.
+ *
+ * Retrieve the details of all presets
+ */
+export const retrieveAllPresets = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RetrieveAllPresetsInput,
+  outputSchema: RetrieveAllPresetsOutput,
+}));

package/src/operations/retrieveAnalyticsRule.ts

@@ -0,0 +1,55 @@
+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 const RetrieveAnalyticsRuleInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    ruleName: Schema.String.pipe(T.PathParam()),
+  }).pipe(T.Http({ method: "GET", path: "/analytics/rules/{ruleName}" }));
+export type RetrieveAnalyticsRuleInput = typeof RetrieveAnalyticsRuleInput.Type;
+
+// Output Schema
+export const RetrieveAnalyticsRuleOutput =
+  /*@__PURE__*/ /*#__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),
+      }),
+    ),
+  });
+export type RetrieveAnalyticsRuleOutput =
+  typeof RetrieveAnalyticsRuleOutput.Type;
+
+// 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__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveAnalyticsRuleInput,
+    outputSchema: RetrieveAnalyticsRuleOutput,
+    errors: [NotFound] as const,
+  }),
+);

package/src/operations/retrieveAnalyticsRules.ts

@@ -0,0 +1,56 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const RetrieveAnalyticsRulesInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    rule_tag: Schema.optional(Schema.String),
+  }).pipe(T.Http({ method: "GET", path: "/analytics/rules" }));
+export type RetrieveAnalyticsRulesInput =
+  typeof RetrieveAnalyticsRulesInput.Type;
+
+// Output Schema
+export const RetrieveAnalyticsRulesOutput =
+  /*@__PURE__*/ /*#__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),
+        }),
+      ),
+    }),
+  );
+export type RetrieveAnalyticsRulesOutput =
+  typeof RetrieveAnalyticsRulesOutput.Type;
+
+// 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__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveAnalyticsRulesInput,
+    outputSchema: RetrieveAnalyticsRulesOutput,
+  }),
+);

package/src/operations/retrieveConversationModel.ts

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

package/src/operations/retrieveCurationSet.ts

@@ -0,0 +1,68 @@
+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 const RetrieveCurationSetInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    curationSetName: Schema.String.pipe(T.PathParam()),
+  }).pipe(T.Http({ method: "GET", path: "/curation_sets/{curationSetName}" }));
+export type RetrieveCurationSetInput = typeof RetrieveCurationSetInput.Type;
+
+// Output Schema
+export const RetrieveCurationSetOutput =
+  /*@__PURE__*/ /*#__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,
+  });
+export type RetrieveCurationSetOutput = typeof RetrieveCurationSetOutput.Type;
+
+// 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__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RetrieveCurationSetInput,
+  outputSchema: RetrieveCurationSetOutput,
+  errors: [NotFound] as const,
+}));