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

OK

application/json
post
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: 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"
        }
      ]
    }
  }
]

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

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

azureConnectionStringstringOptional

Azure Blob Storageの接続文字列。

Responses
200

了解しました。

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

OK

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

コンテンツ検索

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-ja.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-ja.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-ja.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-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
200

削除に成功しました

No content
PreviousUsersNextKnowledge_bases

Was this helpful?