bem-ai-sdk 0.26.0 → 0.27.0

package/resources/entities/entities.mjs

@@ -0,0 +1,88 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as SynonymsAPI from "./synonyms.mjs";
+import { Synonyms } from "./synonyms.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Entities extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.synonyms = new SynonymsAPI.Synonyms(this._client);
+    }
+    /**
+     * Update Entity
+     *
+     * @example
+     * ```ts
+     * const entity = await client.entities.update('id', {
+     *   status: 'approved',
+     * });
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.patch(path `/v3/entities/${id}`, { body, ...options });
+    }
+    /**
+     * Bulk Seed Entities
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.bulkCreate({
+     *   entities: [
+     *     {
+     *       canonical: 'Acme Corporation',
+     *       type: 'organization',
+     *       description: 'Industrial conglomerate',
+     *       synonyms: ['ACME', 'Acme Corp'],
+     *       attributes: { headquarters: 'Springfield' },
+     *     },
+     *   ],
+     *   onConflict: 'merge',
+     * });
+     * ```
+     */
+    bulkCreate(body, options) {
+        return this._client.post('/v3/entities/bulk', { body, ...options });
+    }
+    /**
+     * Bulk Validate Entities
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.bulkValidate({
+     *   entityIDs: ['ent_2abc', 'ent_2def'],
+     *   status: 'approved',
+     * });
+     * ```
+     */
+    bulkValidate(body, options) {
+        return this._client.post('/v3/entities/bulk-validate', { body, ...options });
+    }
+    /**
+     * Get an Entity's Relations
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.retrieveRelations(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveRelations(id, query = {}, options) {
+        return this._client.get(path `/v3/entities/${id}/relations`, { query, ...options });
+    }
+    /**
+     * Get Seed Job Status
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.retrieveSeedStatus(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveSeedStatus(id, options) {
+        return this._client.get(path `/v3/entities/seed/${id}`, options);
+    }
+}
+Entities.Synonyms = Synonyms;
+//# sourceMappingURL=entities.mjs.map

package/resources/entities/entities.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.mjs","sourceRoot":"","sources":["../../src/resources/entities/entities.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAA6D,QAAQ,EAAE,uBAAmB;AAGjG,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwF1E,CAAC;IAtFC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,EAAU,EACV,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;OASG;IACH,kBAAkB,CAAC,EAAU,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AAugBD,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC"}

package/resources/entities/index.d.mts

@@ -0,0 +1,3 @@
+export { Entities, type EntityUpdateResponse, type EntityBulkCreateResponse, type EntityBulkValidateResponse, type EntityRetrieveRelationsResponse, type EntityRetrieveSeedStatusResponse, type EntityUpdateParams, type EntityBulkCreateParams, type EntityBulkValidateParams, type EntityRetrieveRelationsParams, } from "./entities.mjs";
+export { Synonyms, type SynonymAddResponse, type SynonymAddParams, type SynonymRemoveParams, } from "./synonyms.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/entities/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/entities/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,EACrC,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,GACnC,uBAAmB;AACpB,OAAO,EACL,QAAQ,EACR,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,GACzB,uBAAmB"}

package/resources/entities/index.d.ts

@@ -0,0 +1,3 @@
+export { Entities, type EntityUpdateResponse, type EntityBulkCreateResponse, type EntityBulkValidateResponse, type EntityRetrieveRelationsResponse, type EntityRetrieveSeedStatusResponse, type EntityUpdateParams, type EntityBulkCreateParams, type EntityBulkValidateParams, type EntityRetrieveRelationsParams, } from "./entities.js";
+export { Synonyms, type SynonymAddResponse, type SynonymAddParams, type SynonymRemoveParams, } from "./synonyms.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/entities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/entities/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,EACrC,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,GACnC,sBAAmB;AACpB,OAAO,EACL,QAAQ,EACR,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,GACzB,sBAAmB"}

package/resources/entities/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Synonyms = exports.Entities = void 0;
+var entities_1 = require("./entities.js");
+Object.defineProperty(exports, "Entities", { enumerable: true, get: function () { return entities_1.Entities; } });
+var synonyms_1 = require("./synonyms.js");
+Object.defineProperty(exports, "Synonyms", { enumerable: true, get: function () { return synonyms_1.Synonyms; } });
+//# sourceMappingURL=index.js.map

package/resources/entities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/entities/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,0CAWoB;AAVlB,oGAAA,QAAQ,OAAA;AAWV,0CAKoB;AAJlB,oGAAA,QAAQ,OAAA"}

package/resources/entities/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Entities, } from "./entities.mjs";
+export { Synonyms, } from "./synonyms.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/entities/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/entities/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,QAAQ,GAUT,uBAAmB;AACpB,OAAO,EACL,QAAQ,GAIT,uBAAmB"}

package/resources/entities/synonyms.d.mts

@@ -0,0 +1,109 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Manage the human-readable surface forms (synonyms) attached to a canonical
+ * entity. Synonyms feed the matcher's exact-match path, so adding the right
+ * synonyms improves cross-document entity resolution.
+ *
+ * - **`POST /v3/entities/{id}/synonyms`** attaches a `customer_defined`
+ *   synonym. If the same normalized form already exists as an `extracted`
+ *   synonym, it is upgraded to `customer_defined` (so the matcher weights it
+ *   higher); an existing customer/SME synonym is returned unchanged.
+ * - **`DELETE /v3/entities/{id}/synonyms/{synonymID}`** soft-deletes a
+ *   synonym. Only `customer_defined` and `sme_approved` synonyms are
+ *   deletable; `extracted` synonyms are resolver-owned and the request is
+ *   rejected with `409 Conflict`.
+ *
+ * A merged-away entity id transparently resolves to its surviving canonical
+ * entity, so a synonym added to a stale id lands on the entity that persists.
+ */
+export declare class Synonyms extends APIResource {
+    /**
+     * Add a Synonym to an Entity
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.synonyms.add('id', {
+     *   text: 'ACME Corporation',
+     *   locale: 'en-US',
+     * });
+     * ```
+     */
+    add(id: string, params: SynonymAddParams, options?: RequestOptions): APIPromise<SynonymAddResponse>;
+    /**
+     * Remove a Synonym from an Entity
+     *
+     * @example
+     * ```ts
+     * await client.entities.synonyms.remove('synonymID', {
+     *   id: 'id',
+     * });
+     * ```
+     */
+    remove(synonymID: string, params: SynonymRemoveParams, options?: RequestOptions): APIPromise<void>;
+}
+/**
+ * One synonym attached to an entity.
+ */
+export interface SynonymAddResponse {
+    /**
+     * Creation timestamp of the synonym (RFC 3339).
+     */
+    createdAt: string;
+    /**
+     * Lowercased, whitespace-folded form of `text`.
+     */
+    normalizedText: string;
+    /**
+     * Provenance of the synonym. `customer_defined` and `sme_approved` synonyms are
+     * deletable; `extracted` synonyms are resolver-owned and cannot be deleted.
+     */
+    source: 'extracted' | 'customer_defined' | 'sme_approved';
+    /**
+     * Stable public identifier for the synonym (`esn_...`).
+     */
+    synonymID: string;
+    /**
+     * The human-readable synonym as authored.
+     */
+    text: string;
+    /**
+     * Optional BCP 47 locale tag, when one was supplied.
+     */
+    locale?: string;
+}
+export interface SynonymAddParams {
+    /**
+     * Body param: The human-readable synonym surface form to attach (e.g. `Acme Corp`,
+     * `ACME`). It is normalized (lowercased, whitespace-folded) for the uniqueness key
+     * and the matcher's exact-match path.
+     */
+    text: string;
+    /**
+     * Query param: Optional bucket public ID (`bkt_...`) to scope the entity lookup to
+     * one bucket. Omit for the unscoped (all account+environment) view.
+     */
+    bucket?: string;
+    /**
+     * Body param: Optional BCP 47 locale tag (e.g. `en-US`) for language-specific
+     * synonyms.
+     */
+    locale?: string;
+}
+export interface SynonymRemoveParams {
+    /**
+     * Path param: Entity public ID (`ent_...`). A merged-away id resolves to the
+     * surviving entity.
+     */
+    id: string;
+    /**
+     * Query param: Optional bucket public ID (`bkt_...`) to scope the entity lookup to
+     * one bucket. Omit for the unscoped (all account+environment) view.
+     */
+    bucket?: string;
+}
+export declare namespace Synonyms {
+    export { type SynonymAddResponse as SynonymAddResponse, type SynonymAddParams as SynonymAddParams, type SynonymRemoveParams as SynonymRemoveParams, };
+}
+//# sourceMappingURL=synonyms.d.mts.map

