@cognigy/rest-api-client 4.94.0 → 4.95.0

package/CHANGELOG.md

@@ -1,7 +1,7 @@
-# 4.94.0
-Released: February 07th, 2025 
+# 4.95.0
+Released: February 19th, 2025 
 
-Released state of package up to date with Cognigy.AI v4.94.0 
+Released state of package up to date with Cognigy.AI v4.95.0 
 
 # 4.93.0
 Released: Jan 22nd, 2025

package/build/shared/interfaces/IProfile.js

@@ -13,6 +13,7 @@ exports.profileDataSchema = {
     properties: {
         active: { type: "boolean" },
         contactIds: { type: "array", items: { type: "string" }, additionalItems: false, minItems: 1 },
+        contactIdsHash: { type: "string" },
         expiresAt: { type: "object" },
         profile: {},
     },

package/build/shared/interfaces/IProfileSchema.js

@@ -24,6 +24,11 @@ exports.profileSchemaSchema = {
             },
         } }),
 };
+/**
+ * WARNING!!
+ * make sure to update the default values for the profile mongoose model in the models/profiles.ts file
+ * when changing the profile schema and the default profile object below
+ */
 exports.defaultProfile = {
     firstname: "",
     lastname: "",

package/build/shared/interfaces/resources/IConnection.js

@@ -11,7 +11,7 @@ exports.connectionFieldReturnFormat = [
 ];
 const generateConnectionsRedisKey = (data) => {
     return [
-        `organisationId:${data.organisationReference}:projectId:${data.projectReference}:connection:${data.referenceId}`
+        `organisationId:${data.organisationReference}:${data.projectReference ? `projectId:${data.projectReference}:` : ''}connection:${data.referenceId}`
     ];
 };
 exports.generateConnectionsRedisKey = generateConnectionsRedisKey;
@@ -54,7 +54,8 @@ exports.connectionDataSchema = {
         },
         extension: { type: "string", format: "package-name" },
         type: { type: "string", format: "resource-name" },
-        isDeprecated: { type: "boolean" }
+        isDeprecated: { type: "boolean" },
+        resourceLevel: { type: "string", enum: ["organisation", "project"] }
     }
 };
 exports.connectionSchema = {

package/build/shared/interfaces/resources/IGlobalResource.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IGlobalResource.js.map

package/build/shared/interfaces/resources/ILargeLanguageModel.js

@@ -122,7 +122,16 @@ exports.largeLanguageModelDataSchema = {
         alephAlpha: exports.alephAlphaMetaSchema,
         anthropic: exports.anthropicMetaSchema,
         awsBedrock: exports.awsBedrockMetaSchema,
-        fallbacks: exports.llmFallbackSchema
+        fallbacks: exports.llmFallbackSchema,
+        resourceLevel: { type: "string", enum: ["organisation", "project"] },
+        assignedToProjects: {
+            type: "array",
+            uniqueItems: true,
+            items: {
+                type: "string",
+                format: "mongo-id"
+            }
+        }
     }
 };
 exports.largeLanguageModelSchema = {

package/dist/esm/shared/interfaces/IProfile.js

@@ -10,6 +10,7 @@ export const profileDataSchema = {
     properties: {
         active: { type: "boolean" },
         contactIds: { type: "array", items: { type: "string" }, additionalItems: false, minItems: 1 },
+        contactIdsHash: { type: "string" },
         expiresAt: { type: "object" },
         profile: {},
     },

package/dist/esm/shared/interfaces/IProfileSchema.js

@@ -21,6 +21,11 @@ export const profileSchemaSchema = {
             },
         } }),
 };
