@pairsystems/goodmem-client 1.0.2 → 1.0.4

package/README.md

@@ -6,7 +6,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 
 - API version: 
 - Package version: 1.0.0
-- Generator version: 7.14.0
+- Generator version: 7.17.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
 
 ## Installation
@@ -101,6 +101,17 @@ Please follow the [installation](#installation) instruction and execute the foll
 ```javascript
 var GoodMemClient = require('@pairsystems/goodmem-client');
 
+// Configure the API client
+var defaultClient = GoodMemClient.ApiClient.instance;
+defaultClient.basePath = "http://localhost:8080";  // Use your server URL
+
+// Configure API key authentication: X-API-Key header
+defaultClient.defaultHeaders = {
+    "X-API-Key": "your-api-key-here",
+    "Content-Type": "application/json",
+    "Accept": "application/json"
+};
+
 
 var api = new GoodMemClient.APIKeysApi()
 var createApiKeyRequest = {
@@ -120,6 +131,159 @@ api.createApiKey(createApiKeyRequest).then(function(data) {
 
 ```
 
+
+
+## Streaming Memory Retrieval
+
+The GoodMem JavaScript client provides a `StreamingClient` class for real-time streaming memory retrieval. This is the **recommended approach** for memory retrieval operations.
+
+### Supported Formats
+
+The StreamingClient supports two streaming formats:
+
+- **NDJSON** (`application/x-ndjson`) - Newline-delimited JSON (default, recommended)
+- **SSE** (`text/event-stream`) - Server-Sent Events
+
+### Basic Streaming with ChatPostProcessor
+
+Use `retrieveMemoryStreamChat()` for streaming with automatic ChatPostProcessor configuration:
+
+```javascript
+const GoodMemClient = require('@pairsystems/goodmem-client');
+const { StreamingClient } = GoodMemClient;
+
+// Configure client
+const defaultClient = GoodMemClient.ApiClient.instance;
+defaultClient.basePath = 'http://localhost:8080';
+defaultClient.defaultHeaders = {
+    'X-API-Key': 'your-api-key'
+};
+
+// Create streaming client
+const streamingClient = new StreamingClient(defaultClient);
+
+// Create abort controller
+const controller = new AbortController();
+
+// Stream with ChatPostProcessor (NDJSON format)
+streamingClient.retrieveMemoryStreamChat(
+    controller.signal,
+    'your search query',
+    ['space-uuid'],
+    10,                    // requested size
+    true,                  // fetch memory
+    false,                 // fetch memory content
+    'ndjson',              // format (ndjson or sse)
+    'llm-uuid',            // LLM ID
+    'reranker-uuid',       // reranker ID
+    0.5,                   // relevance threshold
+    0.3,                   // LLM temperature
+    10,                    // max results
+    true                   // chronological resort
+).then(async (stream) => {
+    for await (const event of stream) {
+        if (event.abstractReply) {
+            console.log('Abstract:', event.abstractReply.text);
+        } else if (event.retrievedItem && event.retrievedItem.memory) {
+            console.log('Memory:', event.retrievedItem.memory);
+        }
+    }
+}).catch(error => {
+    console.error('Streaming error:', error);
+});
+```
+
+### Advanced Streaming with Custom Post-Processor
+
+Use `retrieveMemoryStreamAdvanced()` for custom post-processor configuration:
+
+```javascript
+// Create advanced request
+const request = {
+    message: 'your search query',
+    spaceIds: ['space-uuid'],
+    requestedSize: 10,
+    fetchMemory: true,
+    fetchMemoryContent: false,
+    format: 'ndjson',  // or 'sse'
+    postProcessorName: 'com.goodmem.retrieval.postprocess.ChatPostProcessorFactory',
+    postProcessorConfig: {
+        llm_id: 'llm-uuid',
+        reranker_id: 'reranker-uuid',
+        relevance_threshold: 0.5,
+        llm_temp: 0.3,
+        max_results: 10,
+        chronological_resort: true
+    }
+};
+
+// Execute advanced streaming
+streamingClient.retrieveMemoryStreamAdvanced(controller.signal, request)
+    .then(async (stream) => {
+        for await (const event of stream) {
+            if (event.abstractReply) {
+                console.log('Abstract:', event.abstractReply.text);
+            } else if (event.retrievedItem) {
+                console.log('Retrieved:', event.retrievedItem);
+            }
+        }
+    }).catch(error => {
+        console.error('Streaming error:', error);
+    });
+```
+
+### Choosing Between NDJSON and SSE
+
+- **NDJSON** (recommended): Simpler parsing, better for most use cases
+- **SSE**: Standard browser EventSource API compatible, useful for web applications
+
+
+## Authentication
+
+Configure API key authentication by setting the X-API-Key header:
+
+```javascript
+var GoodMemClient = require("@pairsystems/goodmem-client");
+
+// Configure the API client
+var defaultClient = GoodMemClient.ApiClient.instance;
+defaultClient.basePath = "http://localhost:8080";  // Use your server URL
+
+// Configure API key authentication
+defaultClient.defaultHeaders = {
+    "X-API-Key": "your-api-key-here",
+    "Content-Type": "application/json",
+    "Accept": "application/json"
+};
+
+// Create API instances
+var apiKeysApi = new GoodMemClient.APIKeysApi();
+var spacesApi = new GoodMemClient.SpacesApi();
+```
+
+### Getting an API Key
+
+You can create an API key using the APIKeysApi:
+
+```javascript
+var createRequest = {
+    labels: {
+        "environment": "development",
+        "service": "your-app-name"
+    }
+};
+
+apiKeysApi.createApiKey(createRequest).then(function(response) {
+    console.log("API Key created successfully:");
+    console.log("Key ID:", response.apiKeyMetadata.apiKeyId);
+    console.log("Raw API Key:", response.rawApiKey);
+    console.log("Key Prefix:", response.apiKeyMetadata.keyPrefix);
+}, function(error) {
+    console.error("Error creating API key:", error);
+});
+```
+
+
 ## Documentation for API Endpoints
 
 All URIs are relative to *http://localhost*
@@ -135,6 +299,11 @@ Class | Method | HTTP request | Description
 *GoodMemClient.EmbeddersApi* | [**getEmbedder**](docs/EmbeddersApi.md#getEmbedder) | **GET** /v1/embedders/{id} | Get an embedder by ID
 *GoodMemClient.EmbeddersApi* | [**listEmbedders**](docs/EmbeddersApi.md#listEmbedders) | **GET** /v1/embedders | List embedders
 *GoodMemClient.EmbeddersApi* | [**updateEmbedder**](docs/EmbeddersApi.md#updateEmbedder) | **PUT** /v1/embedders/{id} | Update an embedder
+*GoodMemClient.LLMsApi* | [**createLLM**](docs/LLMsApi.md#createLLM) | **POST** /v1/llms | Create a new LLM
+*GoodMemClient.LLMsApi* | [**deleteLLM**](docs/LLMsApi.md#deleteLLM) | **DELETE** /v1/llms/{id} | Delete an LLM
+*GoodMemClient.LLMsApi* | [**getLLM**](docs/LLMsApi.md#getLLM) | **GET** /v1/llms/{id} | Get an LLM by ID
+*GoodMemClient.LLMsApi* | [**listLLMs**](docs/LLMsApi.md#listLLMs) | **GET** /v1/llms | List LLMs
+*GoodMemClient.LLMsApi* | [**updateLLM**](docs/LLMsApi.md#updateLLM) | **PUT** /v1/llms/{id} | Update an LLM
 *GoodMemClient.MemoriesApi* | [**batchCreateMemory**](docs/MemoriesApi.md#batchCreateMemory) | **POST** /v1/memories/batch | Create multiple memories in a batch
 *GoodMemClient.MemoriesApi* | [**batchDeleteMemory**](docs/MemoriesApi.md#batchDeleteMemory) | **POST** /v1/memories/batch/delete | Delete multiple memories by ID
 *GoodMemClient.MemoriesApi* | [**batchGetMemory**](docs/MemoriesApi.md#batchGetMemory) | **POST** /v1/memories/batch/get | Get multiple memories by ID
@@ -142,7 +311,8 @@ Class | Method | HTTP request | Description
 *GoodMemClient.MemoriesApi* | [**deleteMemory**](docs/MemoriesApi.md#deleteMemory) | **DELETE** /v1/memories/{id} | Delete a memory
 *GoodMemClient.MemoriesApi* | [**getMemory**](docs/MemoriesApi.md#getMemory) | **GET** /v1/memories/{id} | Get a memory by ID
 *GoodMemClient.MemoriesApi* | [**listMemories**](docs/MemoriesApi.md#listMemories) | **GET** /v1/spaces/{spaceId}/memories | List memories in a space
-*GoodMemClient.MemoriesApi* | [**retrieveMemory**](docs/MemoriesApi.md#retrieveMemory) | **GET** /v1/memories/retrieve | Stream semantic memory retrieval
+*GoodMemClient.MemoriesApi* | [**retrieveMemory**](docs/MemoriesApi.md#retrieveMemory) | **GET** /v1/memories:retrieve | Stream semantic memory retrieval
+*GoodMemClient.MemoriesApi* | [**retrieveMemoryAdvanced**](docs/MemoriesApi.md#retrieveMemoryAdvanced) | **POST** /v1/memories:retrieve | Advanced semantic memory retrieval with JSON
 *GoodMemClient.RerankersApi* | [**createReranker**](docs/RerankersApi.md#createReranker) | **POST** /v1/rerankers | Create a new reranker
 *GoodMemClient.RerankersApi* | [**deleteReranker**](docs/RerankersApi.md#deleteReranker) | **DELETE** /v1/rerankers/{id} | Delete a reranker
 *GoodMemClient.RerankersApi* | [**getReranker**](docs/RerankersApi.md#getReranker) | **GET** /v1/rerankers/{id} | Get a reranker by ID
@@ -154,7 +324,9 @@ Class | Method | HTTP request | Description
 *GoodMemClient.SpacesApi* | [**listSpaces**](docs/SpacesApi.md#listSpaces) | **GET** /v1/spaces | List spaces
 *GoodMemClient.SpacesApi* | [**updateSpace**](docs/SpacesApi.md#updateSpace) | **PUT** /v1/spaces/{id} | Update a space
 *GoodMemClient.SystemApi* | [**initializeSystem**](docs/SystemApi.md#initializeSystem) | **POST** /v1/system/init | Initialize the system
+*GoodMemClient.UsersApi* | [**getCurrentUser**](docs/UsersApi.md#getCurrentUser) | **GET** /v1/users/me | Get current user profile
 *GoodMemClient.UsersApi* | [**getUser**](docs/UsersApi.md#getUser) | **GET** /v1/users/{id} | Get a user by ID
+*GoodMemClient.UsersApi* | [**getUserByEmail**](docs/UsersApi.md#getUserByEmail) | **GET** /v1/users/email/{email} | Get user by email address
 
 
 ## Documentation for Models
@@ -164,28 +336,43 @@ Class | Method | HTTP request | Description
  - [GoodMemClient.BatchMemoryCreationRequest](docs/BatchMemoryCreationRequest.md)
  - [GoodMemClient.BatchMemoryDeletionRequest](docs/BatchMemoryDeletionRequest.md)
  - [GoodMemClient.BatchMemoryRetrievalRequest](docs/BatchMemoryRetrievalRequest.md)
+ - [GoodMemClient.BinaryContent](docs/BinaryContent.md)
  - [GoodMemClient.ChunkReference](docs/ChunkReference.md)
  - [GoodMemClient.ChunkingConfiguration](docs/ChunkingConfiguration.md)
+ - [GoodMemClient.ContextItem](docs/ContextItem.md)
  - [GoodMemClient.CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
  - [GoodMemClient.CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
+ - [GoodMemClient.CreateLLMResponse](docs/CreateLLMResponse.md)
+ - [GoodMemClient.DistributionType](docs/DistributionType.md)
  - [GoodMemClient.EmbedderCreationRequest](docs/EmbedderCreationRequest.md)
  - [GoodMemClient.EmbedderResponse](docs/EmbedderResponse.md)
+ - [GoodMemClient.EmbedderWeight](docs/EmbedderWeight.md)
  - [GoodMemClient.GoodMemStatus](docs/GoodMemStatus.md)
+ - [GoodMemClient.LLMCapabilities](docs/LLMCapabilities.md)
+ - [GoodMemClient.LLMCreationRequest](docs/LLMCreationRequest.md)
+ - [GoodMemClient.LLMProviderType](docs/LLMProviderType.md)
+ - [GoodMemClient.LLMResponse](docs/LLMResponse.md)
+ - [GoodMemClient.LLMSamplingParams](docs/LLMSamplingParams.md)
+ - [GoodMemClient.LLMUpdateRequest](docs/LLMUpdateRequest.md)
  - [GoodMemClient.LengthMeasurement](docs/LengthMeasurement.md)
  - [GoodMemClient.ListApiKeysResponse](docs/ListApiKeysResponse.md)
  - [GoodMemClient.ListEmbeddersResponse](docs/ListEmbeddersResponse.md)
+ - [GoodMemClient.ListLLMsResponse](docs/ListLLMsResponse.md)
  - [GoodMemClient.ListRerankersResponse](docs/ListRerankersResponse.md)
  - [GoodMemClient.ListSpacesResponse](docs/ListSpacesResponse.md)
  - [GoodMemClient.Memory](docs/Memory.md)
+ - [GoodMemClient.MemoryChunkResponse](docs/MemoryChunkResponse.md)
  - [GoodMemClient.MemoryCreationRequest](docs/MemoryCreationRequest.md)
  - [GoodMemClient.MemoryListResponse](docs/MemoryListResponse.md)
  - [GoodMemClient.Modality](docs/Modality.md)
+ - [GoodMemClient.PostProcessor](docs/PostProcessor.md)
  - [GoodMemClient.ProviderType](docs/ProviderType.md)
  - [GoodMemClient.RecursiveChunkingConfiguration](docs/RecursiveChunkingConfiguration.md)
  - [GoodMemClient.RerankerCreationRequest](docs/RerankerCreationRequest.md)
  - [GoodMemClient.RerankerResponse](docs/RerankerResponse.md)
  - [GoodMemClient.ResultSetBoundary](docs/ResultSetBoundary.md)
  - [GoodMemClient.RetrieveMemoryEvent](docs/RetrieveMemoryEvent.md)
+ - [GoodMemClient.RetrieveMemoryRequest](docs/RetrieveMemoryRequest.md)
  - [GoodMemClient.RetrievedItem](docs/RetrievedItem.md)
  - [GoodMemClient.SentenceChunkingConfiguration](docs/SentenceChunkingConfiguration.md)
  - [GoodMemClient.SeparatorKeepStrategy](docs/SeparatorKeepStrategy.md)
@@ -193,6 +380,7 @@ Class | Method | HTTP request | Description
  - [GoodMemClient.SpaceCreationRequest](docs/SpaceCreationRequest.md)
  - [GoodMemClient.SpaceEmbedder](docs/SpaceEmbedder.md)
  - [GoodMemClient.SpaceEmbedderConfig](docs/SpaceEmbedderConfig.md)
+ - [GoodMemClient.SpaceKey](docs/SpaceKey.md)
  - [GoodMemClient.SystemInitResponse](docs/SystemInitResponse.md)
  - [GoodMemClient.UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
  - [GoodMemClient.UpdateEmbedderRequest](docs/UpdateEmbedderRequest.md)
@@ -203,5 +391,5 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Authorization
 
-Endpoints do not require authorization.
+Authentication required - see configuration below.
 

package/dist/api/APIKeysApi.js

@@ -48,7 +48,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
 
   /**
    * Create a new API key
-   * Creates a new API key for authenticating with the API. The response includes the one-time raw API key value which will not be retrievable later.
+   * Creates a new API key for authenticating with the API. New keys start in ACTIVE status and can be used immediately for authentication. The response includes the one-time raw API key value which will not be retrievable later - clients must save this value as it cannot be recovered. Requires CREATE_APIKEY_OWN permission (or CREATE_APIKEY_ANY for admin users). Side effects include generating cryptographically secure key material, recording creation timestamp, and tracking creator ID. Returns INVALID_ARGUMENT if expires_at is set to a time in the past.
    * @param {module:model/CreateApiKeyRequest} createApiKeyRequest API key configuration
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateApiKeyResponse} and HTTP response
    */
@@ -73,7 +73,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Create a new API key
-     * Creates a new API key for authenticating with the API. The response includes the one-time raw API key value which will not be retrievable later.
+     * Creates a new API key for authenticating with the API. New keys start in ACTIVE status and can be used immediately for authentication. The response includes the one-time raw API key value which will not be retrievable later - clients must save this value as it cannot be recovered. Requires CREATE_APIKEY_OWN permission (or CREATE_APIKEY_ANY for admin users). Side effects include generating cryptographically secure key material, recording creation timestamp, and tracking creator ID. Returns INVALID_ARGUMENT if expires_at is set to a time in the past.
      * @param {module:model/CreateApiKeyRequest} createApiKeyRequest API key configuration
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateApiKeyResponse}
      */
@@ -87,7 +87,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Delete an API key
-     * Deletes (revokes) an API key. This operation cannot be undone.
+     * Permanently deletes an API key. This operation cannot be undone and immediately invalidates the key for all future authentication attempts. TIP: For reversible deactivation, use PUT /v1/apikeys/{id} with status=INACTIVE instead. Requires DELETE_APIKEY_OWN permission for keys you own (or DELETE_APIKEY_ANY for admin users to delete any user's keys). Side effects include permanently removing the key record from the database and immediate authentication invalidation.
      * @param {String} id The unique identifier of the API key to delete
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
@@ -114,7 +114,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Delete an API key
-     * Deletes (revokes) an API key. This operation cannot be undone.
+     * Permanently deletes an API key. This operation cannot be undone and immediately invalidates the key for all future authentication attempts. TIP: For reversible deactivation, use PUT /v1/apikeys/{id} with status=INACTIVE instead. Requires DELETE_APIKEY_OWN permission for keys you own (or DELETE_APIKEY_ANY for admin users to delete any user's keys). Side effects include permanently removing the key record from the database and immediate authentication invalidation.
      * @param {String} id The unique identifier of the API key to delete
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
@@ -128,7 +128,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * List API keys
-     * Retrieves a list of API keys belonging to the authenticated user. The list includes metadata about each key but not the actual key values.
+     * Retrieves a list of API keys belonging to the authenticated user. The list includes metadata about each key but not the actual key values or key hashes for security reasons. Requires LIST_APIKEY_OWN permission (or LIST_APIKEY_ANY for admin users to view keys from any user). This is a read-only operation with no side effects.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListApiKeysResponse} and HTTP response
      */
   }, {
@@ -148,7 +148,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * List API keys
-     * Retrieves a list of API keys belonging to the authenticated user. The list includes metadata about each key but not the actual key values.
+     * Retrieves a list of API keys belonging to the authenticated user. The list includes metadata about each key but not the actual key values or key hashes for security reasons. Requires LIST_APIKEY_OWN permission (or LIST_APIKEY_ANY for admin users to view keys from any user). This is a read-only operation with no side effects.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListApiKeysResponse}
      */
   }, {
@@ -161,7 +161,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Update an API key
-     * Updates an existing API key with new values for status or labels.
+     * Updates an existing API key with new values for status or labels. IMPORTANT: Key ID, user ownership, key material, and audit fields cannot be modified - only status (ACTIVE/INACTIVE) and labels are mutable. Requires UPDATE_APIKEY_OWN permission for keys you own (or UPDATE_APIKEY_ANY for admin users to modify any user's keys). Side effects include updating the updated_at timestamp and recording the updater's user ID. This operation is idempotent - repeated identical requests have no additional effect.
      * @param {String} id The unique identifier of the API key to update
      * @param {module:model/UpdateApiKeyRequest} updateApiKeyRequest API key update details
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ApiKeyResponse} and HTTP response
@@ -193,7 +193,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Update an API key
-     * Updates an existing API key with new values for status or labels.
+     * Updates an existing API key with new values for status or labels. IMPORTANT: Key ID, user ownership, key material, and audit fields cannot be modified - only status (ACTIVE/INACTIVE) and labels are mutable. Requires UPDATE_APIKEY_OWN permission for keys you own (or UPDATE_APIKEY_ANY for admin users to modify any user's keys). Side effects include updating the updated_at timestamp and recording the updater's user ID. This operation is idempotent - repeated identical requests have no additional effect.
      * @param {String} id The unique identifier of the API key to update
      * @param {module:model/UpdateApiKeyRequest} updateApiKeyRequest API key update details
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ApiKeyResponse}

package/dist/api/EmbeddersApi.js

@@ -47,7 +47,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
 
   /**
    * Create a new embedder
-   * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces.
+   * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another embedder exists with identical {owner_id, provider_type, endpoint_url, api_path, model_identifier, credentials_fingerprint} after URL canonicalization. Uniqueness is enforced per-owner, allowing different users to have identical configurations. Credentials are hashed (SHA-256) for uniqueness while remaining encrypted. The api_path field defaults to '/embeddings' if omitted. Requires CREATE_EMBEDDER_OWN permission (or CREATE_EMBEDDER_ANY for admin users).
    * @param {module:model/EmbedderCreationRequest} embedderCreationRequest Embedder configuration details
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EmbedderResponse} and HTTP response
    */
@@ -72,7 +72,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Create a new embedder
-     * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces.
+     * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another embedder exists with identical {owner_id, provider_type, endpoint_url, api_path, model_identifier, credentials_fingerprint} after URL canonicalization. Uniqueness is enforced per-owner, allowing different users to have identical configurations. Credentials are hashed (SHA-256) for uniqueness while remaining encrypted. The api_path field defaults to '/embeddings' if omitted. Requires CREATE_EMBEDDER_OWN permission (or CREATE_EMBEDDER_ANY for admin users).
      * @param {module:model/EmbedderCreationRequest} embedderCreationRequest Embedder configuration details
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmbedderResponse}
      */
@@ -86,7 +86,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Delete an embedder
-     * Deletes an embedder configuration. This operation cannot be undone.
+     * Permanently deletes an embedder configuration. This operation cannot be undone and removes the embedder record and securely deletes stored credentials. IMPORTANT: This does NOT invalidate or delete embeddings previously created with this embedder - existing embeddings remain accessible. Requires DELETE_EMBEDDER_OWN permission for embedders you own (or DELETE_EMBEDDER_ANY for admin users).
      * @param {String} id The unique identifier of the embedder to delete
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
@@ -113,7 +113,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Delete an embedder
-     * Deletes an embedder configuration. This operation cannot be undone.
+     * Permanently deletes an embedder configuration. This operation cannot be undone and removes the embedder record and securely deletes stored credentials. IMPORTANT: This does NOT invalidate or delete embeddings previously created with this embedder - existing embeddings remain accessible. Requires DELETE_EMBEDDER_OWN permission for embedders you own (or DELETE_EMBEDDER_ANY for admin users).
      * @param {String} id The unique identifier of the embedder to delete
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
@@ -127,7 +127,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Get an embedder by ID
-     * Retrieves the details of a specific embedder configuration by its unique identifier.
+     * Retrieves the details of a specific embedder configuration by its unique identifier. Requires READ_EMBEDDER_OWN permission for embedders you own (or READ_EMBEDDER_ANY for admin users to view any user's embedders). This is a read-only operation with no side effects.
      * @param {String} id The unique identifier of the embedder to retrieve
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EmbedderResponse} and HTTP response
      */
@@ -154,7 +154,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Get an embedder by ID
-     * Retrieves the details of a specific embedder configuration by its unique identifier.
+     * Retrieves the details of a specific embedder configuration by its unique identifier. Requires READ_EMBEDDER_OWN permission for embedders you own (or READ_EMBEDDER_ANY for admin users to view any user's embedders). This is a read-only operation with no side effects.
      * @param {String} id The unique identifier of the embedder to retrieve
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmbedderResponse}
      */
@@ -168,9 +168,9 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * List embedders
-     * Retrieves a list of embedder configurations accessible to the caller, with optional filtering.
+     * Retrieves a list of embedder configurations accessible to the caller, with optional filtering. PERMISSION-BASED FILTERING: With LIST_EMBEDDER_OWN permission, you can only see your own embedders (owner_id filter is ignored if set to another user). With LIST_EMBEDDER_ANY permission, you can see all embedders or filter by any owner_id. This is a read-only operation with no side effects.
      * @param {Object} opts Optional parameters
-     * @param {String} [ownerId] Filter embedders by owner ID. If not provided, shows embedders based on permissions.
+     * @param {String} [ownerId] Filter embedders by owner ID. With LIST_EMBEDDER_ANY permission, omitting this shows all accessible embedders; providing it filters by that owner. With LIST_EMBEDDER_OWN permission, only your own embedders are shown regardless of this parameter.
      * @param {String} [providerType] Filter embedders by provider type (e.g., OPENAI, OPENAI_COMPATIBLE, COHERE, etc.)
      * @param {String} [label] Filter by label value. Multiple label filters can be specified (e.g., ?label.environment=production&label.team=nlp)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListEmbeddersResponse} and HTTP response
@@ -197,9 +197,9 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * List embedders
-     * Retrieves a list of embedder configurations accessible to the caller, with optional filtering.
+     * Retrieves a list of embedder configurations accessible to the caller, with optional filtering. PERMISSION-BASED FILTERING: With LIST_EMBEDDER_OWN permission, you can only see your own embedders (owner_id filter is ignored if set to another user). With LIST_EMBEDDER_ANY permission, you can see all embedders or filter by any owner_id. This is a read-only operation with no side effects.
      * @param {Object} opts Optional parameters
-     * @param {String} opts.ownerId Filter embedders by owner ID. If not provided, shows embedders based on permissions.
+     * @param {String} opts.ownerId Filter embedders by owner ID. With LIST_EMBEDDER_ANY permission, omitting this shows all accessible embedders; providing it filters by that owner. With LIST_EMBEDDER_OWN permission, only your own embedders are shown regardless of this parameter.
      * @param {String} opts.providerType Filter embedders by provider type (e.g., OPENAI, OPENAI_COMPATIBLE, COHERE, etc.)
      * @param {String} opts.label Filter by label value. Multiple label filters can be specified (e.g., ?label.environment=production&label.team=nlp)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListEmbeddersResponse}
@@ -214,7 +214,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Update an embedder
-     * Updates an existing embedder configuration with new values for the specified fields.
+     * Updates an existing embedder configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT: provider_type is IMMUTABLE after creation and cannot be changed. CRITICAL: Returns FAILED_PRECONDITION if attempting to update core fields (dimensionality, distribution_type, model_identifier) while the embedder is actively referenced by spaces or ingestion jobs. Requires UPDATE_EMBEDDER_OWN permission for embedders you own (or UPDATE_EMBEDDER_ANY for admin users).
      * @param {String} id The unique identifier of the embedder to update
      * @param {module:model/UpdateEmbedderRequest} updateEmbedderRequest Embedder update details
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EmbedderResponse} and HTTP response
@@ -246,7 +246,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Update an embedder
-     * Updates an existing embedder configuration with new values for the specified fields.
+     * Updates an existing embedder configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT: provider_type is IMMUTABLE after creation and cannot be changed. CRITICAL: Returns FAILED_PRECONDITION if attempting to update core fields (dimensionality, distribution_type, model_identifier) while the embedder is actively referenced by spaces or ingestion jobs. Requires UPDATE_EMBEDDER_OWN permission for embedders you own (or UPDATE_EMBEDDER_ANY for admin users).
      * @param {String} id The unique identifier of the embedder to update
      * @param {module:model/UpdateEmbedderRequest} updateEmbedderRequest Embedder update details
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmbedderResponse}