Knowledge_base_nodes

Knowledge base node related APIs

Move Knowledge Base Nodes

post

Authorizations

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

targetFolderIdany ofRequired

stringOptional

or

nullOptional

nodeIdsstring[]Required

keepCurrentPermissionbooleanRequired

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/move/bulk HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "targetFolderId": "text",
  "nodeIds": [
    "text"
  ],
  "keepCurrentPermission": true
}

200

OK

{
  "moved_kb_node_ids": [
    "text"
  ],
  "failed_kb_node_ids": [
    "text"
  ]
}

Upload Knowledge Base Node

post

Authorizations

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

fileNamestringRequired

The file name of the knowledge base

hashtagsany ofOptional

The hashtags of the knowledge base

string[]Optional

or

nullOptional

targetFolderIdany ofOptional

The target folder ID of the knowledge base

stringOptional

or

nullOptional

isOverwriteFolderAccessany ofOptional

The overwrite folder access flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

accessPermissionGroupsany ofOptional

The access permission groups of the knowledge base

Default: []

or

nullOptional

accessAgentsany ofOptional

The access agents of the knowledge base

Default: []

or

nullOptional

accessUserFiltersany ofOptional

The access user filters of the knowledge base

Default: []

or

nullOptional

viewAccessToAgentany ofOptional

The view access to agent flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

viewAccessToUserany ofOptional

The view access to user flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

filestring · binaryRequired

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/upload HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 382

