AI Suggestions

AI-powered recommendations for policies, schemas, and workflows.

Get methodology suggestion

get

Returns AI response to the current question

Query parameters

qstringRequired

The question of choosing a methodology

Example: Find me large scale projects

Responses

200

Successful operation. Returns a comma-separated list of suggested methodology codes.

application/json

stringOptional

500

Internal server error.

application/json

get/ai-suggestions/ask

GET /api/v1/ai-suggestions/ask?q=Find+me+large+scale+projects HTTP/1.1
Accept: */*

ACM0001, ACM0002, ACM0006, ACM0007, ACM0018

Rebuild AI vector

put

Rebuilds vector based on policy data in the DB

Responses

200

Successful operation. Returns true when vector rebuild is complete.

application/json

booleanOptional

500

Internal server error.

application/json

put/ai-suggestions/rebuild-vector

PUT /api/v1/ai-suggestions/rebuild-vector HTTP/1.1
Accept: */*

true

Returns whether Glossary AI is enabled

get

Lets the client know upfront whether it should show the Glossary AI schema-tagging UI at all.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

get/ai-suggestions/schema-properties/enabled

GET /api/v1/ai-suggestions/schema-properties/enabled HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Suggest schema field properties

post

Returns ranked IWA property candidates for each schema field

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

schemaIdstringRequired

Id of the schema the field(s) needing a suggestion belong to

fieldNamesstring[]Required

Names of the schema fields to return suggestions for

Responses

200

Successful operation.

application/json

availablebooleanRequired

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post/ai-suggestions/schema-properties

POST /api/v1/ai-suggestions/schema-properties HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "schemaId": "text",
  "fieldNames": [
    "text"
  ]
}

{
  "available": true,
  "results": [
    {
      "fieldName": "text",
      "candidates": [
        {
          "title": "text",
          "confidence": 1,
          "rationale": "text"
        }
      ]
    }
  ]
}