telnyx 7.23.0 → 7.24.0

package/resources/ai/memory/namespaces/profiles/profiles.d.mts

@@ -0,0 +1,324 @@
+import { APIResource } from "../../../../../core/resource.mjs";
+import * as MemoriesAPI from "./memories.mjs";
+import { Memories, MemoryListParams, MemoryListResponse, MemoryListResponsesDefaultFlatPagination, MemoryRetrieveParams, MemoryRetrieveResponse } from "./memories.mjs";
+import * as SourcesAPI from "./sources.mjs";
+import { SourceDeleteParams, SourceDeleteResponse, SourceListParams, SourceRetrieveParams, SourceRetrieveResponse, Sources } from "./sources.mjs";
+import { APIPromise } from "../../../../../core/api-promise.mjs";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../../../../core/pagination.mjs";
+import { RequestOptions } from "../../../../../internal/request-options.mjs";
+export declare class Profiles extends APIResource {
+    memories: MemoriesAPI.Memories;
+    sources: SourcesAPI.Sources;
+    /**
+     * Profiles are never created, only written to, so this lists the ones that hold a
+     * memory. A profile whose first ingest is still running is not here yet. Ordered
+     * by memory count, largest first, so a profile written to while the listing is
+     * paged can move between pages and be repeated or missed.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const profileListResponse of client.ai.memory.namespaces.profiles.list(
+     *   'namespace',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(namespace: string, query?: ProfileListParams | null | undefined, options?: RequestOptions): PagePromise<ProfileListResponsesDefaultFlatPagination, ProfileListResponse>;
+    /**
+     * Delete everything held about one profile. A 2xx means none of its memories are
+     * left, and its summary goes with them. There is no undo.
+     *
+     * @example
+     * ```ts
+     * const profile =
+     *   await client.ai.memory.namespaces.profiles.delete(
+     *     'profile_id',
+     *     { namespace: 'namespace' },
+     *   );
+     * ```
+     */
+    delete(profileID: string, params: ProfileDeleteParams, options?: RequestOptions): APIPromise<ProfileDeleteResponse>;
+    /**
+     * Store a session. Facts are extracted from whatever you send — the body is taken
+     * as any JSON value and stored whole, so a framework's own transcript shape works
+     * unchanged. `messages` of `role`/`content` is the conventional shape, not a
+     * requirement. An empty object or a null body is refused. Carry a `session_id` to
+     * name the session: re-ingesting the same one replaces what it held. Omit it and a
+     * session is opened and returned. Extraction runs asynchronously — poll the
+     * returned operation.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.ai.memory.namespaces.profiles.ingest(
+     *     'profile_id',
+     *     {
+     *       namespace: 'namespace',
+     *       body: { foo: 'bar' },
+     *     },
+     *   );
+     * ```
+     */
+    ingest(profileID: string, params: ProfileIngestParams, options?: RequestOptions): APIPromise<ProfileIngestResponse>;
+    /**
+     * Ranked memories for a question. Matching runs over the profile's memories and
+     * returns them in rank order with a relevance `score`; the score is null where the
+     * deployment's reranker is a passthrough, in which case order is the only signal.
+     * No model runs in this path — recall returns facts, it does not compose an
+     * answer.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.ai.memory.namespaces.profiles.recall(
+     *     'profile_id',
+     *     {
+     *       namespace: 'namespace',
+     *       query: 'where do invoices go?',
+     *       top_k: 5,
+     *     },
+     *   );
+     * ```
+     */
+    recall(profileID: string, params: ProfileRecallParams, options?: RequestOptions): APIPromise<ProfileRecallResponse>;
+    /**
+     * For a fact the agent has already distilled: `text` is stored as given, with
+     * nothing extracted from it. Send a transcript to `ingest` instead. Remembering
+     * the same text again writes the same memory rather than a second copy of it, so a
+     * retry is safe. The write runs asynchronously -- poll the returned operation.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.ai.memory.namespaces.profiles.remember(
+     *     'profile_id',
+     *     {
+     *       namespace: 'namespace',
+     *       text: 'Prefers window seats and flies out of ORD',
+     *     },
+     *   );
+     * ```
+     */
+    remember(profileID: string, params: ProfileRememberParams, options?: RequestOptions): APIPromise<ProfileRememberResponse>;
+    /**
+     * The whole profile as one card, precomputed, with no query. Built for the start
+     * of a session, where there is no question to ask yet.
+     *
+     * A summary is generated in the background. `is_stale` tells you newer memories
+     * have arrived since it was written; that is ordinary and the card is still
+     * usable.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.ai.memory.namespaces.profiles.retrieveSummary(
+     *     'profile_id',
+     *     { namespace: 'namespace' },
+     *   );
+     * ```
+     */
+    retrieveSummary(profileID: string, params: ProfileRetrieveSummaryParams, options?: RequestOptions): APIPromise<ProfileRetrieveSummaryResponse>;
+}
+export type ProfileListResponsesDefaultFlatPagination = DefaultFlatPagination<ProfileListResponse>;
+/**
+ * Where a listing's page sits in the whole.
+ *
+ * A page is a snapshot: the counts it reports and the order it is drawn in both
+ * move as writes land, so paging through a busy namespace can repeat or miss an
+ * entry at a page boundary.
+ */
+export interface PageMeta {
+    /**
+     * The page returned, counting from 1.
+     */
+    page_number: number;
+    /**
+     * How many results a page holds.
+     */
+    page_size: number;
+    /**
+     * Pages that can be requested; 0 when nothing matched. Page until `page_number`
+     * reaches it rather than until a page comes back short: a page can hold fewer than
+     * `page_size` results without being the last. Capped at the deepest page served,
+     * so on a very large listing it covers fewer results than `total_results`.
+     */
+    total_pages: number;
+    /**
+     * Results the request matched, including any past the deepest page.
+     */
+    total_results: number;
+}
+export interface ProfileListResponse {
+    /**
+     * Memories stored under this profile, including the consolidated ones that
+     * paraphrase others. Listings are ordered by it.
+     */
+    memory_count: number;
+    profile_id: string;
+}
+export interface ProfileDeleteResponse {
+    data: ProfileDeleteResponse.Data;
+}
+export declare namespace ProfileDeleteResponse {
+    interface Data {
+        /**
+         * Memories the profile held and no longer does, counted before and after. A report
+         * rather than an audit: memory moves in the background between the two counts. The
+         * status carries the outcome.
+         */
+        memories_deleted: number;
+        profile_id: string;
+    }
+}
+export interface ProfileIngestResponse {
+    data: ProfileIngestResponse.Data;
+}
+export declare namespace ProfileIngestResponse {
+    interface Data {
+        operation_id: string;
+        profile_id: string;
+        session_id: string;
+        /**
+         * Identifies one source within its profile: an ingested session, or one remembered
+         * fact. Returned by `ingest` and `remember` when the write is accepted.
+         * Re-ingesting a session keeps its source id.
+         */
+        source_id: string;
+    }
+}
+export interface ProfileRecallResponse {
+    data: Array<ProfileRecallResponse.Data>;
+}
+export declare namespace ProfileRecallResponse {
+    interface Data {
+        id: string;
+        text: string;
+        recorded_at?: string | null;
+        /**
+         * Relevance, 0-1. Null where the deployment's reranker is a passthrough; results
+         * are in rank order either way.
+         */
+        score?: number | null;
+    }
+}
+export interface ProfileRememberResponse {
+    data: ProfileRememberResponse.Data;
+}
+export declare namespace ProfileRememberResponse {
+    interface Data {
+        operation_id: string;
+        profile_id: string;
+        /**
+         * Identifies one source within its profile: an ingested session, or one remembered
+         * fact. Returned by `ingest` and `remember` when the write is accepted.
+         * Re-ingesting a session keeps its source id.
+         */
+        source_id: string;
+    }
+}
+export interface ProfileRetrieveSummaryResponse {
+    data: ProfileRetrieveSummaryResponse.Data;
+}
+export declare namespace ProfileRetrieveSummaryResponse {
+    interface Data {
+        /**
+         * Whether newer memories have arrived since the summary was generated. The summary
+         * is regenerated in the background, so a true here is ordinary and the summary is
+         * still usable.
+         */
+        is_stale: boolean;
+        profile_id: string;
+        /**
+         * When the summary was last generated. Null while none is ready.
+         */
+        generated_at?: string | null;
+        /**
+         * The precomputed summary, ready to place in an assistant's context at the start
+         * of a session.
+         */
+        text?: string | null;
+    }
+}
+export interface ProfileListParams extends DefaultFlatPaginationParams {
+}
+export interface ProfileDeleteParams {
+    /**
+     * The namespace. `default` exists for every organization.
+     */
+    namespace: string;
+}
+export type ProfileIngestParams = ProfileIngestParams.Variant0 | ProfileIngestParams.Variant1;
+export declare namespace ProfileIngestParams {
+    interface Variant0 {
+        /**
+         * Path param
+         */
+        namespace: string;
+        /**
+         * Body param
+         */
+        body: {
+            [key: string]: unknown;
+        };
+        /**
+         * Query param: Names the session. Re-ingesting the same session replaces what it
+         * held and keeps its `source_id`. Omit it to have one derived from the content and
+         * returned. No whitespace, control characters, or any of / \ # ? %.
+         */
+        session_id?: string | null;
+    }
+    interface Variant1 {
+        /**
+         * Path param
+         */
+        namespace: string;
+        /**
+         * Body param
+         */
+        body: Array<unknown> | string | number | boolean;
+        /**
+         * Query param: Names the session. Re-ingesting the same session replaces what it
+         * held and keeps its `source_id`. Omit it to have one derived from the content and
+         * returned. No whitespace, control characters, or any of / \ # ? %.
+         */
+        session_id?: string | null;
+    }
+}
+export interface ProfileRecallParams {
+    /**
+     * Path param
+     */
+    namespace: string;
+    /**
+     * Body param
+     */
+    query: string;
+    /**
+     * Body param
+     */
+    top_k?: number | null;
+}
+export interface ProfileRememberParams {
+    /**
+     * Path param
+     */
+    namespace: string;
+    /**
+     * Body param
+     */
+    text: string;
+}
+export interface ProfileRetrieveSummaryParams {
+    /**
+     * The namespace. `default` exists for every organization.
+     */
+    namespace: string;
+}
+export declare namespace Profiles {
+    export { type PageMeta as PageMeta, type ProfileListResponse as ProfileListResponse, type ProfileDeleteResponse as ProfileDeleteResponse, type ProfileIngestResponse as ProfileIngestResponse, type ProfileRecallResponse as ProfileRecallResponse, type ProfileRememberResponse as ProfileRememberResponse, type ProfileRetrieveSummaryResponse as ProfileRetrieveSummaryResponse, type ProfileListResponsesDefaultFlatPagination as ProfileListResponsesDefaultFlatPagination, type ProfileListParams as ProfileListParams, type ProfileDeleteParams as ProfileDeleteParams, type ProfileIngestParams as ProfileIngestParams, type ProfileRecallParams as ProfileRecallParams, type ProfileRememberParams as ProfileRememberParams, type ProfileRetrieveSummaryParams as ProfileRetrieveSummaryParams, };
+    export { Memories as Memories, type MemoryRetrieveResponse as MemoryRetrieveResponse, type MemoryListResponse as MemoryListResponse, type MemoryListResponsesDefaultFlatPagination as MemoryListResponsesDefaultFlatPagination, type MemoryListParams as MemoryListParams, type MemoryRetrieveParams as MemoryRetrieveParams, };
+    export { Sources as Sources, type SourceRetrieveResponse as SourceRetrieveResponse, type SourceDeleteResponse as SourceDeleteResponse, type SourceListParams as SourceListParams, type SourceDeleteParams as SourceDeleteParams, type SourceRetrieveParams as SourceRetrieveParams, };
+}
+//# sourceMappingURL=profiles.d.mts.map

