feat(ai): add AI settings endpoint and related schemas to marblecore API

Author: OrriMandarin

packages/marble-api/openapis/marblecore-api.yaml

@@ -344,6 +344,11 @@ paths:
   /settings/me/unavailable:
     $ref: ./marblecore-api/users.yml#/~1settings~1me~1unavailable
 
+  # AI
+
+  /settings/ai:
+    $ref: ./marblecore-api/ai.yml#/~1settings~1ai
+
 components:
   securitySchemes:
     $ref: marblecore-api/_common.yml#/securitySchemes

packages/marble-api/openapis/marblecore-api/_schemas.yml

@@ -446,3 +446,14 @@ WorkflowActionCase:
 
 PersonalSettingsUnavailableDto:
   $ref: users.yml#/components/schemas/PersonalSettingsUnavailableDto
+
+# AI
+
+KycEnrichmentSettingDto:
+  $ref: ai.yml#/components/schemas/KycEnrichmentSettingDto
+CaseReviewSettingDto:
+  $ref: ai.yml#/components/schemas/CaseReviewSettingDto
+AISettingsDto:
+  $ref: ai.yml#/components/schemas/AISettingsDto
+UpsertAISettingsDto:
+  $ref: ai.yml#/components/schemas/UpsertAISettingsDto

packages/marble-api/openapis/marblecore-api/ai.yml

@@ -0,0 +1,105 @@
+/settings/ai:
+  get:
+    tags:
+      - AI settings
+    summary: Get the current AI settings
+    operationId: getAISettings
+    security:
+      - bearerAuth: []
+    responses:
+      "200":
+        description: Current AI settings for an organization
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AISettingsDto"
+      "401":
+        $ref: "components.yml#/responses/401"
+      "403":
+        $ref: "components.yml#/responses/403"
+      "404":
+        description: The organization has no AI settings
+  put:
+    tags:
+      - AI settings
+    summary: Upsert AI settings for an organization
+    operationId: upsertAISettings
+    security:
+      - bearerAuth: []
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/UpsertAISettingsDto"
+    responses:
+      "200":
+        description: AI settings upserted
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AISettingsDto"
+      "401":
+        $ref: "components.yml#/responses/401"
+      "403":
+        $ref: "components.yml#/responses/403"
+
+components:
+  schemas:
+    KycEnrichmentSettingDto:
+      type: object
+      properties:
+        model:
+          type: string
+        domain_filter:
+          type: array
+          items:
+            type: string
+        search_context_size:
+          type: string
+          enum:
+            - low
+            - medium
+            - high
+    CaseReviewSettingDto:
+      type: object
+      properties:
+        org_description:
+          type: string
+        language:
+          type: string
+        structure:
+          type: string
+
+    AISettingsDto:
+      type: object
+      required:
+        - org_id
+        - created_at
+        - updated_at
+        - kyc_enrichment_setting
+        - case_review_setting
+      properties:
+        org_id:
+          type: string
+          format: uuid
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+        kyc_enrichment_setting:
+          $ref: "#/components/schemas/KycEnrichmentSettingDto"
+        case_review_setting:
+          $ref: "#/components/schemas/CaseReviewSettingDto"
+    UpsertAISettingsDto:
+      type: object
+      required:
+        - kyc_enrichment_setting
+        - case_review_setting
+      properties:
+        kyc_enrichment_setting:
+          $ref: "#/components/schemas/KycEnrichmentSettingDto"
+        case_review_setting:
+          $ref: "#/components/schemas/CaseReviewSettingDto"

packages/marble-api/src/generated/marblecore-api.ts

@@ -1302,6 +1302,27 @@ export type WorkflowRuleDetailDto = WorkflowRuleDto & {
 export type PersonalSettingsUnavailableDto = {
     until: string;
 };
+export type KycEnrichmentSettingDto = {
+    model?: string;
+    domain_filter?: string[];
+    search_context_size?: "low" | "medium" | "high";
+};
+export type CaseReviewSettingDto = {
+    org_description?: string;
+    language?: string;
+    structure?: string;
+};
+export type AiSettingsDto = {
+    org_id: string;
+    created_at: string;
+    updated_at: string;
+    kyc_enrichment_setting: KycEnrichmentSettingDto;
+    case_review_setting: CaseReviewSettingDto;
+};
+export type UpsertAiSettingsDto = {
+    kyc_enrichment_setting: KycEnrichmentSettingDto;
+    case_review_setting: CaseReviewSettingDto;
+};
 /**
  * Get an access token
  */
@@ -4712,3 +4733,41 @@ export function cancelUnavailability(opts?: Oazapfts.RequestOpts) {
         method: "DELETE"
     }));
 }
+/**
+ * Get the current AI settings
+ */
+export function getAiSettings(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: AiSettingsDto;
+    } | {
+        status: 401;
+        data: string;
+    } | {
+        status: 403;
+        data: string;
+    } | {
+        status: 404;
+    }>("/settings/ai", {
+        ...opts
+    }));
+}
+/**
+ * Upsert AI settings for an organization
+ */
+export function upsertAiSettings(upsertAiSettingsDto: UpsertAiSettingsDto, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: AiSettingsDto;
+    } | {
+        status: 401;
+        data: string;
+    } | {
+        status: 403;
+        data: string;
+    }>("/settings/ai", oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: upsertAiSettingsDto
+    })));
+}