Skip to content

Latest commit

 

History

History
313 lines (289 loc) · 7.69 KB

acs-private-apis.md

File metadata and controls

313 lines (289 loc) · 7.69 KB

ACS Private REST APIs for Hx Insight Integration

Purpose

This document describes private REST APIs that are available in Alfresco Content Services (ACS) Extension for Hx Insight integration.

Endpoints

Base path for all endpoints mentioned below is {acs_host}/alfresco/api/-default-/private/hxi/versions/1

Agents API

Get Agents

List of agents that are available for Hx Insights.

  • Method: GET
  • Path: /agents
  • Response:
    • Status: 200
    • Content-Type: application/json
    • Entry object (wrapped with list/pagination information):
      • name [string]
      • description [string]
      • id [string]
    • Sample
    {
  "list": {
    "pagination": {
      "count": 2,
      "hasMoreItems": false,
      "totalItems": 2,
      "skipCount": 0,
      "maxItems": 100
    },
    "entries": [
      {
        "entry": {
          "name": "HR Policy Agent",
          "description": "This agent is responsible for HR policy predictions",
          "id": "5fca2c77-cdc0-4118-9373-e75f53177ff8",
          "avatarUrl": "https://dummy-host.xyz/avatars/agent2.png"
        }
      },
      {
        "entry": {
          "name": "Knowledge Base Agent",
          "description": "Very smart about product knowledge",
          "id": "b999ee14-3974-41b2-bef8-70ab38c9e642",
          "avatarUrl": "https://dummy-host.xyz/avatars/agent2.png"
        }
      }
    ]
  }
}

Questions API

Ask Question

Ask a question for Hx Insights.

  • Method: POST
  • Path: /agents/{agentId}/questions
  • Request:
    • Content-Type: application/json
    • Body:
      • question [string]
      • restrictionQuery [object]:
        • nodeIds [array of strings]
    • Sample
    {
  "question": "What is the policy for maternity leave?",
  "restrictionQuery": {
    "nodeIds": ["nodeId1", "nodeId2"]
  }
}
  • Response:
    • Status: 201
    • Content-Type: application/json
    • Body (entry of):
      • question [string]
      • restrictionQuery [object]:
        • nodeIds [array of strings]
      • questionId [string]
    • Sample 
      {
    "entry": {
        "questionId": "5fca2c77-cdc0-4118-9373-e75f53177ff8",
        "question": "What is the meaning of life?",
        "restrictionQuery": {
            "nodesIds": [
                "5fa74ad3-9b5b-461b-9df5-de407f1f4fe7"
            ]
        }
    }
}

Retry Question

Ask a question for Hx Insights (not ready on Hx Insight side yet).

  • Method: POST
  • Path: /agents/{agentId}/questions/{questionId}/retry
  • Request:
    • Content-Type: application/json
    • Body:
      • comments [string]
      • originalQuestion [object]:
        • question [string]
        • restrictionQuery [object]:
          • nodeIds [array of strings]
    • Sample
    {
  "comments": "I need more details about the answer.",
  "originalQuestion": {
    "question": "What is the meaning of life?",
    "restrictionQuery": {
      "nodesIds": [
        "nodeId1"
      ]
    }
  }
}

Send feedback on an answer

Send feedback about an answer from Hx Insight (not ready on Hx Insight side yet).

  • Method: POST
  • Path: /questions/{questionId}/feedback
  • Request:
    • Content-Type: application/json
    • Body:
      • comments [string]
      • feedbackType [LIKE|DISLIKE]
    • Sample
    {
  "comments": "I need more details about the answer.",
  "feedbackType": "DISLIKE"
}

Answers API

