Knowledge_base_nodes

Knowledge base node related APIs

지식베이스 노드 이동

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

알겠습니다.

application/json
post
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
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

지식베이스의 파일 이름

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
filestring · binaryRequired
Responses
200

알겠습니다.

application/json
post
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

알겠습니다.

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

AWS S3에서 업로드

post

S3에서 문서 업로드

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

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

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

알겠어

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

Azure Blob에서 업로드

post

Azure Blob Storage에서 문서 업로드

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

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

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
containerBlobPathstringRequired

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

azureConnectionStringstringOptional

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

Responses
200

확인

application/json
post
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

확인

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

지식베이스 노드

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

좋아요

application/json
post
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

좋아요

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

콘텐츠 검색

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

알겠습니다.

application/json
post
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

알겠습니다.

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

지식베이스 노드

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

알겠습니다.

application/json
get
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,
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

지식베이스 노드 업데이트

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

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

string[]Optional
or
nullOptional
target_folder_idany ofOptional

지식베이스 노드의 대상 폴더 ID

stringOptional
or
nullOptional
is_overwrite_folder_accessany ofOptional

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

Default: false
booleanOptional
or
nullOptional
access_permission_groupsany ofOptional

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

Default: []
or
nullOptional
access_agentsany ofOptional

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

Default: []
or
nullOptional
access_user_filtersany ofOptional

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

Default: []
or
nullOptional
view_access_to_agentany ofOptional

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

Default: false
booleanOptional
or
nullOptional
view_access_to_userany ofOptional

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

Default: false
booleanOptional
or
nullOptional
Responses
200

확인

application/json
put
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

확인

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

지식베이스 노드 삭제

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

알겠습니다

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

알겠습니다

No content
PreviousUsersNextKnowledge_bases

Was this helpful?