Knowledge_base_nodes

Knowledge base node related APIs

지식베이스 노드 이동

post

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

application/json

targetFolderIdany ofRequired

The target folder ID of the knowledge base node

stringOptional

or

nullOptional

nodeIdsstring[]Required

The node IDs of the knowledge base node

keepCurrentPermissionbooleanRequired

The keep current permission of the knowledge base node

Responses

200

알겠습니다.

application/json

post

/webapi/v2/knowledge_base_nodes/move/bulk

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

알겠습니다.

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

지식베이스 노드 업로드

post

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

multipart/form-data

fileNamestringRequired

지식베이스의 파일 이름

hashtagsany ofOptional

지식베이스의 해시태그

string[]Optional

or

nullOptional

targetFolderIdany ofOptional

지식베이스의 대상 폴더 ID

stringOptional

or

nullOptional

isOverwriteFolderAccessany ofOptional

지식베이스의 덮어쓰기 폴더 접근 플래그

Default: false

booleanOptional

or

nullOptional

accessPermissionGroupsany ofOptional

지식베이스의 접근 권한 그룹

Default: []

or

nullOptional

accessAgentsany ofOptional

지식베이스의 접근 에이전트

Default: []

or

nullOptional

accessUserFiltersany ofOptional

지식베이스의 접근 유저 필터

Default: []

or

nullOptional

viewAccessToAgentany ofOptional

지식베이스의 에이전트 플래그 보기 접근 권한

Default: false

booleanOptional

or

nullOptional

viewAccessToUserany ofOptional

지식베이스의 유저 플래그 보기 권한

Default: false

booleanOptional

or

nullOptional

useLayoutany ofOptional

Whether to use layout processing for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useImageDescriptionany ofOptional

Whether to use image description for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useOcrany ofOptional

Whether to use OCR for document processing

Default: false

booleanOptional

or

nullOptional

notificationHooksany ofOptional

List of notification hooks to trigger on document ingestion events

or

nullOptional

filestring · binaryRequired

Responses

200

알겠습니다.

application/json

post

/webapi/v2/knowledge_base_nodes/upload

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: 538

{
  "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,
  "useLayout": true,
  "useImageDescription": true,
  "useOcr": false,
  "properties": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "notificationHooks": [
    "email_on_ingestion_complete"
  ],
  "file": "binary"
}

200

알겠습니다.

[
  {
    "result": {
      "id": "text",
      "name": "text",
      "createdAt": 1,
      "createdBy": {
        "id": "text",
        "email": "text",
        "firstName": "text",
        "lastName": "text"
      },
      "updatedAt": 1,
      "nodeType": "text",
      "parentFolder": {
        "id": "text",
        "name": "text"
      },
      "breadcrumbs": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "agentPermission": {
        "accessAgents": [
          {
            "agentId": "text",
            "accessType": "order_1_editor"
          }
        ],
        "accessPermissionGroups": [
          {
            "permissionGroupId": "text",
            "permissionGroupName": "text",
            "accessType": "order_1_editor"
          }
        ],
        "viewAccessToAgent": true
      },
      "userPermission": {
        "ownUserIds": [
          "text"
        ],
        "customerGroups": [
          "text"
        ],
        "viewAccessToUser": true
      }
    }
  }
]

AWS S3에서 업로드

post

S3에서 문서 업로드

이 API를 사용하면 S3에 저장된 문서를 Cognitive Search로 전송할 수 있습니다. 대시보드에 지식베이스 문서로 나타납니다. 사용 가능한 파일 형식은 문서 업로드 섹션과 동일합니다.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

application/json

S3에서 파일 업로드 요청 모델.

fileNamestringRequired

지식베이스의 파일 이름

hashtagsany ofOptional

지식베이스의 해시태그

string[]Optional

or

nullOptional

targetFolderIdany ofOptional

지식베이스의 대상 폴더 ID

stringOptional

or

nullOptional

isOverwriteFolderAccessany ofOptional

지식베이스의 폴더 덮어쓰기 접근 플래그

Default: false

booleanOptional

or

nullOptional

accessPermissionGroupsany ofOptional

지식베이스의 접근 권한 그룹

Default: []

or

nullOptional

accessAgentsany ofOptional

지식베이스의 접근 에이전트

Default: []

or

nullOptional

accessUserFiltersany ofOptional

지식베이스의 접근 유저 필터

Default: []

or

nullOptional

viewAccessToAgentany ofOptional

지식베이스의 에이전트 플래그 보기 권한

Default: false

booleanOptional

or

nullOptional

viewAccessToUserany ofOptional

지식베이스의 유저 플래그에 대한 보기 액세스