package/resources/ai/memory/namespaces/profiles/profiles.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profiles.d.mts","sourceRoot":"","sources":["../../../../../src/resources/ai/memory/namespaces/profiles/profiles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,yCAAqC;AAC3D,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EACL,QAAQ,EACR,gBAAgB,EAChB,kBAAkB,EAClB,wCAAwC,EACxC,oBAAoB,EACpB,sBAAsB,EACvB,uBAAmB;AACpB,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,OAAO,EACR,sBAAkB;AACnB,OAAO,EAAE,UAAU,EAAE,4CAAwC;AAC7D,OAAO,EACL,qBAAqB,EACrB,KAAK,2BAA2B,EAChC,WAAW,EACZ,2CAAuC;AACxC,OAAO,EAAE,cAAc,EAAE,oDAAgD;AAGzE,qBAAa,QAAS,SAAQ,WAAW;IACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,mBAAmB,CAAC;IAQ9E;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAKpC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IASpC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAQpC;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAQtC;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CACb,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAI9C;AAED,MAAM,MAAM,yCAAyC,GAAG,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;AAEnG;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;;;WAIG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,YAAY,EAAE,MAAM,CAAC;QAErB,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;QAEb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,YAAY,EAAE,MAAM,CAAC;QAErB,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,8BAA8B,CAAC,IAAI,CAAC;CAC3C;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,IAAI;QACnB;;;;WAIG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,2BAA2B;CAAG;AAEzE,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,CAAC,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC;AAE9F,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,QAAQ;QACvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEjC;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAEjD;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAKD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/ai/memory/namespaces/profiles/profiles.d.ts

