Knowledge_base_nodes | Japanese

回答生成ノードを移動する

post

Authorizations

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

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

POST /webapi/v2/knowledge_base_nodes/move/bulk HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

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

useLayoutany ofOptional

ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。

Default: true

booleanOptional

or

nullOptional

useImageDescriptionany ofOptional

ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。

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

POST /webapi/v2/knowledge_base_nodes/upload HTTP/1.1
Host: backend-ja.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に保存されているドキュメントをAlliのドキュメントメニューに転送することができます。利用可能なファイル形式は、「ドキュメントのアップロード」セクションと同じです。

Authorizations

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

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

useLayoutany ofOptional

ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。

Default: true

booleanOptional

or

nullOptional

useImageDescriptionany ofOptional

ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。

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

POST /webapi/v2/knowledge_base_nodes/upload_from_aws_s3 HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

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

useLayoutany ofOptional

ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。

Default: true

booleanOptional

or

nullOptional

useImageDescriptionany ofOptional

ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。

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

ファイルのコンテナブロブパス

azureConnectionStringstringOptional

Azure Blob Storageの接続文字列。

Responses

200

了解しました。

application/json

post

/webapi/v2/knowledge_base_nodes/upload_from_azure_blob

POST /webapi/v2/knowledge_base_nodes/upload_from_azure_blob HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

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

Responses

200

成功

application/json

post

/webapi/v2/knowledge_base_nodes/search

POST /webapi/v2/knowledge_base_nodes/search HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

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

POST /webapi/v2/knowledge_base_nodes/content_search HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

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

POST /webapi/v2/knowledge_base_nodes/page_content_search HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

成功しました

application/json

get

/webapi/v2/knowledge_base_nodes/{node_id}

GET /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

titleany ofOptional

ナレッジベースノードのタイトル

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}

PUT /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

削除に成功しました

No content

delete

/webapi/v2/knowledge_base_nodes/{node_id}

DELETE /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Path parameters

node_idstringRequired

Query parameters

page_nointegerOptionalDefault: 1

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

OK

application/json

get

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

GET /webapi/v2/knowledge_base_nodes/{node_id}/preview HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Path parameters

node_idstringRequired

Query parameters

limitany ofOptional

integerOptional

or

nullOptional

offsetany ofOptional

integerOptional

or

nullOptional

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

OK

No content

get

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

GET /webapi/v2/knowledge_base_nodes/{node_id}/text HTTP/1.1
Host: backend-ja.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

API-KEYstringRequired

認証用のAPIキー

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

OK

No content

get

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

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

200

OK

No content