Get answer for a question.

  • Method: GET
  • Path: questions/{questionId}/answers/-default-
  • Response:
    • Status: 200
    • Content-Type: application/json
    • Body (entry of):
      • question [string]
      • answer [string]
      • isComplete [boolean]
      • references [object]:
        • referenceId [string]
        • referenceText [string]
    • Sample
{
    "entry": {
        "question": "This is the question",
        "answer": "This is the answer to the question",
        "isComplete": false,
        "references": [
            {
                "referenceId": "276718b0-c3ab-4e11-81d5-96dbbb540269",
                "referenceText": "This is the text reference which led to generating the answer"
            }
        ]
    }
}

Hx Insights Configuration API

Get Hx Insights configuration.

  • Method: GET
  • Path: config/-default-
  • Response:
    • Status: 200
    • Content-Type: application/json
    • Body (entry of):
      • knowledgeRetrievalUrl [string]
    • Sample
{
    "entry": {
        "knowledgeRetrievalUrl": "http://dummy-host.xyz/knowledge-retrieval/bots"
    }
}

Nodes API extension

Get properties affected by predictions for a given node.

  • Path: nodes/{nodeId}
  • Method: GET
  • Response:
    • Status: 200
    • Content-Type: application/json
    • Body (entry of):
      • id [string]
      • latestPredictionDateTime [timestamp]
      • predictedProperties [collection of strings]
    • Sample
{
  "entry": {
    "predictedProperties": [
      "cm:description"
    ],
    "id": "5fa74ad3-9b5b-461b-9df5-de407f1f4fe7",
    "latestPredictionDateTime": "2024-08-30T10:18:42.389+0000"
  }
}

Predictions API

Get Predictions

Get predicted values for a node.

  • Path: nodes/{nodeId}/predictions
  • Method: GET
  • Response:
    • Status: 200
    • Content-Type: application/json
    • Entry object (wrapped with list/pagination information):
      • id [string]
      • property [string]
      • predictionValue [value]
      • previousValue [value]
      • confidenceLevel [number]
      • modelId [string]
      • reviewStatus [UNREVIEWED|CONFIRMED|REJECTED]
      • updateType [AUTOFILL|AUTOCORRECT]
    • Sample
{
  "list": {
    "pagination": {
      "count": 1,
      "hasMoreItems": false,
      "totalItems": 1,
      "skipCount": 0,
      "maxItems": 100
    },
    "entries": [
      {
        "entry": {
          "confidenceLevel": 0.97,
          "modelId": "56785678-5678-5678-5678-567856785678",
          "property": "cm:description",
          "reviewStatus": "UNREVIEWED",
          "id": "9bc52780-a41f-4c54-8527-80a41f2c54ac",
          "previousValue": "Budget file for the web site redesign",
          "predictionValue": "budget",
          "updateType": "AUTOCORRECT"
        }
      }
    ]
  }
}

Submit Predictions [Internal]

Submit predicted values for a node. Note that this is not intended to be used by the UI.

  • Path: nodes/{nodeId}/predictions
  • Method: POST
  • Request:
    • Content-Type: application/json
    • Body:
      • id [string]
      • property [string]
      • predictionValue [value]
      • confidenceLevel [number]
      • modelId [string]
      • reviewStatus [UNREVIEWED|CONFIRMED|REJECTED]
      • updateType [AUTOFILL|AUTOCORRECT]
      • predictionDateTime [timestamp]
    • Sample:
{
    "property": "cm:title",
    "predictionValue": "Hello",
    "confidenceLevel": 0.95,
    "updateType": "AUTOCORRECT",
    "modelId": "56785678-5678-5678-5678-567856785678",
    "predictionDateTime":"2024-09-06T11:45:00.000+0000",
    "reviewStatus": "UNREVIEWED"
}

Review Prediction

Review a predicted value for a node (not ready for use yet - see ACS-7949).

  • Path: nodes/{nodeId}/predictions/{predictionId}/review
  • Method: POST
  • Request:
    • Content-Type: application/json
    • Body:
      • reviewStatus [UNREVIEWED|CONFIRMED|REJECTED]
  • Sample:
{
    "reviewStatus": "CONFIRMED"
}