bem-ai-sdk 0.28.0 → 0.29.0

package/src/resources/entities/entities.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as EntitiesAPI from './entities';
 import * as SynonymsAPI from './synonyms';
 import { SynonymAddParams, SynonymAddResponse, SynonymRemoveParams, Synonyms } from './synonyms';
 import { APIPromise } from '../../core/api-promise';
@@ -98,6 +99,60 @@ export class Entities extends APIResource {
   }
 }
 
+/**
+ * A compact view of an entity sitting on the far end of a relation edge — the
+ * stable public id, the canonical name, and the effective type. The full entity is
+ * fetched separately via the entity detail / File System endpoints.
+ */
+export interface RelatedEntity {
+  /**
+   * Stable public identifier for the entity (`ent_...`).
+   */
+  id: string;
+
+  /**
+   * Canonical (most descriptive) surface form of the entity.
+   */
+  canonical: string;
+
+  /**
+   * Hops from the queried entity. This endpoint returns direct relations, so this is
+   * 1 (a self-loop's far end is the queried entity itself, 0).
+   */
+  depth: number;
+
+  /**
+   * Effective entity type.
+   */
+  type: string;
+}
+
+/**
+ * The outcome of seeding one row.
+ */
+export interface SeedRowResult {
+  /**
+   * The canonical name from the input row.
+   */
+  canonical: string;
+
+  /**
+   * What happened to this row: `created` (new entity), `merged-with` (matched an
+   * existing entity), or `rejected` (see `reason`).
+   */
+  outcome: 'created' | 'merged-with' | 'rejected';
+
+  /**
+   * Public ID (`ent_...`) of the created or merged entity. Absent when rejected.
+   */
+  entityID?: string;
+
+  /**
+   * Human-readable explanation when `outcome` is `rejected`.
+   */
+  reason?: string;
+}
+
 /**
  * An entity record, including its curation status and assigned type.
  */
@@ -170,7 +225,7 @@ export interface EntityBulkCreateResponse {
   /**
    * Per-row outcomes, in request order.
    */
-  results: Array<EntityBulkCreateResponse.Result>;
+  results: Array<SeedRowResult>;
 
   /**
    * Per-outcome tally across a batch.
@@ -179,32 +234,6 @@ export interface EntityBulkCreateResponse {
 }
 
 export namespace EntityBulkCreateResponse {
-  /**
-   * The outcome of seeding one row.
-   */
-  export interface Result {
-    /**
-     * The canonical name from the input row.
-     */
-    canonical: string;
-
-    /**
-     * What happened to this row: `created` (new entity), `merged-with` (matched an
-     * existing entity), or `rejected` (see `reason`).
-     */
-    outcome: 'created' | 'merged-with' | 'rejected';
-
-    /**
-     * Public ID (`ent_...`) of the created or merged entity. Absent when rejected.
-     */
-    entityID?: string;
-
-    /**
-     * Human-readable explanation when `outcome` is `rejected`.
-     */
-    reason?: string;
-  }
-
   /**
    * Per-outcome tally across a batch.
    */
@@ -330,37 +359,7 @@ export namespace EntityRetrieveRelationsResponse {
      * stable public id, the canonical name, and the effective type. The full entity is
      * fetched separately via the entity detail / File System endpoints.
      */
-    sourceEntity: Inbound.SourceEntity;
-  }
-
-  export namespace Inbound {
-    /**
-     * A compact view of an entity sitting on the far end of a relation edge — the
-     * stable public id, the canonical name, and the effective type. The full entity is
-     * fetched separately via the entity detail / File System endpoints.
-     */
-    export interface SourceEntity {
-      /**
-       * Stable public identifier for the entity (`ent_...`).
-       */
-      id: string;
-
-      /**
-       * Canonical (most descriptive) surface form of the entity.
-       */
-      canonical: string;
-
-      /**
-       * Hops from the queried entity. This endpoint returns direct relations, so this is
-       * 1 (a self-loop's far end is the queried entity itself, 0).
-       */
-      depth: number;
-
-      /**
-       * Effective entity type.
-       */
-      type: string;
-    }
+    sourceEntity: EntitiesAPI.RelatedEntity;
   }
 
   /**
@@ -387,37 +386,7 @@ export namespace EntityRetrieveRelationsResponse {
      * stable public id, the canonical name, and the effective type. The full entity is
      * fetched separately via the entity detail / File System endpoints.
      */
-    targetEntity: Outbound.TargetEntity;
-  }
-
-  export namespace Outbound {
-    /**
-     * A compact view of an entity sitting on the far end of a relation edge — the
-     * stable public id, the canonical name, and the effective type. The full entity is
-     * fetched separately via the entity detail / File System endpoints.
-     */
-    export interface TargetEntity {
-      /**
-       * Stable public identifier for the entity (`ent_...`).
-       */
-      id: string;
-
-      /**
-       * Canonical (most descriptive) surface form of the entity.
-       */
-      canonical: string;
-
-      /**
-       * Hops from the queried entity. This endpoint returns direct relations, so this is
-       * 1 (a self-loop's far end is the queried entity itself, 0).
-       */
-      depth: number;
-
-      /**
-       * Effective entity type.
-       */
-      type: string;
-    }
+    targetEntity: EntitiesAPI.RelatedEntity;
   }
 }
 