@@ -0,0 +1,324 @@
+import { APIResource } from "../../../../../core/resource.js";
+import * as MemoriesAPI from "./memories.js";
+import { Memories, MemoryListParams, MemoryListResponse, MemoryListResponsesDefaultFlatPagination, MemoryRetrieveParams, MemoryRetrieveResponse } from "./memories.js";
+import * as SourcesAPI from "./sources.js";
+import { SourceDeleteParams, SourceDeleteResponse, SourceListParams, SourceRetrieveParams, SourceRetrieveResponse, Sources } from "./sources.js";
+import { APIPromise } from "../../../../../core/api-promise.js";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../../../../core/pagination.js";
+import { RequestOptions } from "../../../../../internal/request-options.js";
+export declare class Profiles extends APIResource {
+    memories: MemoriesAPI.Memories;
+    sources: SourcesAPI.Sources;
+    /**
+     * Profiles are never created, only written to, so this lists the ones that hold a
+     * memory. A profile whose first ingest is still running is not here yet. Ordered
+     * by memory count, largest first, so a profile written to while the listing is
+     * paged can move between pages and be repeated or missed.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const profileListResponse of client.ai.memory.namespaces.profiles.list(
+     *   'namespace',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(namespace: string, query?: ProfileListParams | null | undefined, options?: RequestOptions): PagePromise<ProfileListResponsesDefaultFlatPagination, ProfileListResponse>;
+    /**
+     * Delete everything held about one profile. A 2xx means none of its memories are
+     * left, and its summary goes with them. There is no undo.
+     *
+     * @example
+     * ```ts
+     * const profile =
+     *   await client.ai.memory.namespaces.profiles.delete(
+     *     'profile_id',
+     *     { namespace: 'namespace' },
+     *   );
+     * ```
+     */
+    delete(profileID: string, params: ProfileDeleteParams, options?: RequestOptions): APIPromise<ProfileDeleteResponse>;
+    /**
+     * Store a session. Facts are extracted from whatever you send — the body is taken
+     * as any JSON value and stored whole, so a framework's own transcript shape works
+     * unchanged. `messages` of `role`/`content` is the conventional shape, not a
+     * requirement. An empty object or a null body is refused. Carry a `session_id` to
+     * name the session: re-ingesting the same one replaces what it held. Omit it and a
+     * session is opened and returned. Extraction runs asynchronously — poll the
+     * returned operation.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.ai.memory.namespaces.profiles.ingest(
+     *     'profile_id',
+     *     {
+     *       namespace: 'namespace',
+     *       body: { foo: 'bar' },
+     *     },
+     *   );
+     * ```
+     */
+    ingest(profileID: string, params: ProfileIngestParams, options?: RequestOptions): APIPromise<ProfileIngestResponse>;
+    /**
+     * Ranked memories for a question. Matching runs over the profile's memories and
+     * returns them in rank order with a relevance `score`; the score is null where the
+     * deployment's reranker is a passthrough, in which case order is the only signal.
+     * No model runs in this path — recall returns facts, it does not compose an
+     * answer.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.ai.memory.namespaces.profiles.recall(
+     *     'profile_id',
+     *     {
+     *       namespace: 'namespace',
+     *       query: 'where do invoices go?',
+     *       top_k: 5,
+     *     },
+     *   );
+     * ```
+     */
+    recall(profileID: string, params: ProfileRecallParams, options?: RequestOptions): APIPromise<ProfileRecallResponse>;
+    /**
+     * For a fact the agent has already distilled: `text` is stored as given, with
+     * nothing extracted from it. Send a transcript to `ingest` instead. Remembering
+     * the same text again writes the same memory rather than a second copy of it, so a
+     * retry is safe. The write runs asynchronously -- poll the returned operation.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.ai.memory.namespaces.profiles.remember(
+     *     'profile_id',
+     *     {
+     *       namespace: 'namespace',
+     *       text: 'Prefers window seats and flies out of ORD',
+     *     },
+     *   );
+     * ```
+     */
+    remember(profileID: string, params: ProfileRememberParams, options?: RequestOptions): APIPromise<ProfileRememberResponse>;
+    /**
+     * The whole profile as one card, precomputed, with no query. Built for the start
+     * of a session, where there is no question to ask yet.
+     *
+     * A summary is generated in the background. `is_stale` tells you newer memories
+     * have arrived since it was written; that is ordinary and the card is still
+     * usable.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.ai.memory.namespaces.profiles.retrieveSummary(
+     *     'profile_id',
+     *     { namespace: 'namespace' },
+     *   );
+     * ```
+     */
+    retrieveSummary(profileID: string, params: ProfileRetrieveSummaryParams, options?: RequestOptions): APIPromise<ProfileRetrieveSummaryResponse>;
+}
+export type ProfileListResponsesDefaultFlatPagination = DefaultFlatPagination<ProfileListResponse>;
+/**
+ * Where a listing's page sits in the whole.
+ *
+ * A page is a snapshot: the counts it reports and the order it is drawn in both
+ * move as writes land, so paging through a busy namespace can repeat or miss an
+ * entry at a page boundary.
+ */
+export interface PageMeta {
+    /**
+     * The page returned, counting from 1.
+     */
+    page_number: number;
+    /**
+     * How many results a page holds.
+     */
+    page_size: number;
+    /**
+     * Pages that can be requested; 0 when nothing matched. Page until `page_number`
+     * reaches it rather than until a page comes back short: a page can hold fewer than
+     * `page_size` results without being the last. Capped at the deepest page served,
+     * so on a very large listing it covers fewer results than `total_results`.
+     */
+    total_pages: number;
+    /**
+     * Results the request matched, including any past the deepest page.
+     */
+    total_results: number;
+}
+export interface ProfileListResponse {
+    /**
+     * Memories stored under this profile, including the consolidated ones that
+     * paraphrase others. Listings are ordered by it.
+     */
+    memory_count: number;
+    profile_id: string;
+}
+export interface ProfileDeleteResponse {
+    data: ProfileDeleteResponse.Data;
+}
+export declare namespace ProfileDeleteResponse {
+    interface Data {
+        /**
+         * Memories the profile held and no longer does, counted before and after. A report
+         * rather than an audit: memory moves in the background between the two counts. The
+         * status carries the outcome.
+         */
+        memories_deleted: number;
+        profile_id: string;
+    }
+}
+export interface ProfileIngestResponse {
+    data: ProfileIngestResponse.Data;
+}
+export declare namespace ProfileIngestResponse {
+    interface Data {
+        operation_id: string;
+        profile_id: string;
+        session_id: string;
+        /**
+         * Identifies one source within its profile: an ingested session, or one remembered
+         * fact. Returned by `ingest` and `remember` when the write is accepted.
+         * Re-ingesting a session keeps its source id.
+         */
+        source_id: string;
+    }
+}
+export interface ProfileRecallResponse {
+    data: Array<ProfileRecallResponse.Data>;
+}
+export declare namespace ProfileRecallResponse {
+    interface Data {
+        id: string;
+        text: string;
+        recorded_at?: string | null;
+        /**
+         * Relevance, 0-1. Null where the deployment's reranker is a passthrough; results
+         * are in rank order either way.
+         */
+        score?: number | null;
+    }
+}
+export interface ProfileRememberResponse {
+    data: ProfileRememberResponse.Data;
+}
+export declare namespace ProfileRememberResponse {
+    interface Data {
+        operation_id: string;
+        profile_id: string;
+        /**
+         * Identifies one source within its profile: an ingested session, or one remembered
+         * fact. Returned by `ingest` and `remember` when the write is accepted.
+         * Re-ingesting a session keeps its source id.
+         */
+        source_id: string;
+    }
+}
+export interface ProfileRetrieveSummaryResponse {
+    data: ProfileRetrieveSummaryResponse.Data;
+}
+export declare namespace ProfileRetrieveSummaryResponse {
+    interface Data {
+        /**
+         * Whether newer memories have arrived since the summary was generated. The summary
+         * is regenerated in the background, so a true here is ordinary and the summary is
+         * still usable.
+         */
+        is_stale: boolean;
+        profile_id: string;
+        /**
+         * When the summary was last generated. Null while none is ready.
+         */
+        generated_at?: string | null;
+        /**
+         * The precomputed summary, ready to place in an assistant's context at the start
+         * of a session.
+         */
+        text?: string | null;
+    }
+}
+export interface ProfileListParams extends DefaultFlatPaginationParams {
+}
+export interface ProfileDeleteParams {
+    /**
+     * The namespace. `default` exists for every organization.
+     */
+    namespace: string;
+}
+export type ProfileIngestParams = ProfileIngestParams.Variant0 | ProfileIngestParams.Variant1;
+export declare namespace ProfileIngestParams {
+    interface Variant0 {
+        /**
+         * Path param
+         */
+        namespace: string;
+        /**
+         * Body param
+         */
+        body: {
+            [key: string]: unknown;
+        };
+        /**
+         * Query param: Names the session. Re-ingesting the same session replaces what it
+         * held and keeps its `source_id`. Omit it to have one derived from the content and
+         * returned. No whitespace, control characters, or any of / \ # ? %.
+         */
+        session_id?: string | null;
+    }
+    interface Variant1 {
+        /**
+         * Path param
+         */
+        namespace: string;
+        /**
+         * Body param
+         */
+        body: Array<unknown> | string | number | boolean;
+        /**
+         * Query param: Names the session. Re-ingesting the same session replaces what it
+         * held and keeps its `source_id`. Omit it to have one derived from the content and
+         * returned. No whitespace, control characters, or any of / \ # ? %.
+         */
+        session_id?: string | null;
+    }
+}
+export interface ProfileRecallParams {
+    /**
+     * Path param
+     */
+    namespace: string;
+    /**
+     * Body param
+     */
+    query: string;
+    /**
+     * Body param
+     */
+    top_k?: number | null;
+}
+export interface ProfileRememberParams {
+    /**
+     * Path param
+     */
+    namespace: string;
+    /**
+     * Body param
+     */
+    text: string;
+}
+export interface ProfileRetrieveSummaryParams {
+    /**
+     * The namespace. `default` exists for every organization.
+     */
+    namespace: string;
+}
+export declare namespace Profiles {
+    export { type PageMeta as PageMeta, type ProfileListResponse as ProfileListResponse, type ProfileDeleteResponse as ProfileDeleteResponse, type ProfileIngestResponse as ProfileIngestResponse, type ProfileRecallResponse as ProfileRecallResponse, type ProfileRememberResponse as ProfileRememberResponse, type ProfileRetrieveSummaryResponse as ProfileRetrieveSummaryResponse, type ProfileListResponsesDefaultFlatPagination as ProfileListResponsesDefaultFlatPagination, type ProfileListParams as ProfileListParams, type ProfileDeleteParams as ProfileDeleteParams, type ProfileIngestParams as ProfileIngestParams, type ProfileRecallParams as ProfileRecallParams, type ProfileRememberParams as ProfileRememberParams, type ProfileRetrieveSummaryParams as ProfileRetrieveSummaryParams, };
+    export { Memories as Memories, type MemoryRetrieveResponse as MemoryRetrieveResponse, type MemoryListResponse as MemoryListResponse, type MemoryListResponsesDefaultFlatPagination as MemoryListResponsesDefaultFlatPagination, type MemoryListParams as MemoryListParams, type MemoryRetrieveParams as MemoryRetrieveParams, };
+    export { Sources as Sources, type SourceRetrieveResponse as SourceRetrieveResponse, type SourceDeleteResponse as SourceDeleteResponse, type SourceListParams as SourceListParams, type SourceDeleteParams as SourceDeleteParams, type SourceRetrieveParams as SourceRetrieveParams, };
+}
+//# sourceMappingURL=profiles.d.ts.map

package/resources/ai/memory/namespaces/profiles/profiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profiles.d.ts","sourceRoot":"","sources":["../../../../../src/resources/ai/memory/namespaces/profiles/profiles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,wCAAqC;AAC3D,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EACL,QAAQ,EACR,gBAAgB,EAChB,kBAAkB,EAClB,wCAAwC,EACxC,oBAAoB,EACpB,sBAAsB,EACvB,sBAAmB;AACpB,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,OAAO,EACR,qBAAkB;AACnB,OAAO,EAAE,UAAU,EAAE,2CAAwC;AAC7D,OAAO,EACL,qBAAqB,EACrB,KAAK,2BAA2B,EAChC,WAAW,EACZ,0CAAuC;AACxC,OAAO,EAAE,cAAc,EAAE,mDAAgD;AAGzE,qBAAa,QAAS,SAAQ,WAAW;IACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,mBAAmB,CAAC;IAQ9E;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAKpC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IASpC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAQpC;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAQtC;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CACb,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAI9C;AAED,MAAM,MAAM,yCAAyC,GAAG,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;AAEnG;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;;;WAIG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,YAAY,EAAE,MAAM,CAAC;QAErB,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;QAEb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,YAAY,EAAE,MAAM,CAAC;QAErB,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,8BAA8B,CAAC,IAAI,CAAC;CAC3C;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,IAAI;QACnB;;;;WAIG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,2BAA2B;CAAG;AAEzE,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,CAAC,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC;AAE9F,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,QAAQ;QACvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEjC;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAEjD;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAKD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}