+/**
+ * WARNING!!
+ * make sure to update the default values for the profile mongoose model in the models/profiles.ts file
+ * when changing the profile schema and the default profile object below
+ */
 export const defaultProfile = {
     firstname: "",
     lastname: "",

package/dist/esm/shared/interfaces/resources/IConnection.js

@@ -8,7 +8,7 @@ export const connectionFieldReturnFormat = [
 ];
 export const generateConnectionsRedisKey = (data) => {
     return [
-        `organisationId:${data.organisationReference}:projectId:${data.projectReference}:connection:${data.referenceId}`
+        `organisationId:${data.organisationReference}:${data.projectReference ? `projectId:${data.projectReference}:` : ''}connection:${data.referenceId}`
     ];
 };
 export const connectionFieldDataSchema = {
@@ -50,7 +50,8 @@ export const connectionDataSchema = {
         },
         extension: { type: "string", format: "package-name" },
         type: { type: "string", format: "resource-name" },
-        isDeprecated: { type: "boolean" }
+        isDeprecated: { type: "boolean" },
+        resourceLevel: { type: "string", enum: ["organisation", "project"] }
     }
 };
 export const connectionSchema = {

package/dist/esm/shared/interfaces/resources/IGlobalResource.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IGlobalResource.js.map

package/dist/esm/shared/interfaces/resources/ILargeLanguageModel.js

@@ -119,7 +119,16 @@ export const largeLanguageModelDataSchema = {
         alephAlpha: alephAlphaMetaSchema,
         anthropic: anthropicMetaSchema,
         awsBedrock: awsBedrockMetaSchema,
-        fallbacks: llmFallbackSchema
+        fallbacks: llmFallbackSchema,
+        resourceLevel: { type: "string", enum: ["organisation", "project"] },
+        assignedToProjects: {
+            type: "array",
+            uniqueItems: true,
+            items: {
+                type: "string",
+                format: "mongo-id"
+            }
+        }
     }
 };
 export const largeLanguageModelSchema = {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognigy/rest-api-client",
-	"version": "4.94.0",
+	"version": "4.95.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/esm/index.js",

package/types/index.d.ts

@@ -8414,10 +8414,85 @@ export interface IGraphAgentAssistConfig {
 	referenceId: string;
 	properties: Pick<IAgentAssistConfig, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
 }
+/**
+ * @openapi
+ * components:
+ *   parameters:
+ *     globalResourceQueryParam:
+ *       in: query
+ *       name: resourceLevel
+ *       description: Scope of the resource (global "organisation" or project).
+ *       required: false
+ *       schema:
+ *         $ref: '#/components/schemas/ResourceLevel'
+ *   schemas:
+ *     ResourceLevel:
+ *       type: string
+ *       enum:
+ *         - organisation
+ *         - project
+ *       description: General scope of the resource.
+ *       default: project
+ *
+ *     ProjectScopedResource:
+ *       type: object
+ *       properties:
+ *         resourceLevel:
+ *           type: string
+ *           enum:
+ *             - project
+ *           description: Scope for project-level resources.
+ *
+ *     GlobalScopedResource:
+ *       type: object
+ *       properties:
+ *         resourceLevel:
+ *           type: string
+ *           enum:
+ *             - organisation
+ *           description: Scope for globally scoped resources.
+ *       required:
+ *         - resourceLevel
+ *
+ *     AssignedToProjects:
+ *       type: object
+ *       properties:
+ *         assignedToProjects:
+ *           type: array
+ *           items:
+ *             type: string
+ *             description: MongoDB ObjectId representing a project
+ *
+ *     IGlobalResourceFields_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/GlobalScopedResource'
+ *         - $ref: '#/components/schemas/AssignedToProjects'
+ *
+ *     IProjectResourceFields_2_0:
+ *        $ref: '#/components/schemas/ProjectScopedResource'
+ *
+ *     IGlobalResourceData:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalResourceFields_2_0'
+ *         - type: object
+ *           properties:
+ *             id:
+ *               type: string
+ *               description: The unique identifier for the resource.
+ *               example: 507f191e810c19729de860eb
+ *
+ *     IGlobalResource:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalResourceData'
+ */
+export interface IGlobalResource {
+	resourceLevel?: "organisation" | "project";
+	assignedToProjects?: TMongoId[];
+}
 export interface IConnectionFields {
 	[key: string]: string;
 }
-export interface IConnection extends IEntityMeta {
+export interface IConnection extends IEntityMeta, Pick<IGlobalResource, "resourceLevel"> {
 	_id: TMongoId;
 	referenceId: string;
 	name: string;
@@ -8483,7 +8558,7 @@ export declare type TLLMFallback = {
 		emailNotificationList: string[];
 	};
 };
-export interface ILargeLanguageModel extends IEntityMeta {
+export interface ILargeLanguageModel extends IEntityMeta, IGlobalResource {
 	_id: TMongoId;
 	referenceId: string;
 	name: string;
@@ -8495,7 +8570,7 @@ export interface ILargeLanguageModel extends IEntityMeta {
 	provider: TGenerativeAIProviders;
 	connectionId: string;
 	isDefault: boolean;
-	projectReference: TMongoId;
+	projectReference?: TMongoId;
 	organisationReference: TMongoId;
 	azureOpenAI?: IAzureOpenAIMeta;
 	googleVertexAI?: IGoogleVertexAIMeta;
@@ -14496,7 +14571,7 @@ export interface IComposeSnapshotDownloadLinkRestReturnValue_2_0 {
  *                   description: The type of connection.
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface IConnectionIndexItem_2_0 {
+export interface IConnectionIndexItem_2_0 extends Pick<IGlobalResource, "resourceLevel"> {
 	_id: TMongoId;
 	referenceId: string;
 	name: string;
@@ -14579,7 +14654,7 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
  *         - $ref: '#/components/schemas/IConnectionData_2_0'
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface IConnection_2_0 {
+export interface IConnection_2_0 extends Pick<IGlobalResource, "resourceLevel"> {
 	referenceId: string;
 	_id: TMongoId;
 	name: string;
@@ -16633,103 +16708,111 @@ export interface IGoogleGeminiMeta_2_0 {
  *
  * components:
  *   schemas:
- *     ILargeLanguageModelFields_2_0:
- *       allOf:
- *         - type: object
- *           required: ['name', 'modelType', 'provider', 'connectionId']
+ *     ILargeLanguageModelFieldsBase_2_0:
+ *       type: object
+ *       required: ['name', 'modelType', 'provider', 'connectionId']
+ *       properties:
+ *         name:
+ *           type: string
+ *           example: "LLM Name"
+ *         description:
+ *           type: string
+ *           example: "LLM meaningful description"
+ *         modelType:
+ *           $ref: '#/components/schemas/TGenerativeAIModels'
+ *         modelGroup:
+ *           $ref: '#/components/schemas/TModelGroups'
+ *         isCustomModel:
+ *           type: boolean
+ *           example: true
+ *         provider:
+ *           $ref: '#/components/schemas/TGenerativeAIProviders'
+ *         connectionId:
+ *           type: string
+ *           description: The reference id of the GenerativeAI Provider Connection
+ *           format: uuid
+ *         openAI:
+ *           type: object
+ *           description: OpenAI specific meta data
  *           properties:
- *             name:
+ *             customModel:
  *               type: string
- *               example: "LLM Name"
- *             description:
+ *               example: gpt-4-32k-0613
+ *               description: The custom model name. This does not work with embedding models
+ *         anthropic:
+ *           type: object
+ *           description: Anthropic specific meta data
+ *           properties:
+ *             customModel:
  *               type: string
- *               example: "LLM meaningful description"
- *             modelType:
- *               $ref: '#/components/schemas/TGenerativeAIModels'
- *             modelGroup:
- *               $ref: '#/components/schemas/TModelGroups'
- *             isCustomModel:
- *               type: boolean
- *               example: true
- *             provider:
- *               $ref: '#/components/schemas/TGenerativeAIProviders'
- *             connectionId:
+ *               example: claude-3-opus-20240229
+ *               description: The custom model name. This does not work with embedding models
+ *         azureOpenAI:
+ *           type: object
+ *           description: Azure OpenAI specific meta data
+ *           properties:
+ *             resourceName:
  *               type: string
- *               description: The reference id of the GenerativeAI Provider Connection
- *               format: uuid
+ *             deploymentName:
+ *               type: string
+ *             apiVersion:
+ *               type: string
+ *             baseCustomUrl:
+ *               type: string
+ *               example:
+ *                 - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>
+ *                 - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>
+ *                 - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>
+ *         googleVertexAI:
+ *           type: object
+ *           description: Google VertexAI specific meta data
+ *           properties:
+ *             location:
+ *               type: string
+ *             apiEndpoint:
+ *               type: string
+ *             publisher:
+ *               type: string
+ *         googleGemini:
+ *           type: object
+ *           description: Google Gemini specific meta data
+ *           properties:
+ *             location:
+ *               type: string
+ *         alephAlpha:
+ *           type: object
+ *           description: Aleph Alpha specific meta data
+ *           properties:
+ *             customModel:
+ *               type: string
+ *               example: luminous-003
+ *               description: The custom model name. This does not work with embedding models
+ *             baseCustomUrl:
+ *               type: string
+ *               example: https://api.aleph-alpha.com
+ *
+ *     ILargeLanguageModelFields_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/ILargeLanguageModelFieldsBase_2_0'
+ *         - $ref: '#/components/schemas/IProjectResourceFields_2_0'
+ *         - type: object
+ *           properties:
  *             isDefault:
  *               type: boolean
  *               description: Sets the LLM to default (fallback) if no other LLM is set
  *               example: false
- *             openAI:
- *               type: object
- *               description: OpenAI specific meta data
- *               properties:
- *                 customModel:
- *                   type: string
- *                   example: gpt-4-32k-0613
- *                   description: The custom model name. This does not work with embedding models
- *             anthropic:
- *               type: object
- *               description: Anthropic specific meta data
- *               properties:
- *                 customModel:
- *                   type: string
- *                   example: claude-3-opus-20240229
- *                   description: The custom model name. This does not work with embedding models
- *             azureOpenAI:
- *               type: object
- *               description: Azure OpenAI specific meta data
- *               properties:
- *                 resourceName:
- *                   type: string
- *                 deploymentName:
- *                   type: string
- *                 apiVersion:
- *                   type: string
- *                 baseCustomUrl:
- *                   type: string
- *                   example:
- *                     - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>
- *                     - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>
- *                     - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>
- *             googleVertexAI:
- *               type: object
- *               description: Google VertexAI specific meta data
- *               properties:
- *                 location:
- *                   type: string
- *                 apiEndpoint:
- *                   type: string
- *                 publisher:
- *                   type: string
- *             googleGemini:
- *               type: object
- *               description: Google Gemini specific meta data
- *               properties:
- *                 location:
- *                   type: string
- *             alephAlpha:
- *               type: object
- *               description: Aleph Alpha specific meta data
- *               properties:
- *                 customModel:
- *                   type: string
- *                   example: luminous-003
- *                   description: The custom model name. This does not work with embedding models
- *                 baseCustomUrl:
- *                   type: string
- *                   example: https://api.aleph-alpha.com
  *             fallbacks:
  *               type: array
  *               description: (alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.
  *               items:
  *                 $ref: '#/components/schemas/ILLMFallback_2_0'
- *
+ *     IGlobalLargeLanguageModelFields_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/ILargeLanguageModelFieldsBase_2_0'
+ *         - $ref: '#/components/schemas/IGlobalResourceFields_2_0'
  *     ILargeLanguageModelCreate_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/ILargeLanguageModelFields_2_0'
- *
  *     ILargeLanguageModelData_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/ILargeLanguageModelFields_2_0'
@@ -16739,13 +16822,25 @@ export interface IGoogleGeminiMeta_2_0 {
  *               type: string
  *               description: The reference id of the LargeLanguageModel
  *               format: uuid
- *
+ *     IGlobalLargeLanguageModelData_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalLargeLanguageModelFields_2_0'
+ *         - type: object
+ *           properties:
+ *             referenceId:
+ *               type: string
+ *               description: The reference id of the LargeLanguageModel
+ *               format: uuid
+ *     IGlobalLargeLanguageModel_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
+ *         - $ref: '#/components/schemas/IEntityMeta'
  *     ILargeLanguageModel_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/ILargeLanguageModelData_2_0'
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface ILargeLanguageModel_2_0 {
+export interface ILargeLanguageModel_2_0 extends IGlobalResource {
 	referenceId: string;
 	_id: TMongoId;
 	name: string;
@@ -16811,7 +16906,7 @@ export interface ILargeLanguageModel_2_0 {
  *               example: false
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface ILargeLanguageModelIndexItem_2_0 {
+export interface ILargeLanguageModelIndexItem_2_0 extends IGlobalResource {
 	referenceId: string;
 	_id: TMongoId;
 	name: string;