Default: false

booleanOptional

or

nullOptional

useLayoutany ofOptional

Whether to use layout processing for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useImageDescriptionany ofOptional

Whether to use image description for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useOcrany ofOptional

Whether to use OCR for document processing

Default: false

booleanOptional

or

nullOptional

notificationHooksany ofOptional

List of notification hooks to trigger on document ingestion events

or

nullOptional

bucketObjectPathstringRequired

파일의 버킷 객체 경로

awsSecretKeyany ofOptional

귀하의 S3 비밀 키.

stringOptional

or

nullOptional

awsAccessKeyany ofOptional

귀하의 S3 액세스 키.

stringOptional

or

nullOptional

awsIamRoleArnany ofOptional

액세스를 위한 AWS IAM 역할 ARN

stringOptional

or

nullOptional

awsExternalIdany ofOptional

AWS IAM 역할의 외부 ID

stringOptional

or

nullOptional

Responses

200

알겠어

application/json

post

/webapi/v2/knowledge_base_nodes/upload_from_aws_s3

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: 638

{
  "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,
  "useLayout": true,
  "useImageDescription": true,
  "useOcr": false,
  "properties": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "notificationHooks": [
    "email_on_ingestion_complete"
  ],
  "bucketObjectPath": "text",
  "awsSecretKey": "text",
  "awsAccessKey": "text",
  "awsIamRoleArn": "text",
  "awsExternalId": "text"
}

200

알겠어

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "createdBy": {
      "id": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "agentPermission": {
      "accessAgents": [
        {
          "agentId": "text",
          "accessType": "order_1_editor"
        }
      ],
      "accessPermissionGroups": [
        {
          "permissionGroupId": "text",
          "permissionGroupName": "text",
          "accessType": "order_1_editor"
        }
      ],
      "viewAccessToAgent": true
    },
    "userPermission": {
      "ownUserIds": [
        "text"
      ],
      "customerGroups": [
        "text"
      ],
      "viewAccessToUser": true
    }
  }
}

Azure Blob에서 업로드

post

Azure Blob Storage에서 문서 업로드

이 API는 Azure Blob Storage에 저장된 문서를 Cognitive Search로 전송할 수 있습니다. 대시보드에 지식 베이스 문서로 표시됩니다. 사용 가능한 파일 형식은 문서 업로드 시 설명했던 내용과 동일합니다.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

application/json

Azure Blob Storage에서 파일 업로드를 위한 요청 모델.

fileNamestringRequired

지식베이스의 파일 이름

hashtagsany ofOptional

지식베이스의 해시태그

string[]Optional

or

nullOptional

targetFolderIdany ofOptional

지식베이스의 대상 폴더 ID

stringOptional

or

nullOptional

isOverwriteFolderAccessany ofOptional

지식베이스의 덮어쓰기 폴더 접근 플래그

Default: false

booleanOptional

or

nullOptional

accessPermissionGroupsany ofOptional

지식베이스의 접근 권한 그룹

Default: []

or

nullOptional

accessAgentsany ofOptional

지식베이스의 액세스 에이전트

Default: []

or

nullOptional

accessUserFiltersany ofOptional

지식베이스의 접근 유저 필터

Default: []

or

nullOptional

viewAccessToAgentany ofOptional

지식베이스의 에이전트 플래그 보기 권한

Default: false

booleanOptional

or

nullOptional

viewAccessToUserany ofOptional

지식베이스의 유저 플래그에 대한 보기 권한

Default: false

booleanOptional

or

nullOptional

useLayoutany ofOptional

Whether to use layout processing for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useImageDescriptionany ofOptional

Whether to use image description for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useOcrany ofOptional

Whether to use OCR for document processing

Default: false

booleanOptional

or

nullOptional

notificationHooksany ofOptional

List of notification hooks to trigger on document ingestion events

or

nullOptional

containerBlobPathstringRequired

파일이 위치한 Blob 컨테이너 경로

azureConnectionStringstringOptional

유저의 Azure Blob Storage용 연결 문자열.

Responses

200

확인

application/json

post

/webapi/v2/knowledge_base_nodes/upload_from_azure_blob

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: 580

{
  "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,
  "useLayout": true,
  "useImageDescription": true,
  "useOcr": false,
  "properties": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "notificationHooks": [
    "email_on_ingestion_complete"
  ],
  "containerBlobPath": "text",
  "azureConnectionString": "text"
}

200

