@distilled.cloud/typesense 0.0.0 → 0.14.0

package/src/operations/searchCollection.ts

@@ -0,0 +1,209 @@
+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 const SearchCollectionInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  collectionName: Schema.String.pipe(T.PathParam()),
+  searchParameters: Schema.String,
+}).pipe(
+  T.Http({
+    method: "GET",
+    path: "/collections/{collectionName}/documents/search",
+  }),
+);
+export type SearchCollectionInput = typeof SearchCollectionInput.Type;
+
+// Output Schema
+export const SearchCollectionOutput = /*@__PURE__*/ /*#__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)),
+  },
+);
+export type SearchCollectionOutput = typeof SearchCollectionOutput.Type;
+
+// 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__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: SearchCollectionInput,
+  outputSchema: SearchCollectionOutput,
+  errors: [BadRequest, NotFound] as const,
+}));

package/src/operations/takeSnapshot.ts

@@ -0,0 +1,28 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const TakeSnapshotInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  snapshot_path: Schema.String,
+}).pipe(T.Http({ method: "POST", path: "/operations/snapshot" }));
+export type TakeSnapshotInput = typeof TakeSnapshotInput.Type;
+
+// Output Schema
+export const TakeSnapshotOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  success: Schema.Boolean,
+});
+export type TakeSnapshotOutput = typeof TakeSnapshotOutput.Type;
+
+// 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__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: TakeSnapshotInput,
+  outputSchema: TakeSnapshotOutput,
+}));

package/src/operations/toggleSlowRequestLog.ts

@@ -0,0 +1,30 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const ToggleSlowRequestLogInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    "log-slow-requests-time-ms": Schema.Number,
+  }).pipe(T.Http({ method: "POST", path: "/config" }));
+export type ToggleSlowRequestLogInput = typeof ToggleSlowRequestLogInput.Type;
+
+// Output Schema
+export const ToggleSlowRequestLogOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    success: Schema.Boolean,
+  });
+export type ToggleSlowRequestLogOutput = typeof ToggleSlowRequestLogOutput.Type;
+
+// 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__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: ToggleSlowRequestLogInput,
+    outputSchema: ToggleSlowRequestLogOutput,
+  }),
+);

package/src/operations/updateCollection.ts

@@ -0,0 +1,116 @@
+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";
+
+// Input Schema
+export const UpdateCollectionInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  collectionName: Schema.String.pipe(T.PathParam()),
+  fields: 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}" }));
+export type UpdateCollectionInput = typeof UpdateCollectionInput.Type;
+
+// Output Schema
+export const UpdateCollectionOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {
+    fields: 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),
+  },
+);
+export type UpdateCollectionOutput = typeof UpdateCollectionOutput.Type;
+
+// 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__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: UpdateCollectionInput,
+  outputSchema: UpdateCollectionOutput,
+  errors: [BadRequest, NotFound] as const,
+}));

package/src/operations/updateConversationModel.ts

@@ -0,0 +1,44 @@
+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";
+
+// Input Schema
+export const UpdateConversationModelInput =
+  /*@__PURE__*/ /*#__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}" }));
+export type UpdateConversationModelInput =
+  typeof UpdateConversationModelInput.Type;
+
+// Output Schema
+export const UpdateConversationModelOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+  });
+export type UpdateConversationModelOutput =
+  typeof UpdateConversationModelOutput.Type;
+
+// The operation
+/**
+ * Update a conversation model
+ *
+ * @param modelId - The id of the conversation model to update
+ */
+export const updateConversationModel = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: UpdateConversationModelInput,
+    outputSchema: UpdateConversationModelOutput,
+    errors: [BadRequest, NotFound] as const,
+  }),
+);

package/src/operations/updateDocument.ts