package/resources/entities/synonyms.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"synonyms.d.mts","sourceRoot":"","sources":["../../src/resources/entities/synonyms.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAKnG;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAQnG;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,WAAW,GAAG,kBAAkB,GAAG,cAAc,CAAC;IAE1D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/entities/synonyms.d.ts

@@ -0,0 +1,109 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Manage the human-readable surface forms (synonyms) attached to a canonical
+ * entity. Synonyms feed the matcher's exact-match path, so adding the right
+ * synonyms improves cross-document entity resolution.
+ *
+ * - **`POST /v3/entities/{id}/synonyms`** attaches a `customer_defined`
+ *   synonym. If the same normalized form already exists as an `extracted`
+ *   synonym, it is upgraded to `customer_defined` (so the matcher weights it
+ *   higher); an existing customer/SME synonym is returned unchanged.
+ * - **`DELETE /v3/entities/{id}/synonyms/{synonymID}`** soft-deletes a
+ *   synonym. Only `customer_defined` and `sme_approved` synonyms are
+ *   deletable; `extracted` synonyms are resolver-owned and the request is
+ *   rejected with `409 Conflict`.
+ *
+ * A merged-away entity id transparently resolves to its surviving canonical
+ * entity, so a synonym added to a stale id lands on the entity that persists.
+ */
+export declare class Synonyms extends APIResource {
+    /**
+     * Add a Synonym to an Entity
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.synonyms.add('id', {
+     *   text: 'ACME Corporation',
+     *   locale: 'en-US',
+     * });
+     * ```
+     */
+    add(id: string, params: SynonymAddParams, options?: RequestOptions): APIPromise<SynonymAddResponse>;
+    /**
+     * Remove a Synonym from an Entity
+     *
+     * @example
+     * ```ts
+     * await client.entities.synonyms.remove('synonymID', {
+     *   id: 'id',
+     * });
+     * ```
+     */
+    remove(synonymID: string, params: SynonymRemoveParams, options?: RequestOptions): APIPromise<void>;
+}
+/**
+ * One synonym attached to an entity.
+ */
+export interface SynonymAddResponse {
+    /**
+     * Creation timestamp of the synonym (RFC 3339).
+     */
+    createdAt: string;
+    /**
+     * Lowercased, whitespace-folded form of `text`.
+     */
+    normalizedText: string;
+    /**
+     * Provenance of the synonym. `customer_defined` and `sme_approved` synonyms are
+     * deletable; `extracted` synonyms are resolver-owned and cannot be deleted.
+     */
+    source: 'extracted' | 'customer_defined' | 'sme_approved';
+    /**
+     * Stable public identifier for the synonym (`esn_...`).
+     */
+    synonymID: string;
+    /**
+     * The human-readable synonym as authored.
+     */
+    text: string;
+    /**
+     * Optional BCP 47 locale tag, when one was supplied.
+     */
+    locale?: string;
+}
+export interface SynonymAddParams {
+    /**
+     * Body param: The human-readable synonym surface form to attach (e.g. `Acme Corp`,
+     * `ACME`). It is normalized (lowercased, whitespace-folded) for the uniqueness key
+     * and the matcher's exact-match path.
+     */
+    text: string;
+    /**
+     * Query param: Optional bucket public ID (`bkt_...`) to scope the entity lookup to
+     * one bucket. Omit for the unscoped (all account+environment) view.
+     */
+    bucket?: string;
+    /**
+     * Body param: Optional BCP 47 locale tag (e.g. `en-US`) for language-specific
+     * synonyms.
+     */
+    locale?: string;
+}
+export interface SynonymRemoveParams {
+    /**
+     * Path param: Entity public ID (`ent_...`). A merged-away id resolves to the
+     * surviving entity.
+     */
+    id: string;
+    /**
+     * Query param: Optional bucket public ID (`bkt_...`) to scope the entity lookup to
+     * one bucket. Omit for the unscoped (all account+environment) view.
+     */
+    bucket?: string;
+}
+export declare namespace Synonyms {
+    export { type SynonymAddResponse as SynonymAddResponse, type SynonymAddParams as SynonymAddParams, type SynonymRemoveParams as SynonymRemoveParams, };
+}
+//# sourceMappingURL=synonyms.d.ts.map

package/resources/entities/synonyms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"synonyms.d.ts","sourceRoot":"","sources":["../../src/resources/entities/synonyms.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAKnG;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAQnG;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,WAAW,GAAG,kBAAkB,GAAG,cAAc,CAAC;IAE1D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/entities/synonyms.js

@@ -0,0 +1,61 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Synonyms = void 0;
+const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Manage the human-readable surface forms (synonyms) attached to a canonical
+ * entity. Synonyms feed the matcher's exact-match path, so adding the right
+ * synonyms improves cross-document entity resolution.
+ *
+ * - **`POST /v3/entities/{id}/synonyms`** attaches a `customer_defined`
+ *   synonym. If the same normalized form already exists as an `extracted`
+ *   synonym, it is upgraded to `customer_defined` (so the matcher weights it
+ *   higher); an existing customer/SME synonym is returned unchanged.
+ * - **`DELETE /v3/entities/{id}/synonyms/{synonymID}`** soft-deletes a
+ *   synonym. Only `customer_defined` and `sme_approved` synonyms are
+ *   deletable; `extracted` synonyms are resolver-owned and the request is
+ *   rejected with `409 Conflict`.
+ *
+ * A merged-away entity id transparently resolves to its surviving canonical
+ * entity, so a synonym added to a stale id lands on the entity that persists.
+ */
+class Synonyms extends resource_1.APIResource {
+    /**
+     * Add a Synonym to an Entity
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.synonyms.add('id', {
+     *   text: 'ACME Corporation',
+     *   locale: 'en-US',
+     * });
+     * ```
+     */
+    add(id, params, options) {
+        const { bucket, ...body } = params;
+        return this._client.post((0, path_1.path) `/v3/entities/${id}/synonyms`, { query: { bucket }, body, ...options });
+    }
+    /**
+     * Remove a Synonym from an Entity
+     *
+     * @example
+     * ```ts
+     * await client.entities.synonyms.remove('synonymID', {
+     *   id: 'id',
+     * });
+     * ```
+     */
+    remove(synonymID, params, options) {
+        const { id, bucket } = params;
+        return this._client.delete((0, path_1.path) `/v3/entities/${id}/synonyms/${synonymID}`, {
+            query: { bucket },
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+exports.Synonyms = Synonyms;
+//# sourceMappingURL=synonyms.js.map

package/resources/entities/synonyms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"synonyms.js","sourceRoot":"","sources":["../../src/resources/entities/synonyms.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,EAAU,EAAE,MAAwB,EAAE,OAAwB;QAChE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,MAA2B,EAAE,OAAwB;QAC7E,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,aAAa,SAAS,EAAE,EAAE;YACzE,KAAK,EAAE,EAAE,MAAM,EAAE;YACjB,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAnCD,4BAmCC"}

package/resources/entities/synonyms.mjs

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Manage the human-readable surface forms (synonyms) attached to a canonical
+ * entity. Synonyms feed the matcher's exact-match path, so adding the right
+ * synonyms improves cross-document entity resolution.
+ *
+ * - **`POST /v3/entities/{id}/synonyms`** attaches a `customer_defined`
+ *   synonym. If the same normalized form already exists as an `extracted`
+ *   synonym, it is upgraded to `customer_defined` (so the matcher weights it
+ *   higher); an existing customer/SME synonym is returned unchanged.
+ * - **`DELETE /v3/entities/{id}/synonyms/{synonymID}`** soft-deletes a
+ *   synonym. Only `customer_defined` and `sme_approved` synonyms are
+ *   deletable; `extracted` synonyms are resolver-owned and the request is
+ *   rejected with `409 Conflict`.
+ *
+ * A merged-away entity id transparently resolves to its surviving canonical
+ * entity, so a synonym added to a stale id lands on the entity that persists.
+ */
+export class Synonyms extends APIResource {
+    /**
+     * Add a Synonym to an Entity
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.synonyms.add('id', {
+     *   text: 'ACME Corporation',
+     *   locale: 'en-US',
+     * });
+     * ```
+     */
+    add(id, params, options) {
+        const { bucket, ...body } = params;
+        return this._client.post(path `/v3/entities/${id}/synonyms`, { query: { bucket }, body, ...options });
+    }
+    /**
+     * Remove a Synonym from an Entity
+     *
+     * @example
+     * ```ts
+     * await client.entities.synonyms.remove('synonymID', {
+     *   id: 'id',
+     * });
+     * ```
+     */
+    remove(synonymID, params, options) {
+        const { id, bucket } = params;
+        return this._client.delete(path `/v3/entities/${id}/synonyms/${synonymID}`, {
+            query: { bucket },
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+//# sourceMappingURL=synonyms.mjs.map

package/resources/entities/synonyms.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"synonyms.mjs","sourceRoot":"","sources":["../../src/resources/entities/synonyms.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,EAAU,EAAE,MAAwB,EAAE,OAAwB;QAChE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,MAA2B,EAAE,OAAwB;QAC7E,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,aAAa,SAAS,EAAE,EAAE;YACzE,KAAK,EAAE,EAAE,MAAM,EAAE;YACjB,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/entities.d.mts

@@ -0,0 +1,2 @@
+export * from "./entities/index.mjs";
+//# sourceMappingURL=entities.d.mts.map

package/resources/entities.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.mts","sourceRoot":"","sources":["../src/resources/entities.ts"],"names":[],"mappings":"AAEA,qCAAiC"}

package/resources/entities.d.ts

@@ -0,0 +1,2 @@
+export * from "./entities/index.js";
+//# sourceMappingURL=entities.d.ts.map

package/resources/entities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../src/resources/entities.ts"],"names":[],"mappings":"AAEA,oCAAiC"}

package/resources/entities.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./entities/index.js"), exports);
+//# sourceMappingURL=entities.js.map

package/resources/entities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.js","sourceRoot":"","sources":["../src/resources/entities.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8DAAiC"}

package/resources/entities.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./entities/index.mjs";
+//# sourceMappingURL=entities.mjs.map

package/resources/entities.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.mjs","sourceRoot":"","sources":["../src/resources/entities.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,qCAAiC"}