@@ -463,35 +432,7 @@ export interface EntityRetrieveSeedStatusResponse {
   /**
    * Per-row outcomes. Present only once `status` is `completed`.
    */
-  results?: Array<EntityRetrieveSeedStatusResponse.Result>;
-}
-
-export namespace EntityRetrieveSeedStatusResponse {
-  /**
-   * The outcome of seeding one row.
-   */
-  export interface Result {
-    /**
-     * The canonical name from the input row.
-     */
-    canonical: string;
-
-    /**
-     * What happened to this row: `created` (new entity), `merged-with` (matched an
-     * existing entity), or `rejected` (see `reason`).
-     */
-    outcome: 'created' | 'merged-with' | 'rejected';
-
-    /**
-     * Public ID (`ent_...`) of the created or merged entity. Absent when rejected.
-     */
-    entityID?: string;
-
-    /**
-     * Human-readable explanation when `outcome` is `rejected`.
-     */
-    reason?: string;
-  }
+  results?: Array<SeedRowResult>;
 }
 
 export interface EntityUpdateParams {
@@ -631,6 +572,8 @@ Entities.Synonyms = Synonyms;
 
 export declare namespace Entities {
   export {
+    type RelatedEntity as RelatedEntity,
+    type SeedRowResult as SeedRowResult,
     type EntityUpdateResponse as EntityUpdateResponse,
     type EntityBulkCreateResponse as EntityBulkCreateResponse,
     type EntityBulkValidateResponse as EntityBulkValidateResponse,

package/src/resources/entities/index.ts

@@ -2,6 +2,8 @@
 
 export {
   Entities,
+  type RelatedEntity,
+  type SeedRowResult,
   type EntityUpdateResponse,
   type EntityBulkCreateResponse,
   type EntityBulkValidateResponse,

package/src/resources/entity-types/entity-types.ts

@@ -3,8 +3,8 @@
 import { APIResource } from '../../core/resource';
 import * as ReviewersAPI from './reviewers';
 import {
+  Reviewer,
   ReviewerAssignParams,
-  ReviewerAssignResponse,
   ReviewerListResponse,
   ReviewerRemoveParams,
   Reviewers,
@@ -48,7 +48,7 @@ export class EntityTypes extends APIResource {
    * });
    * ```
    */
-  create(body: EntityTypeCreateParams, options?: RequestOptions): APIPromise<EntityTypeCreateResponse> {
+  create(body: EntityTypeCreateParams, options?: RequestOptions): APIPromise<EntityType> {
     return this._client.post('/v3/entity-types', { body, ...options });
   }
 
@@ -62,7 +62,7 @@ export class EntityTypes extends APIResource {
    * );
    * ```
    */
-  retrieve(typeID: string, options?: RequestOptions): APIPromise<EntityTypeRetrieveResponse> {
+  retrieve(typeID: string, options?: RequestOptions): APIPromise<EntityType> {
     return this._client.get(path`/v3/entity-types/${typeID}`, options);
   }
 
@@ -76,11 +76,7 @@ export class EntityTypes extends APIResource {
    * );
    * ```
    */
-  update(
-    typeID: string,
-    body: EntityTypeUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<EntityTypeUpdateResponse> {
+  update(typeID: string, body: EntityTypeUpdateParams, options?: RequestOptions): APIPromise<EntityType> {
     return this._client.patch(path`/v3/entity-types/${typeID}`, { body, ...options });
   }
 
@@ -121,97 +117,7 @@ export class EntityTypes extends APIResource {
  * `parentTypeID`, and may carry per-type structured attribute metadata in
  * `attributeSchema` (for example `{"unit": "mg", "range": [0, 100]}`).
  */
-export interface EntityTypeCreateResponse {
-  /**
-   * Creation timestamp (RFC 3339).
-   */
-  createdAt: string;
-
-  /**
-   * Optional human-facing note about the type.
-   */
-  description: string;
-
-  /**
-   * Human-facing type name. Unique within an account+environment, and immutable once
-   * set.
-   */
-  name: string;
-
-  /**
-   * Public ID (`ety_...`) of the parent type, or an empty string when the type is
-   * top-level.
-   */
-  parentTypeID: string;
-
-  /**
-   * Stable public identifier for the entity type (`ety_...`).
-   */
-  typeID: string;
-
-  /**
-   * Last-update timestamp (RFC 3339).
-   */
-  updatedAt: string;
-
-  /**
-   * Optional per-type structured attribute metadata.
-   */
-  attributeSchema?: unknown;
-}
-
-/**
- * An EntityType is a customer-defined type in the knowledge-graph taxonomy, scoped
- * to an account+environment. Types may be organised into hierarchies via
- * `parentTypeID`, and may carry per-type structured attribute metadata in
- * `attributeSchema` (for example `{"unit": "mg", "range": [0, 100]}`).
- */
-export interface EntityTypeRetrieveResponse {
-  /**
-   * Creation timestamp (RFC 3339).
-   */
-  createdAt: string;
-
-  /**
-   * Optional human-facing note about the type.
-   */
-  description: string;
-
-  /**
-   * Human-facing type name. Unique within an account+environment, and immutable once
-   * set.
-   */
-  name: string;
-
-  /**
-   * Public ID (`ety_...`) of the parent type, or an empty string when the type is
-   * top-level.
-   */
-  parentTypeID: string;
-
-  /**
-   * Stable public identifier for the entity type (`ety_...`).
-   */
-  typeID: string;
-
-  /**
-   * Last-update timestamp (RFC 3339).
-   */
-  updatedAt: string;
-
-  /**
-   * Optional per-type structured attribute metadata.
-   */
-  attributeSchema?: unknown;
-}
-
-/**
- * An EntityType is a customer-defined type in the knowledge-graph taxonomy, scoped
- * to an account+environment. Types may be organised into hierarchies via
- * `parentTypeID`, and may carry per-type structured attribute metadata in
- * `attributeSchema` (for example `{"unit": "mg", "range": [0, 100]}`).
- */
-export interface EntityTypeUpdateResponse {
+export interface EntityType {
   /**
    * Creation timestamp (RFC 3339).
    */
@@ -254,7 +160,7 @@ export interface EntityTypeUpdateResponse {
  * Response body for listing entity types.
  */
 export interface EntityTypeListResponse {
-  entityTypes: Array<EntityTypeListResponse.EntityType>;
+  entityTypes: Array<EntityType>;
 
   /**
    * Total number of entity types matching the query, ignoring pagination.
@@ -262,53 +168,6 @@ export interface EntityTypeListResponse {
   totalCount: number;
 }
 
-export namespace EntityTypeListResponse {
-  /**
-   * An EntityType is a customer-defined type in the knowledge-graph taxonomy, scoped
-   * to an account+environment. Types may be organised into hierarchies via
-   * `parentTypeID`, and may carry per-type structured attribute metadata in
-   * `attributeSchema` (for example `{"unit": "mg", "range": [0, 100]}`).
-   */
-  export interface EntityType {
-    /**
-     * Creation timestamp (RFC 3339).
-     */
-    createdAt: string;
-
-    /**
-     * Optional human-facing note about the type.
-     */
-    description: string;
-
-    /**
-     * Human-facing type name. Unique within an account+environment, and immutable once
-     * set.
-     */
-    name: string;
-
-    /**
-     * Public ID (`ety_...`) of the parent type, or an empty string when the type is
-     * top-level.
-     */
-    parentTypeID: string;
-
-    /**
-     * Stable public identifier for the entity type (`ety_...`).
-     */
-    typeID: string;
-
-    /**
-     * Last-update timestamp (RFC 3339).
-     */
-    updatedAt: string;
-
-    /**
-     * Optional per-type structured attribute metadata.
-     */
-    attributeSchema?: unknown;
-  }
-}
-
 export interface EntityTypeCreateParams {
   /**
    * Type name. Required and unique within the account+environment.
@@ -377,9 +236,7 @@ EntityTypes.Reviewers = Reviewers;
 
 export declare namespace EntityTypes {
   export {
-    type EntityTypeCreateResponse as EntityTypeCreateResponse,
-    type EntityTypeRetrieveResponse as EntityTypeRetrieveResponse,
-    type EntityTypeUpdateResponse as EntityTypeUpdateResponse,
+    type EntityType as EntityType,
     type EntityTypeListResponse as EntityTypeListResponse,
     type EntityTypeCreateParams as EntityTypeCreateParams,
     type EntityTypeUpdateParams as EntityTypeUpdateParams,
@@ -388,8 +245,8 @@ export declare namespace EntityTypes {
 
   export {
     Reviewers as Reviewers,
+    type Reviewer as Reviewer,
     type ReviewerListResponse as ReviewerListResponse,
-    type ReviewerAssignResponse as ReviewerAssignResponse,
     type ReviewerAssignParams as ReviewerAssignParams,
     type ReviewerRemoveParams as ReviewerRemoveParams,
   };

package/src/resources/entity-types/index.ts

@@ -2,9 +2,7 @@
 
 export {
   EntityTypes,
-  type EntityTypeCreateResponse,
-  type EntityTypeRetrieveResponse,
-  type EntityTypeUpdateResponse,
+  type EntityType,
   type EntityTypeListResponse,
   type EntityTypeCreateParams,
   type EntityTypeUpdateParams,
@@ -12,8 +10,8 @@ export {
 } from './entity-types';
 export {
   Reviewers,
+  type Reviewer,
   type ReviewerListResponse,
-  type ReviewerAssignResponse,
   type ReviewerAssignParams,
   type ReviewerRemoveParams,
 } from './reviewers';

package/src/resources/entity-types/reviewers.ts

@@ -45,17 +45,13 @@ export class Reviewers extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.entityTypes.reviewers.assign(
+   * const reviewer = await client.entityTypes.reviewers.assign(
    *   'typeID',
    *   { userID: 'usr_2xyz...' },
    * );
    * ```
    */
-  assign(
-    typeID: string,
-    body: ReviewerAssignParams,
-    options?: RequestOptions,
-  ): APIPromise<ReviewerAssignResponse> {
+  assign(typeID: string, body: ReviewerAssignParams, options?: RequestOptions): APIPromise<Reviewer> {
     return this._client.post(path`/v3/entity-types/${typeID}/reviewers`, { body, ...options });
   }
 
@@ -78,53 +74,12 @@ export class Reviewers extends APIResource {
   }
 }
 
-/**
- * Response body for listing the reviewers of an entity type.
- */
-export interface ReviewerListResponse {
-  reviewers: Array<ReviewerListResponse.Reviewer>;
-}
-
-export namespace ReviewerListResponse {
-  /**
-   * A reviewer assignment links a user to an entity type they are responsible for
-   * reviewing. The assignment is scoped to an account+environment and is unique per
-   * (entity type, user).
-   */
-  export interface Reviewer {
-    /**
-     * When the assignment was created (RFC 3339).
-     */
-    createdAt: string;
-
-    /**
-     * The assigned user's email.
-     */
-    email: string;
-
-    /**
-     * Stable public identifier for the assignment (`etr_...`).
-     */
-    reviewerID: string;
-
-    /**
-     * The assigned user's account role (for example `operator`, `admin`).
-     */
-    role: string;
-
-    /**
-     * Public identifier of the assigned user (`usr_...`).
-     */
-    userID: string;
-  }
-}
-
 /**
  * A reviewer assignment links a user to an entity type they are responsible for
  * reviewing. The assignment is scoped to an account+environment and is unique per
  * (entity type, user).
  */
-export interface ReviewerAssignResponse {
+export interface Reviewer {
   /**
    * When the assignment was created (RFC 3339).
    */
@@ -151,6 +106,13 @@ export interface ReviewerAssignResponse {
   userID: string;
 }
 
+/**
+ * Response body for listing the reviewers of an entity type.
+ */
+export interface ReviewerListResponse {
+  reviewers: Array<Reviewer>;
+}
+
 export interface ReviewerAssignParams {
   /**
    * Public ID (`usr_...`) of the user to assign. Must belong to the account.
@@ -167,8 +129,8 @@ export interface ReviewerRemoveParams {
 
 export declare namespace Reviewers {
   export {
+    type Reviewer as Reviewer,
     type ReviewerListResponse as ReviewerListResponse,
-    type ReviewerAssignResponse as ReviewerAssignResponse,
     type ReviewerAssignParams as ReviewerAssignParams,
     type ReviewerRemoveParams as ReviewerRemoveParams,
   };

package/src/resources/eval/eval.ts

@@ -5,11 +5,13 @@ import * as ResultsAPI from './results';
 import { EvaluationResults, ResultRetrieveResultsParams, Results } from './results';
 import * as ScoreAPI from './score';
 import {
+  EvalMatchConfig,
+  EvalScoreRun,
+  EvalScoreRunStatus,
+  FileInput,
   Score,
-  ScoreCancelResponse,
   ScoreCreateParams,
   ScoreCreateResponse,
-  ScoreRetrieveResponse,
 } from './score';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
@@ -144,9 +146,11 @@ export declare namespace Eval {
 
   export {
     Score as Score,
+    type EvalMatchConfig as EvalMatchConfig,
+    type EvalScoreRun as EvalScoreRun,
+    type EvalScoreRunStatus as EvalScoreRunStatus,
+    type FileInput as FileInput,
     type ScoreCreateResponse as ScoreCreateResponse,
-    type ScoreRetrieveResponse as ScoreRetrieveResponse,
-    type ScoreCancelResponse as ScoreCancelResponse,
     type ScoreCreateParams as ScoreCreateParams,
   };
 }

package/src/resources/eval/index.ts

@@ -4,8 +4,10 @@ export { Eval, type EvalTriggerEvaluationResponse, type EvalTriggerEvaluationPar
 export { Results, type EvaluationResults, type ResultRetrieveResultsParams } from './results';
 export {
   Score,
+  type EvalMatchConfig,
+  type EvalScoreRun,
+  type EvalScoreRunStatus,
+  type FileInput,
   type ScoreCreateResponse,
-  type ScoreRetrieveResponse,
-  type ScoreCancelResponse,
   type ScoreCreateParams,
 } from './score';