@@ -0,0 +1,37 @@
+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 UpdateDocumentInput = /*@__PURE__*/ /*#__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}",
+  }),
+);
+export type UpdateDocumentInput = typeof UpdateDocumentInput.Type;
+
+// Output Schema
+export const UpdateDocumentOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Unknown;
+export type UpdateDocumentOutput = typeof UpdateDocumentOutput.Type;
+
+// 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__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: UpdateDocumentInput,
+  outputSchema: UpdateDocumentOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/updateDocuments.ts

@@ -0,0 +1,33 @@
+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 const UpdateDocumentsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  collectionName: Schema.String.pipe(T.PathParam()),
+  updateDocumentsParameters: Schema.optional(Schema.String),
+}).pipe(
+  T.Http({ method: "PATCH", path: "/collections/{collectionName}/documents" }),
+);
+export type UpdateDocumentsInput = typeof UpdateDocumentsInput.Type;
+
+// Output Schema
+export const UpdateDocumentsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  num_updated: Schema.Number,
+});
+export type UpdateDocumentsOutput = typeof UpdateDocumentsOutput.Type;
+
+// The operation
+/**
+ * Update documents with conditional query
+ *
+ * The filter_by query parameter is used to filter to specify a condition against which the documents are matched. The request body contains the fields that should be updated for any documents that match the filter condition. This endpoint is only available if the Typesense server is version `0.25.0.rc12` or later.
+ *
+ * @param collectionName - The name of the collection to update documents in
+ */
+export const updateDocuments = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: UpdateDocumentsInput,
+  outputSchema: UpdateDocumentsOutput,
+  errors: [BadRequest, NotFound] as const,
+}));

package/src/operations/updateNLSearchModel.ts

@@ -0,0 +1,32 @@
+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 const UpdateNLSearchModelInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    modelId: Schema.String.pipe(T.PathParam()),
+  }).pipe(T.Http({ method: "PUT", path: "/nl_search_models/{modelId}" }));
+export type UpdateNLSearchModelInput = typeof UpdateNLSearchModelInput.Type;
+
+// Output Schema
+export const UpdateNLSearchModelOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+  });
+export type UpdateNLSearchModelOutput = typeof UpdateNLSearchModelOutput.Type;
+
+// The operation
+/**
+ * Update a NL search model
+ *
+ * Update an existing NL search model.
+ *
+ * @param modelId - The ID of the NL search model to update
+ */
+export const updateNLSearchModel = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: UpdateNLSearchModelInput,
+  outputSchema: UpdateNLSearchModelOutput,
+  errors: [BadRequest, NotFound] as const,
+}));

package/src/operations/upsertAlias.ts

@@ -0,0 +1,32 @@
+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 const UpsertAliasInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  aliasName: Schema.String.pipe(T.PathParam()),
+  collection_name: Schema.String,
+}).pipe(T.Http({ method: "PUT", path: "/aliases/{aliasName}" }));
+export type UpsertAliasInput = typeof UpsertAliasInput.Type;
+
+// Output Schema
+export const UpsertAliasOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  name: Schema.String,
+  collection_name: Schema.String,
+});
+export type UpsertAliasOutput = typeof UpsertAliasOutput.Type;
+
+// The operation
+/**
+ * Create or update a collection alias
+ *
+ * Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you're familiar with symbolic links on Linux, it's very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code.
+ *
+ * @param aliasName - The name of the alias to create/update
+ */
+export const upsertAlias = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: UpsertAliasInput,
+  outputSchema: UpsertAliasOutput,
+  errors: [BadRequest, NotFound] as const,
+}));

package/src/operations/upsertAnalyticsRule.ts

@@ -0,0 +1,65 @@
+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 UpsertAnalyticsRuleInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    ruleName: Schema.String.pipe(T.PathParam()),
+    name: Schema.optional(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),
+      }),
+    ),
+  }).pipe(T.Http({ method: "PUT", path: "/analytics/rules/{ruleName}" }));
+export type UpsertAnalyticsRuleInput = typeof UpsertAnalyticsRuleInput.Type;
+
+// Output Schema
+export const UpsertAnalyticsRuleOutput =
+  /*@__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 UpsertAnalyticsRuleOutput = typeof UpsertAnalyticsRuleOutput.Type;
+
+// The operation
+/**
+ * Upserts an analytics rule
+ *
+ * Upserts an analytics rule with the given name.
+ *
+ * @param ruleName - The name of the analytics rule to upsert
+ */
+export const upsertAnalyticsRule = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: UpsertAnalyticsRuleInput,
+  outputSchema: UpsertAnalyticsRuleOutput,
+  errors: [BadRequest] as const,
+}));