{
  "fileName": "text",
  "hashtags": [
    "text"
  ],
  "targetFolderId": "text",
  "isOverwriteFolderAccess": false,
  "accessPermissionGroups": [
    {
      "permissionGroupId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessAgents": [
    {
      "agentId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessUserFilters": [
    {
      "variableName": "CUSTOMER_ID",
      "value": "text"
    }
  ],
  "viewAccessToAgent": false,
  "viewAccessToUser": false,
  "file": "binary"
}

200

OK

[
  {
    "result": {
      "id": "text",
      "name": "text",
      "createdAt": 1,
      "updatedAt": 1,
      "nodeType": "text",
      "parentFolder": {
        "id": "text",
        "name": "text"
      },
      "breadcrumbs": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  }
]

Upload From Aws S3

post

Upload Documents from S3

This API lets you transfer documents stored in S3 into Cognitive Search. They will appear as Knowledge Base documents in the dashboard. Available file formats are same in the section of Upload Documents.

Authorizations

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

Request model for uploading files from S3.

fileNamestringRequired

The file name of the knowledge base

hashtagsany ofOptional

The hashtags of the knowledge base

string[]Optional

or

nullOptional

targetFolderIdany ofOptional

The target folder ID of the knowledge base

stringOptional

or

nullOptional

isOverwriteFolderAccessany ofOptional

The overwrite folder access flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

accessPermissionGroupsany ofOptional

The access permission groups of the knowledge base

Default: []

or

nullOptional

accessAgentsany ofOptional

The access agents of the knowledge base

Default: []

or

nullOptional

accessUserFiltersany ofOptional

The access user filters of the knowledge base

Default: []

or

nullOptional

viewAccessToAgentany ofOptional

The view access to agent flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

viewAccessToUserany ofOptional

The view access to user flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

bucketObjectPathstringRequired

The bucket object path of the file

awsSecretKeyany ofOptional

Your S3 Secret Key.

stringOptional

or

nullOptional

awsAccessKeyany ofOptional

Your S3 Access Key.

stringOptional

or

nullOptional

awsIamRoleArnany ofOptional

AWS IAM Role ARN for access

stringOptional

or

nullOptional

awsExternalIdany ofOptional

External ID for AWS IAM Role

stringOptional

or

nullOptional

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/upload_from_aws_s3 HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 482

{
  "fileName": "text",
  "hashtags": [
    "text"
  ],
  "targetFolderId": "text",
  "isOverwriteFolderAccess": false,
  "accessPermissionGroups": [
    {
      "permissionGroupId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessAgents": [
    {
      "agentId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessUserFilters": [
    {
      "variableName": "CUSTOMER_ID",
      "value": "text"
    }
  ],
  "viewAccessToAgent": false,
  "viewAccessToUser": false,
  "bucketObjectPath": "text",
  "awsSecretKey": "text",
  "awsAccessKey": "text",
  "awsIamRoleArn": "text",
  "awsExternalId": "text"
}

200

OK

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Upload From Azure Blob

post

Upload Documents from Azure Blob Storage

This API lets you transfer documents stored in Azure Blob Storage into Cognitive Search. They will appear as Knowledge Base documents in the dashboard. Available file formats are same in the section of Upload Documents.

Authorizations

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

Request model for uploading files from Azure Blob Storage.

fileNamestringRequired

The file name of the knowledge base

hashtagsany ofOptional

The hashtags of the knowledge base

string[]Optional

or

nullOptional

targetFolderIdany ofOptional

The target folder ID of the knowledge base

stringOptional

or

nullOptional

isOverwriteFolderAccessany ofOptional

The overwrite folder access flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

accessPermissionGroupsany ofOptional

The access permission groups of the knowledge base

Default: []

or

nullOptional

accessAgentsany ofOptional

The access agents of the knowledge base

Default: []

or

nullOptional

accessUserFiltersany ofOptional

The access user filters of the knowledge base

Default: []

or

nullOptional

viewAccessToAgentany ofOptional

The view access to agent flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

viewAccessToUserany ofOptional

The view access to user flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

containerBlobPathstringRequired

The container blob path of the file

azureConnectionStringstringOptional

Your Azure Blob Storage connection string.

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/upload_from_azure_blob HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "fileName": "text",
  "hashtags": [
    "text"
  ],
  "targetFolderId": "text",
  "isOverwriteFolderAccess": false,
  "accessPermissionGroups": [
    {
      "permissionGroupId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessAgents": [
    {
      "agentId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessUserFilters": [
    {
      "variableName": "CUSTOMER_ID",
      "value": "text"
    }
  ],
  "viewAccessToAgent": false,
  "viewAccessToUser": false,
  "containerBlobPath": "text",
  "azureConnectionString": "text"
}

200

OK

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Knowledge Base Nodes

post

Authorizations

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

all ofOptionalDefault: {"filter_":null,"filter":null,"order":"updated_at_desc","limit":10,"after":null}

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/search HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 974

{
  "filter_": {
    "parentFolderIds": [
      "text"
    ],
    "searchTerm": "text",
    "hashtags": [
      "text"
    ],
    "hashtagsSearchOperator": "text",
    "combinedHashtags": [
      [
        "text"
      ]
    ],
    "combinedHashtagsOperator": "text",
    "excludingHashtags": [
      "text"
    ],
    "excludingHashtagsSearchOperator": "text",
    "processState": [
      "initializing"
    ],
    "status": [
      "on"
    ],
    "nodeType": [
      "file"
    ],
    "knowledgeBaseIds": [
      "text"
    ],
    "folderIds": [
      "text"
    ],
    "ownership": [
      "personal"
    ],
    "ancestorIds": [
      "text"
    ],
    "hasFaqCandidates": true,
    "sourceTypes": [
      "onedrive"
    ]
  },
  "filter": {
    "parentFolderIds": [
      "text"
    ],
    "searchTerm": "text",
    "hashtags": [
      "text"
    ],
    "hashtagsSearchOperator": "text",
    "combinedHashtags": [
      [
        "text"
      ]
    ],
    "combinedHashtagsOperator": "text",
    "excludingHashtags": [
      "text"
    ],
    "excludingHashtagsSearchOperator": "text",
    "processState": [
      "initializing"
    ],
    "status": [
      "on"
    ],
    "nodeType": [
      "file"
    ],
    "knowledgeBaseIds": [
      "text"
    ],
    "folderIds": [
      "text"
    ],
    "ownership": [
      "personal"
    ],
    "ancestorIds": [
      "text"
    ],
    "hasFaqCandidates": true,
    "sourceTypes": [
      "onedrive"
    ]
  },
  "order": "updated_at_desc",
  "limit": 10,
  "after": "text"
}

200

OK

{
  "result": {
    "nodes": [
      {
        "id": "text",
        "name": "text",
        "createdAt": 1,
        "updatedAt": 1,
        "nodeType": "text",
        "parentFolder": {
          "id": "text",
          "name": "text"
        },
        "breadcrumbs": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      }
    ],
    "cursor": "text"
  }
}

Content Search

post

Authorizations

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

searchTermstringRequired

limitintegerOptionalDefault: 10

afterany ofOptional

stringOptional

or

nullOptional

folderIdsany ofOptional

string[]Optional

or

nullOptional

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/content_search HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "searchTerm": "text",
  "limit": 10,
  "after": "text",
  "folderIds": [
    "text"
  ]
}

200

OK

{
  "result": {
    "nodes": [
      {
        "id": "text",
        "name": "text",
        "createdAt": 1,
        "updatedAt": 1,
        "nodeType": "text",
        "parentFolder": {
          "id": "text",
          "name": "text"
        },
        "breadcrumbs": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      }
    ],
    "cursor": "text"
  }
}

Knowledge Base Node

get

Authorizations

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Update Knowledge Base Node

put

Authorizations

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

titlestringRequired

hashtagsany ofOptional

The hashtags of the knowledge base node

string[]Optional

or

nullOptional

target_folder_idany ofOptional

The target folder ID of the knowledge base node

stringOptional

or

nullOptional

is_overwrite_folder_accessany ofOptional

The overwrite folder access flag of the knowledge base node

Default: false

booleanOptional

or

nullOptional

access_permission_groupsany ofOptional

The access permission groups of the knowledge base node

Default: []

or

nullOptional

access_agentsany ofOptional

The access agents of the knowledge base node

Default: []

or

nullOptional

access_user_filtersany ofOptional

The access user filters of the knowledge base node

Default: []

or

nullOptional

view_access_to_agentany ofOptional

The view access to agent flag of the knowledge base node

Default: false

booleanOptional

or

nullOptional

view_access_to_userany ofOptional

The view access to user flag of the knowledge base node

Default: false

booleanOptional

or

nullOptional

Responses

200

OK

application/json

put

HTTPcURLJavaScriptPython

PUT /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 379

{
  "title": "text",
  "hashtags": [
    "text"
  ],
  "target_folder_id": "text",
  "is_overwrite_folder_access": false,
  "access_permission_groups": [
    {
      "permissionGroupId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "access_agents": [
    {
      "agentId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "access_user_filters": [
    {
      "variableName": "CUSTOMER_ID",
      "value": "text"
    }
  ],
  "view_access_to_agent": false,
  "view_access_to_user": false
}

200

OK

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Delete Knowledge Base Nodes

delete

Authorizations

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

delete

HTTPcURLJavaScriptPython

DELETE /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

No content