확인

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "createdBy": {
      "id": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "agentPermission": {
      "accessAgents": [
        {
          "agentId": "text",
          "accessType": "order_1_editor"
        }
      ],
      "accessPermissionGroups": [
        {
          "permissionGroupId": "text",
          "permissionGroupName": "text",
          "accessType": "order_1_editor"
        }
      ],
      "viewAccessToAgent": true
    },
    "userPermission": {
      "ownUserIds": [
        "text"
      ],
      "customerGroups": [
        "text"
      ],
      "viewAccessToUser": true
    }
  }
}

지식베이스 노드

post

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

application/json

Responses

200

좋아요

application/json

post

/webapi/v2/knowledge_base_nodes/search

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: 985

{
  "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",
  "offset": 1
}

200

좋아요

{
  "result": {
    "nodes": [
      {
        "id": "text",
        "name": "text",
        "createdAt": 1,
        "createdBy": {
          "id": "text",
          "email": "text",
          "firstName": "text",
          "lastName": "text"
        },
        "updatedAt": 1,
        "nodeType": "text",
        "parentFolder": {
          "id": "text",
          "name": "text"
        },
        "breadcrumbs": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "agentPermission": {
          "accessAgents": [
            {
              "agentId": "text",
              "accessType": "order_1_editor"
            }
          ],
          "accessPermissionGroups": [
            {
              "permissionGroupId": "text",
              "permissionGroupName": "text",
              "accessType": "order_1_editor"
            }
          ],
          "viewAccessToAgent": true
        },
        "userPermission": {
          "ownUserIds": [
            "text"
          ],
          "customerGroups": [
            "text"
          ],
          "viewAccessToUser": true
        }
      }
    ],
    "cursor": "text",
    "totalFileCount": 1,
    "totalFolderCount": 1
  }
}

콘텐츠 검색

post

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

application/json

searchTermstringRequired

The search term of the knowledge base node

limitintegerOptional

The limit of the knowledge base node

Default: 10

afterany ofOptional

The after of the knowledge base node

stringOptional

or

nullOptional

folderIdsany ofOptional

The folder IDs of the knowledge base node

string[]Optional

or

nullOptional

searchScopeall ofOptional

The search scope of the knowledge base node

Default: both

string · enumOptionalPossible values:

Responses

200

알겠습니다.

application/json

post

/webapi/v2/knowledge_base_nodes/content_search

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: 89

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

200

알겠습니다.

{
  "result": {
    "nodes": [
      {
        "id": "text",
        "name": "text",
        "createdAt": 1,
        "createdBy": {
          "id": "text",
          "email": "text",
          "firstName": "text",
          "lastName": "text"
        },
        "updatedAt": 1,
        "nodeType": "text",
        "parentFolder": {
          "id": "text",
          "name": "text"
        },
        "breadcrumbs": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "agentPermission": {
          "accessAgents": [
            {
              "agentId": "text",
              "accessType": "order_1_editor"
            }
          ],
          "accessPermissionGroups": [
            {
              "permissionGroupId": "text",
              "permissionGroupName": "text",
              "accessType": "order_1_editor"
            }
          ],
          "viewAccessToAgent": true
        },
        "userPermission": {
          "ownUserIds": [
            "text"
          ],
          "customerGroups": [
            "text"
          ],
          "viewAccessToUser": true
        }
      }
    ],
    "cursor": "text",
    "totalFileCount": 1,
    "totalFolderCount": 1
  }
}

Page Content Search

post

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

application/json

searchTermsstring[]Required

The search terms for page content search

folderIdsany ofOptional

The folder IDs to search within

string[]Optional

or

nullOptional

knowledgeBaseIdsany ofOptional

The knowledge base IDs to search within

string[]Optional

or

nullOptional

hashtagsany ofOptional

The hashtags to filter by

string[]Optional

or

nullOptional

hashtagsOperatorstringOptional

The hashtags operator (AND/OR)

Default: OR

excludeHashtagsany ofOptional

The hashtags to exclude

string[]Optional

or

nullOptional

excludeHashtagsOperatorstringOptional

The exclude hashtags operator (AND/OR)

Default: OR

topNintegerOptional

The number of top results to return

Default: 1

mergeSamePagebooleanOptional

Whether to merge content from the same page

Default: false

Responses

200

OK

application/json

post

/webapi/v2/knowledge_base_nodes/page_content_search

HTTPcURLJavaScriptPython

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

{
  "searchTerms": [
    "text"
  ],
  "folderIds": [
    "text"
  ],
  "knowledgeBaseIds": [
    "text"
  ],
  "hashtags": [
    "text"
  ],
  "hashtagsOperator": "OR",
  "excludeHashtags": [
    "text"
  ],
  "excludeHashtagsOperator": "OR",
  "topN": 1,
  "mergeSamePage": false
}

200

OK

{
  "results": [
    {
      "kbId": "text",
      "title": "text",
      "text": "text",
      "pageNo": 1
    }
  ]
}

지식베이스 노드

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

알겠습니다.

application/json

get

/webapi/v2/knowledge_base_nodes/{node_id}

HTTPcURLJavaScriptPython

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

200

알겠습니다.

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "createdBy": {
      "id": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "agentPermission": {
      "accessAgents": [
        {
          "agentId": "text",
          "accessType": "order_1_editor"
        }
      ],
      "accessPermissionGroups": [
        {
          "permissionGroupId": "text",
          "permissionGroupName": "text",
          "accessType": "order_1_editor"
        }
      ],
      "viewAccessToAgent": true
    },
    "userPermission": {
      "ownUserIds": [
        "text"
      ],
      "customerGroups": [
        "text"
      ],
      "viewAccessToUser": true
    }
  }
}

지식베이스 노드 업데이트

put

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

application/json

titleany ofOptional

The title of the knowledge base node

stringOptional

or

nullOptional

hashtagsany ofOptional

지식베이스 노드의 해시태그

string[]Optional

or

nullOptional

is_overwrite_folder_accessany ofOptional

지식베이스 노드의 덮어쓰기 폴더 액세스 플래그

booleanOptional

or

nullOptional

access_permission_groupsany ofOptional

지식베이스 노드의 접근 권한 그룹

or

nullOptional

access_agentsany ofOptional

지식베이스 노드의 접근 에이전트

or

nullOptional

access_user_filtersany ofOptional

지식베이스 노드의 접근 유저 필터

or

nullOptional

view_access_to_agentany ofOptional

지식베이스 노드의 에이전트 플래그에 대한 보기 접근 권한

booleanOptional

or

nullOptional

view_access_to_userany ofOptional

지식베이스 노드의 유저 플래그에 대한 보기 액세스

booleanOptional

or

nullOptional

Responses

200

확인

application/json

put

/webapi/v2/knowledge_base_nodes/{node_id}

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: 395

{
  "title": "text",
  "hashtags": [
    "text"
  ],
  "is_overwrite_folder_access": true,
  "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": true,
  "view_access_to_user": true,
  "properties": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

200

확인

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "createdBy": {
      "id": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "agentPermission": {
      "accessAgents": [
        {
          "agentId": "text",
          "accessType": "order_1_editor"
        }
      ],
      "accessPermissionGroups": [
        {
          "permissionGroupId": "text",
          "permissionGroupName": "text",
          "accessType": "order_1_editor"
        }
      ],
      "viewAccessToAgent": true
    },
    "userPermission": {
      "ownUserIds": [
        "text"
      ],
      "customerGroups": [
        "text"
      ],
      "viewAccessToUser": true
    }
  }
}

지식베이스 노드 삭제

delete

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

알겠습니다

No content

delete

/webapi/v2/knowledge_base_nodes/{node_id}

HTTPcURLJavaScriptPython

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

200

알겠습니다

No content

Knowledge Base Node Preview

get

Get preview of a knowledge base node with HTML and PDF information.

Args: request: HTTP request object node_id: Global ID of the knowledge base node page_no: Page number to preview (default: 1)

Returns: KnowledgeBasePreviewResponse containing HTML and PDF preview data

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

node_idstringRequired

Query parameters

page_nointegerOptionalDefault: 1

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

/webapi/v2/knowledge_base_nodes/{node_id}/preview

HTTPcURLJavaScriptPython

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

200

OK

{
  "html": "text",
  "pdfUrl": "text",
  "imageUrl": "text",
  "previewUrl": "text",
  "totalPreviewCount": 0
}

Knowledge Base Node Text

get

Get text content of a knowledge base node from parsed pages.

Args: request: HTTP request object node_id: Global ID of the knowledge base node limit: Optional maximum number of pages to return offset: Optional number of pages to skip from the beginning

Returns: HttpResponse containing plain text content from KnowledgeBaseParsedPage

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

node_idstringRequired

Query parameters

limitany ofOptional

integerOptional

or

nullOptional

offsetany ofOptional

integerOptional

or

nullOptional

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

No content

get

/webapi/v2/knowledge_base_nodes/{node_id}/text

HTTPcURLJavaScriptPython

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

200

OK

No content

Knowledge Base Node Download

get

Download original file of a knowledge base node.

Args: request: HTTP request object node_id: Global ID of the knowledge base node

Returns: FileResponse containing the original file for download

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

No content

get

/webapi/v2/knowledge_base_nodes/{node_id}/download

HTTPcURLJavaScriptPython

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

200

OK

No content