# Models

## The AgentResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AgentResponse":{"properties":{"id":{"title":"Id","type":"string"},"lastName":{"title":"Lastname","type":"string"},"firstName":{"title":"Firstname","type":"string"},"email":{"title":"Email","type":"string"}},"required":["id","lastName","firstName","email"],"title":"AgentResponse","type":"object"}}}}
```

## The AgentsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AgentsResponse":{"properties":{"agents":{"items":{"$ref":"#/components/schemas/AgentResponse"},"title":"Agents","type":"array"}},"required":["agents"],"title":"AgentsResponse","type":"object"},"AgentResponse":{"properties":{"id":{"title":"Id","type":"string"},"lastName":{"title":"Lastname","type":"string"},"firstName":{"title":"Firstname","type":"string"},"email":{"title":"Email","type":"string"}},"required":["id","lastName","firstName","email"],"title":"AgentResponse","type":"object"}}}}
```

## The AuditLogParamEnum object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AuditLogParamEnum":{"description":"Audit log のパラメータenum。","enum":["variables","query","body"],"title":"AuditLogParamEnum","type":"string"}}}}
```

## The AuditLogSearch object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AuditLogSearch":{"description":"Audit log 検索のフィルターパラメーター","properties":{"createdAt":{"description":"timestamp (UTC)","format":"date-time","title":"Createdat","type":"string"},"beforeRange":{"default":31,"description":"created_at より前の日数（最大 31 日）","maximum":31,"minimum":1,"title":"Beforerange","type":"integer"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"メンバーのemailアドレスでのフィルター","title":"Email"},"apiRequestType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"APIリクエストのタイプ (rest/graphql)","title":"Apirequesttype"},"params":{"description":"追加のパラメーター","items":{"description":"Audit log のパラメータenum。","enum":["variables","query","body"],"title":"AuditLogParamEnum","type":"string"},"title":"Params","type":"array"},"offset":{"default":0,"description":"ページネーションのオフセット。","title":"Offset","type":"integer"},"limit":{"default":10,"description":"ページネーションのlimit。","maximum":1000,"minimum":1,"title":"Limit","type":"integer"}},"title":"AuditLogSearch","type":"object"}}}}
```

## The AgentInfo object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AgentInfo":{"description":"Audit logのメンバー情報。","properties":{"id":{"description":"メンバーのID","title":"Id","type":"string"},"email":{"description":"メンバーのemailアドレス","title":"Email","type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"メンバーのfirst name","title":"Firstname"},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"メンバーのlast name","title":"Lastname"}},"required":["id","email","firstName","lastName"],"title":"AgentInfo","type":"object"}}}}
```

## The AuditLog object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AuditLog":{"description":"Audit logの入力モデル","properties":{"id":{"description":"Log ID","title":"Id","type":"string"},"createdAt":{"description":"timestamp (UTC)の作成日。","format":"date-time","title":"Createdat","type":"string"},"agent":{"anyOf":[{"$ref":"#/components/schemas/AgentInfo"},{"type":"null"}],"description":"メンバーの情報。"},"ip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"接続元のIPアドレス。","title":"Ip"},"operation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"GraphQLの操作。","title":"Operation"},"mutation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"GraphQLのmutation。","title":"Mutation"},"method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HTTPメソッド","title":"Method"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HTTPパス","title":"Path"},"variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"変数","title":"Variables"},"query":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"クエリパラメータ","title":"Query"},"body":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"リクエストボディ","title":"Body"}},"required":["id","createdAt","agent","ip","operation","mutation","method","path","variables","query","body"],"title":"AuditLog","type":"object"},"AgentInfo":{"description":"Audit logのメンバー情報。","properties":{"id":{"description":"メンバーのID","title":"Id","type":"string"},"email":{"description":"メンバーのemailアドレス","title":"Email","type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"メンバーのfirst name","title":"Firstname"},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"メンバーのlast name","title":"Lastname"}},"required":["id","email","firstName","lastName"],"title":"AgentInfo","type":"object"}}}}
```

## The AuditLogListResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AuditLogListResponse":{"description":"Audit logのリスト応答。","properties":{"result":{"description":"Audit logsのリスト。","items":{"$ref":"#/components/schemas/AuditLog"},"title":"Result","type":"array"},"count":{"description":"総数","title":"Count","type":"integer"}},"required":["result","count"],"title":"AuditLogListResponse","type":"object"},"AuditLog":{"description":"Audit logの入力モデル","properties":{"id":{"description":"Log ID","title":"Id","type":"string"},"createdAt":{"description":"timestamp (UTC)の作成日。","format":"date-time","title":"Createdat","type":"string"},"agent":{"anyOf":[{"$ref":"#/components/schemas/AgentInfo"},{"type":"null"}],"description":"メンバーの情報。"},"ip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"接続元のIPアドレス。","title":"Ip"},"operation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"GraphQLの操作。","title":"Operation"},"mutation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"GraphQLのmutation。","title":"Mutation"},"method":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HTTPメソッド","title":"Method"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HTTPパス","title":"Path"},"variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"変数","title":"Variables"},"query":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"クエリパラメータ","title":"Query"},"body":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"リクエストボディ","title":"Body"}},"required":["id","createdAt","agent","ip","operation","mutation","method","path","variables","query","body"],"title":"AuditLog","type":"object"},"AgentInfo":{"description":"Audit logのメンバー情報。","properties":{"id":{"description":"メンバーのID","title":"Id","type":"string"},"email":{"description":"メンバーのemailアドレス","title":"Email","type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"メンバーのfirst name","title":"Firstname"},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"メンバーのlast name","title":"Lastname"}},"required":["id","email","firstName","lastName"],"title":"AgentInfo","type":"object"}}}}
```

## The AuditLogFilter object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AuditLogFilter":{"description":"Audit log 検索のフィルターパラメーター","properties":{"createdAt":{"description":"timestamp (UTC)","format":"date-time","title":"Createdat","type":"string"},"beforeRange":{"default":31,"description":"created_at より前の日数（最大 31 日）","maximum":31,"minimum":1,"title":"Beforerange","type":"integer"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"メンバーのemailアドレスでのフィルター","title":"Email"},"apiRequestType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"APIリクエストのタイプ (rest/graphql)","title":"Apirequesttype"},"params":{"description":"追加のパラメーター","items":{"description":"Audit logのパラメータenum","enum":["variables","query","body"],"title":"AuditLogParamEnum","type":"string"},"title":"Params","type":"array"}},"title":"AuditLogFilter","type":"object"}}}}
```

## The BulkUserResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkUserResponse":{"properties":{"result":{"items":{"$ref":"#/components/schemas/BulkUserResultBody"},"title":"Result","type":"array"}},"title":"BulkUserResponse","type":"object"},"BulkUserResultBody":{"properties":{"ownUserId":{"description":"ユーザーID","title":"Ownuserid","type":"string"},"status":{"$ref":"#/components/schemas/BulkUserResultStatus","description":"ステータス"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"メッセージ","title":"Message"}},"required":["ownUserId","status"],"title":"BulkUserResultBody","type":"object"},"BulkUserResultStatus":{"enum":["success","error"],"title":"BulkUserResultStatus","type":"string"}}}}
```

## The BulkUserResultBody object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkUserResultBody":{"properties":{"ownUserId":{"description":"ユーザーID","title":"Ownuserid","type":"string"},"status":{"$ref":"#/components/schemas/BulkUserResultStatus","description":"ステータス"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"メッセージ","title":"Message"}},"required":["ownUserId","status"],"title":"BulkUserResultBody","type":"object"},"BulkUserResultStatus":{"enum":["success","error"],"title":"BulkUserResultStatus","type":"string"}}}}
```

## The BulkUserResultStatus object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkUserResultStatus":{"enum":["success","error"],"title":"BulkUserResultStatus","type":"string"}}}}
```

## The BulkUserActionType object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkUserActionType":{"enum":["create","update","delete"],"title":"BulkUserActionType","type":"string"}}}}
```

## The BulkUserBody object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkUserBody":{"properties":{"ownUserId":{"description":"ユーザーのユニークID","title":"Ownuserid","type":"string"},"data":{"anyOf":[{"items":{"$ref":"#/components/schemas/BulkUserData"},"type":"array"},{"type":"null"}],"description":"ユーザーデータのキーと値のペア。","title":"Data"}},"required":["ownUserId"],"title":"BulkUserBody","type":"object"},"BulkUserData":{"properties":{"key":{"description":"フィールド名","title":"Key","type":"string"},"value":{"description":"フィールド値","title":"Value","type":"string"}},"required":["key","value"],"title":"BulkUserData","type":"object"}}}}
```

## The BulkUserData object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkUserData":{"properties":{"key":{"description":"フィールド名","title":"Key","type":"string"},"value":{"description":"フィールド値","title":"Value","type":"string"}},"required":["key","value"],"title":"BulkUserData","type":"object"}}}}
```

## The BulkUserRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkUserRequest":{"properties":{"action":{"$ref":"#/components/schemas/BulkUserActionType"},"users":{"items":{"$ref":"#/components/schemas/BulkUserBody"},"title":"Users","type":"array"}},"required":["action"],"title":"BulkUserRequest","type":"object"},"BulkUserActionType":{"enum":["create","update","delete"],"title":"BulkUserActionType","type":"string"},"BulkUserBody":{"properties":{"ownUserId":{"description":"ユーザーのユニークID","title":"Ownuserid","type":"string"},"data":{"anyOf":[{"items":{"$ref":"#/components/schemas/BulkUserData"},"type":"array"},{"type":"null"}],"description":"ユーザーデータのキーと値のペア。","title":"Data"}},"required":["ownUserId"],"title":"BulkUserBody","type":"object"},"BulkUserData":{"properties":{"key":{"description":"フィールド名","title":"Key","type":"string"},"value":{"description":"フィールド値","title":"Value","type":"string"}},"required":["key","value"],"title":"BulkUserData","type":"object"}}}}
```

## The GetUserResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"GetUserResponse":{"properties":{"result":{"$ref":"#/components/schemas/User","description":"結果"}},"required":["result"],"title":"GetUserResponse","type":"object"},"User":{"properties":{"userId":{"description":"ユーザーID","title":"Userid","type":"string"},"firstName":{"description":"ユーザーの名","title":"Firstname","type":"string"},"lastName":{"description":"ユーザーの姓","title":"Lastname","type":"string"}},"required":["userId","firstName","lastName"],"title":"User","type":"object"}}}}
```

## The User object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"User":{"properties":{"userId":{"description":"ユーザーID","title":"Userid","type":"string"},"firstName":{"description":"ユーザーの名","title":"Firstname","type":"string"},"lastName":{"description":"ユーザーの姓","title":"Lastname","type":"string"}},"required":["userId","firstName","lastName"],"title":"User","type":"object"}}}}
```

## The UserCustomerGroup object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UserCustomerGroup":{"properties":{"id":{"description":"顧客グループID","title":"Id","type":"string"},"value":{"description":"顧客グループ名","title":"Value","type":"string"}},"required":["id","value"],"title":"UserCustomerGroup","type":"object"}}}}
```

## The BulkMemberResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkMemberResponse":{"description":"Response for bulk member operations.","properties":{"result":{"items":{"$ref":"#/components/schemas/BulkTaskResult"},"title":"Result","type":"array"}},"title":"BulkMemberResponse","type":"object"},"BulkTaskResult":{"description":"Result of a bulk task operation.","properties":{"emails":{"items":{"type":"string"},"title":"Emails","type":"array"},"status":{"title":"Status","type":"string"},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Errormessage"}},"required":["emails","status"],"title":"BulkTaskResult","type":"object"}}}}
```

## The BulkTaskResult object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkTaskResult":{"description":"Result of a bulk task operation.","properties":{"emails":{"items":{"type":"string"},"title":"Emails","type":"array"},"status":{"title":"Status","type":"string"},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Errormessage"}},"required":["emails","status"],"title":"BulkTaskResult","type":"object"}}}}
```

## The BulkMemberInviteRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkMemberInviteRequest":{"description":"Request for bulk inviting members.","properties":{"members":{"items":{"$ref":"#/components/schemas/MemberMetadata"},"title":"Members","type":"array"}},"title":"BulkMemberInviteRequest","type":"object"},"MemberMetadata":{"description":"Metadata for inviting or managing project members.","properties":{"email":{"title":"Email","type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname"},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastname"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale"},"groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Groups"},"attributes":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Attributes"}},"required":["email"],"title":"MemberMetadata","type":"object"}}}}
```

## The MemberMetadata object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"MemberMetadata":{"description":"Metadata for inviting or managing project members.","properties":{"email":{"title":"Email","type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname"},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastname"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale"},"groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Groups"},"attributes":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Attributes"}},"required":["email"],"title":"MemberMetadata","type":"object"}}}}
```

## The BulkMemberUpdatePermissionRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkMemberUpdatePermissionRequest":{"description":"Request for bulk updating member permission groups.","properties":{"members":{"items":{"$ref":"#/components/schemas/MemberMetadata"},"title":"Members","type":"array"}},"title":"BulkMemberUpdatePermissionRequest","type":"object"},"MemberMetadata":{"description":"Metadata for inviting or managing project members.","properties":{"email":{"title":"Email","type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname"},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastname"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale"},"groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Groups"},"attributes":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Attributes"}},"required":["email"],"title":"MemberMetadata","type":"object"}}}}
```

## The BulkMemberRemoveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BulkMemberRemoveRequest":{"description":"Request for bulk removing members.","properties":{"members":{"items":{"$ref":"#/components/schemas/MemberMetadata"},"title":"Members","type":"array"}},"title":"BulkMemberRemoveRequest","type":"object"},"MemberMetadata":{"description":"Metadata for inviting or managing project members.","properties":{"email":{"title":"Email","type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname"},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastname"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale"},"groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Groups"},"attributes":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Attributes"}},"required":["email"],"title":"MemberMetadata","type":"object"}}}}
```

## The PermissionGroupResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"PermissionGroupResponse":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"isAdmin":{"title":"Isadmin","type":"boolean"},"isDefault":{"title":"Isdefault","type":"boolean"},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order"},"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array"},"agentCount":{"title":"Agentcount","type":"integer"}},"required":["id","name","isAdmin","isDefault","order","permissions","agentCount"],"title":"PermissionGroupResponse","type":"object"}}}}
```

## The PermissionGroupsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"PermissionGroupsResponse":{"properties":{"permissionGroups":{"items":{"$ref":"#/components/schemas/PermissionGroupResponse"},"title":"Permissiongroups","type":"array"}},"required":["permissionGroups"],"title":"PermissionGroupsResponse","type":"object"},"PermissionGroupResponse":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"isAdmin":{"title":"Isadmin","type":"boolean"},"isDefault":{"title":"Isdefault","type":"boolean"},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order"},"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array"},"agentCount":{"title":"Agentcount","type":"integer"}},"required":["id","name","isAdmin","isDefault","order","permissions","agentCount"],"title":"PermissionGroupResponse","type":"object"}}}}
```

## The PermissionGroupDetailResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"PermissionGroupDetailResponse":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"isAdmin":{"title":"Isadmin","type":"boolean"},"isDefault":{"title":"Isdefault","type":"boolean"},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order"},"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array"},"agents":{"items":{"$ref":"#/components/schemas/AgentResponse"},"title":"Agents","type":"array"}},"required":["id","name","isAdmin","isDefault","order","permissions","agents"],"title":"PermissionGroupDetailResponse","type":"object"},"AgentResponse":{"properties":{"id":{"title":"Id","type":"string"},"lastName":{"title":"Lastname","type":"string"},"firstName":{"title":"Firstname","type":"string"},"email":{"title":"Email","type":"string"}},"required":["id","lastName","firstName","email"],"title":"AgentResponse","type":"object"}}}}
```

## The UpdatePermissionGroupNameRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UpdatePermissionGroupNameRequest":{"properties":{"name":{"title":"Name","type":"string"}},"required":["name"],"title":"UpdatePermissionGroupNameRequest","type":"object"}}}}
```

## The AgentPermissionEnum object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AgentPermissionEnum":{"enum":["dashboard_accessible","skill_read","skill_write","skill_popup_url_generation","llm_app_read","llm_app_create","user_page_access","user_editable","user_download","conversations_read","agent_assignable","conversation_state_write","delete_chat_message","delete_agent_chat_message","consversation_download","smalltalk_read","smalltalk_editable","document_page_access","knowledge_base_editable","knowledge_base_add_folder_write","knowledge_base_page_access","faq_editable","faq_train_write","faq_setting_read","faq_setting_write","faq_add_folder_write","feedback_management_read","clue_feedback_write","answer_feedback_write","query_history_redactable","knowledge_base_history_read","faq_history_read","query_training_read","query_training_write","faq_auto_tagging_read","faq_auto_tagging_write","doc_source_read","doc_source_write","knowledge_base_setting_read","knowledge_base_setting_write","knowledge_base_train_write","entity_extraction_read","entity_extraction_editable","entity_extraction_download","training_schedule_write","google_domain_allowlist_read","google_domain_allowlist_write","analytics_page_access","redact_keyword_write","analytics_download","project_setting_page_access","project_setting_read","project_setting_write","project_setting_general_write","project_setting_api_key_write","office_hours_editable","faq_custom_columns_write","dashboard_whitelist_write","sdk_whitelist_write","api_whitelist_write","files_whitelist_write","account_policy_write","oidc_clients_write","conversations_write","billing","integrations_read","integrations_write","dashboard_order_write","advanced_setting_read","manage_agent_read","manage_agent_write","agent_invitable","agent_action_log_download_read","approver_group_write","ai_workflow_read","ai_workflow_write","prompt_management_read","project_scope_prompt_read","project_scope_prompt_write"],"title":"AgentPermissionEnum","type":"string"}}}}
```

## The UpdatePermissionGroupPermissionsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UpdatePermissionGroupPermissionsRequest":{"properties":{"permissions":{"items":{"$ref":"#/components/schemas/AgentPermissionEnum"},"title":"Permissions","type":"array"}},"required":["permissions"],"title":"UpdatePermissionGroupPermissionsRequest","type":"object"},"AgentPermissionEnum":{"enum":["dashboard_accessible","skill_read","skill_write","skill_popup_url_generation","llm_app_read","llm_app_create","user_page_access","user_editable","user_download","conversations_read","agent_assignable","conversation_state_write","delete_chat_message","delete_agent_chat_message","consversation_download","smalltalk_read","smalltalk_editable","document_page_access","knowledge_base_editable","knowledge_base_add_folder_write","knowledge_base_page_access","faq_editable","faq_train_write","faq_setting_read","faq_setting_write","faq_add_folder_write","feedback_management_read","clue_feedback_write","answer_feedback_write","query_history_redactable","knowledge_base_history_read","faq_history_read","query_training_read","query_training_write","faq_auto_tagging_read","faq_auto_tagging_write","doc_source_read","doc_source_write","knowledge_base_setting_read","knowledge_base_setting_write","knowledge_base_train_write","entity_extraction_read","entity_extraction_editable","entity_extraction_download","training_schedule_write","google_domain_allowlist_read","google_domain_allowlist_write","analytics_page_access","redact_keyword_write","analytics_download","project_setting_page_access","project_setting_read","project_setting_write","project_setting_general_write","project_setting_api_key_write","office_hours_editable","faq_custom_columns_write","dashboard_whitelist_write","sdk_whitelist_write","api_whitelist_write","files_whitelist_write","account_policy_write","oidc_clients_write","conversations_write","billing","integrations_read","integrations_write","dashboard_order_write","advanced_setting_read","manage_agent_read","manage_agent_write","agent_invitable","agent_action_log_download_read","approver_group_write","ai_workflow_read","ai_workflow_write","prompt_management_read","project_scope_prompt_read","project_scope_prompt_write"],"title":"AgentPermissionEnum","type":"string"}}}}
```

## The MoveKnowledgeBaseNodesResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"MoveKnowledgeBaseNodesResponse":{"properties":{"moved_kb_node_ids":{"description":"Moved knowledge base node IDs","items":{"type":"string"},"title":"Moved Kb Node Ids","type":"array"},"failed_kb_node_ids":{"description":"Failed knowledge base node IDs","items":{"type":"string"},"title":"Failed Kb Node Ids","type":"array"}},"required":["moved_kb_node_ids","failed_kb_node_ids"],"title":"MoveKnowledgeBaseNodesResponse","type":"object"}}}}
```

## The MoveKnowledgeBaseNodesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"MoveKnowledgeBaseNodesRequest":{"properties":{"targetFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The target folder ID of the knowledge base node","title":"Targetfolderid"},"nodeIds":{"description":"The node IDs of the knowledge base node","items":{"type":"string"},"title":"Nodeids","type":"array"},"keepCurrentPermission":{"description":"The keep current permission of the knowledge base node","title":"Keepcurrentpermission","type":"boolean"}},"required":["targetFolderId","nodeIds","keepCurrentPermission"],"title":"MoveKnowledgeBaseNodesRequest","type":"object"}}}}
```

## The AccessAgent object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"}}}}
```

## The AccessPermissionGroupResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"}}}}
```

## The AgentPermissionResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"}}}}
```

## The CreatedByAgent object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"}}}}
```

## The Folder object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"}}}}
```

## The KnowledgeBaseFileProperty object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseFileProperty":{"properties":{"key":{"title":"Key","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"}}}}
```

## The KnowledgeBaseNodeFile object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"title":"Key","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"}}}}
```

## The KnowledgeBaseNodeFolder object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"}}}}
```

## The KnowledgeBaseNodeResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodeResponse":{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}],"description":"Knowledge base node","title":"Result"}},"required":["result"],"title":"KnowledgeBaseNodeResponse","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"title":"Key","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"}}}}
```

## The ObjectAccessType object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"}}}}
```

## The UserPermissionResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"}}}}
```

## The AccessPermissionGroup object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"}}}}
```

## The AccessUserFilter object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AccessUserFilter":{"properties":{"variableName":{"$ref":"#/components/schemas/AccessUserFilterEnum","description":"フィルターの変数名"},"value":{"description":"フィルターの値","title":"Value","type":"string"}},"required":["variableName","value"],"title":"AccessUserFilter","type":"object"},"AccessUserFilterEnum":{"description":"システム変数以外の変数を追加する場合は、再設計が必要です。","enum":["CUSTOMER_ID","CUSTOMER_GROUP"],"title":"AccessUserFilterEnum","type":"string"}}}}
```

## The AccessUserFilterEnum object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AccessUserFilterEnum":{"description":"システム変数以外の変数を追加する場合は、再設計が必要です。","enum":["CUSTOMER_ID","CUSTOMER_GROUP"],"title":"AccessUserFilterEnum","type":"string"}}}}
```

## The KnowledgeBaseNotificationHookEnum object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNotificationHookEnum":{"description":"Notification hooks that can be triggered on document ingestion events.","enum":["email_on_ingestion_complete"],"title":"KnowledgeBaseNotificationHookEnum","type":"string"}}}}
```

## The UploadKnowledgeBaseFileRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UploadKnowledgeBaseFileRequest":{"properties":{"fileName":{"description":"ファイル名","title":"Filename","type":"string"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"ハッシュタグ","title":"Hashtags"},"targetFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ターゲットフォルダーID","title":"Targetfolderid"},"isOverwriteFolderAccess":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"フォルダのアクセス権限の上書きフラグ","title":"Isoverwritefolderaccess"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"description":"アクセス許可グループ","title":"Accesspermissiongroups"},"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"アクセス許可管理者","title":"Accessagents"},"accessUserFilters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessUserFilter"},"type":"array"},{"type":"null"}],"description":"アクセスユーザー","title":"Accessuserfilters"},"viewAccessToAgent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"管理者の閲覧権限フラグ","title":"Viewaccesstoagent"},"viewAccessToUser":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"ユーザーの閲覧権限フラグ","title":"Viewaccesstouser"},"useLayout":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Uselayout"},"useImageDescription":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Useimagedescription"},"useOcr":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"Whether to use OCR for document processing","title":"Useocr"},"properties":{"type":"array","items":{"properties":{"key":{"title":"Key","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"description":"ナレッジベースノードに付与するメタ情報","title":"Properties"},"notificationHooks":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNotificationHookEnum"},"type":"array"},{"type":"null"}],"description":"List of notification hooks to trigger on document ingestion events","title":"Notificationhooks"}},"required":["fileName"],"title":"UploadKnowledgeBaseFileRequest","type":"object"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"AccessUserFilter":{"properties":{"variableName":{"$ref":"#/components/schemas/AccessUserFilterEnum","description":"フィルターの変数名"},"value":{"description":"フィルターの値","title":"Value","type":"string"}},"required":["variableName","value"],"title":"AccessUserFilter","type":"object"},"AccessUserFilterEnum":{"description":"システム変数以外の変数を追加する場合は、再設計が必要です。","enum":["CUSTOMER_ID","CUSTOMER_GROUP"],"title":"AccessUserFilterEnum","type":"string"},"KnowledgeBaseNotificationHookEnum":{"description":"Notification hooks that can be triggered on document ingestion events.","enum":["email_on_ingestion_complete"],"title":"KnowledgeBaseNotificationHookEnum","type":"string"}}}}
```

## The UploadFromAWSS3Request object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UploadFromAWSS3Request":{"description":"S3からファイルをアップロードするためのリクエストモデル。","properties":{"fileName":{"description":"ファイル名","title":"Filename","type":"string"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"ハッシュタグ","title":"Hashtags"},"targetFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ターゲットフォルダーID","title":"Targetfolderid"},"isOverwriteFolderAccess":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"フォルダーのアクセス権限上書きフラグ","title":"Isoverwritefolderaccess"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"description":"アクセス許可グループ","title":"Accesspermissiongroups"},"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"アクセス管理者","title":"Accessagents"},"accessUserFilters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessUserFilter"},"type":"array"},{"type":"null"}],"description":"アクセスユーザーフィルター","title":"Accessuserfilters"},"viewAccessToAgent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"管理者閲覧権限フラグ","title":"Viewaccesstoagent"},"viewAccessToUser":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"ユーザーの閲覧権限フラグ","title":"Viewaccesstouser"},"useLayout":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Uselayout"},"useImageDescription":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Useimagedescription"},"useOcr":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"Whether to use OCR for document processing","title":"Useocr"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"description":"ナレッジベースノードに付与するメタ情報","title":"Properties"},"notificationHooks":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNotificationHookEnum"},"type":"array"},{"type":"null"}],"description":"List of notification hooks to trigger on document ingestion events","title":"Notificationhooks"},"bucketObjectPath":{"description":"ファイルのバケットオブジェクトパス","title":"Bucketobjectpath","type":"string"},"awsSecretKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"S3シークレットキー。","title":"Awssecretkey"},"awsAccessKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"S3アクセスキー。","title":"Awsaccesskey"},"awsIamRoleArn":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"AWS IAM Role ARN","title":"Awsiamrolearn"},"awsExternalId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"AWS IAMロールの外部ID","title":"Awsexternalid"}},"required":["fileName","bucketObjectPath"],"title":"UploadFromAWSS3Request","type":"object"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"AccessUserFilter":{"properties":{"variableName":{"$ref":"#/components/schemas/AccessUserFilterEnum","description":"フィルターの変数名"},"value":{"description":"フィルターの値","title":"Value","type":"string"}},"required":["variableName","value"],"title":"AccessUserFilter","type":"object"},"AccessUserFilterEnum":{"description":"システム変数以外の変数を追加する場合は、再設計が必要です。","enum":["CUSTOMER_ID","CUSTOMER_GROUP"],"title":"AccessUserFilterEnum","type":"string"},"KnowledgeBaseFileProperty":{"properties":{"key":{"title":"Key","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseNotificationHookEnum":{"description":"Notification hooks that can be triggered on document ingestion events.","enum":["email_on_ingestion_complete"],"title":"KnowledgeBaseNotificationHookEnum","type":"string"}}}}
```

## The UploadFromAzureBlobRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UploadFromAzureBlobRequest":{"description":"Azure Blob Storageからファイルをアップロードするためのリクエストモデル。","properties":{"fileName":{"description":"ファイル名","title":"Filename","type":"string"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"ハッシュタグ","title":"Hashtags"},"targetFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ターゲットフォルダーID","title":"Targetfolderid"},"isOverwriteFolderAccess":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"フォルダのアクセス権限の上書きフラグ","title":"Isoverwritefolderaccess"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"description":"アクセス許可グループ","title":"Accesspermissiongroups"},"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"アクセス許可管理者","title":"Accessagents"},"accessUserFilters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessUserFilter"},"type":"array"},{"type":"null"}],"description":"アクセスユーザーフィルター","title":"Accessuserfilters"},"viewAccessToAgent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"管理者の閲覧権限","title":"Viewaccesstoagent"},"viewAccessToUser":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"ユーザーの閲覧権限","title":"Viewaccesstouser"},"useLayout":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Uselayout"},"useImageDescription":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Useimagedescription"},"useOcr":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"Whether to use OCR for document processing","title":"Useocr"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"description":"ナレッジベースノードに付与するメタ情報","title":"Properties"},"notificationHooks":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNotificationHookEnum"},"type":"array"},{"type":"null"}],"description":"List of notification hooks to trigger on document ingestion events","title":"Notificationhooks"},"containerBlobPath":{"description":"ファイルのコンテナブロブパス","title":"Containerblobpath","type":"string"},"azureConnectionString":{"description":"Azure Blob Storageの接続文字列。","title":"Azureconnectionstring","type":"string"}},"required":["fileName","containerBlobPath"],"title":"UploadFromAzureBlobRequest","type":"object"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"AccessUserFilter":{"properties":{"variableName":{"$ref":"#/components/schemas/AccessUserFilterEnum","description":"フィルターの変数名"},"value":{"description":"フィルターの値","title":"Value","type":"string"}},"required":["variableName","value"],"title":"AccessUserFilter","type":"object"},"AccessUserFilterEnum":{"description":"システム変数以外の変数を追加する場合は、再設計が必要です。","enum":["CUSTOMER_ID","CUSTOMER_GROUP"],"title":"AccessUserFilterEnum","type":"string"},"KnowledgeBaseFileProperty":{"properties":{"key":{"title":"Key","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseNotificationHookEnum":{"description":"Notification hooks that can be triggered on document ingestion events.","enum":["email_on_ingestion_complete"],"title":"KnowledgeBaseNotificationHookEnum","type":"string"}}}}
```

## The KnowledgeBaseNodes object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodes":{"properties":{"nodes":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}]},"type":"array"},{"type":"null"}],"description":"knowledge base nodes","title":"Nodes"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base nodes cursor","title":"Cursor"},"totalFileCount":{"description":"total number of files","title":"Totalfilecount","type":"integer"},"totalFolderCount":{"description":"total number of folders","title":"Totalfoldercount","type":"integer"}},"required":["totalFileCount","totalFolderCount"],"title":"KnowledgeBaseNodes","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"title":"Key","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"}}}}
```

## The KnowledgeBaseNodesResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodesResponse":{"properties":{"result":{"$ref":"#/components/schemas/KnowledgeBaseNodes","description":"Knowledge base nodes"}},"required":["result"],"title":"KnowledgeBaseNodesResponse","type":"object"},"KnowledgeBaseNodes":{"properties":{"nodes":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}]},"type":"array"},{"type":"null"}],"description":"knowledge base nodes","title":"Nodes"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base nodes cursor","title":"Cursor"},"totalFileCount":{"description":"total number of files","title":"Totalfilecount","type":"integer"},"totalFolderCount":{"description":"total number of folders","title":"Totalfoldercount","type":"integer"}},"required":["totalFileCount","totalFolderCount"],"title":"KnowledgeBaseNodes","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"title":"Key","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"}}}}
```

## The DocSourceEnum object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"DocSourceEnum":{"enum":["onedrive","html","google-drive","confluence","sharepoint","notion","github","alli","data_integration_service","box","google_drive_v2"],"title":"DocSourceEnum","type":"string"}}}}
```

## The KnowledgeBaseNodeFilter object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodeFilter":{"properties":{"parentFolderIds":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Parentfolderids"},"searchTerm":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Searchterm"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Hashtags"},"hashtagsSearchOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hashtagssearchoperator"},"combinedHashtags":{"anyOf":[{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},{"type":"null"}],"title":"Combinedhashtags"},"combinedHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Combinedhashtagsoperator"},"excludingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludinghashtags"},"excludingHashtagsSearchOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Excludinghashtagssearchoperator"},"processState":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProcessStateEnum"},"type":"array"},{"type":"null"}],"title":"Processstate"},"status":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNodeOnOffState"},"type":"array"},{"type":"null"}],"title":"Status"},"nodeType":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNodeType"},"type":"array"},{"type":"null"}],"title":"Nodetype"},"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Knowledgebaseids"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Folderids"},"ownership":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNodeOwnership"},"type":"array"},{"type":"null"}],"title":"Ownership"},"ancestorIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ancestorids"},"hasFaqCandidates":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hasfaqcandidates"},"sourceTypes":{"anyOf":[{"items":{"$ref":"#/components/schemas/DocSourceEnum"},"type":"array"},{"type":"null"}],"title":"Sourcetypes"}},"title":"KnowledgeBaseNodeFilter","type":"object"},"ProcessStateEnum":{"enum":["initializing","parsing","parsing_fail","completed","retrying","post_parsing","post_parsing_fail","post_completed","post_retrying"],"title":"ProcessStateEnum","type":"string"},"KnowledgeBaseNodeOnOffState":{"enum":["on","off"],"title":"KnowledgeBaseNodeOnOffState","type":"string"},"KnowledgeBaseNodeType":{"enum":["file","folder"],"title":"KnowledgeBaseNodeType","type":"string"},"KnowledgeBaseNodeOwnership":{"enum":["personal","shared"],"title":"KnowledgeBaseNodeOwnership","type":"string"},"DocSourceEnum":{"enum":["onedrive","html","google-drive","confluence","sharepoint","notion","github","alli","data_integration_service","box","google_drive_v2"],"title":"DocSourceEnum","type":"string"}}}}
```

## The KnowledgeBaseNodeOnOffState object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodeOnOffState":{"enum":["on","off"],"title":"KnowledgeBaseNodeOnOffState","type":"string"}}}}
```

## The KnowledgeBaseNodeOrder object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodeOrder":{"enum":["name_asc","name_desc","updated_at_asc","updated_at_desc","created_at_asc","created_at_desc","file_and_name_asc","file_and_name_desc","folder_and_name_asc","folder_and_name_desc"],"title":"KnowledgeBaseNodeOrder","type":"string"}}}}
```

## The KnowledgeBaseNodeOwnership object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodeOwnership":{"enum":["personal","shared"],"title":"KnowledgeBaseNodeOwnership","type":"string"}}}}
```

## The KnowledgeBaseNodeType object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodeType":{"enum":["file","folder"],"title":"KnowledgeBaseNodeType","type":"string"}}}}
```

## The KnowledgeBaseNodesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseNodesRequest":{"properties":{"filter_":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFilter"},{"type":"null"}],"description":"The filter of the knowledge base node"},"filter":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFilter"},{"type":"null"}],"description":"The filter of the knowledge base node"},"order":{"allOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeOrder"}],"default":"updated_at_desc","description":"The order of the knowledge base node"},"limit":{"default":10,"description":"The limit of the knowledge base node","title":"Limit","type":"integer"},"after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The after of the knowledge base node","title":"After"},"offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The offset of the knowledge base node","title":"Offset"}},"title":"KnowledgeBaseNodesRequest","type":"object"},"KnowledgeBaseNodeFilter":{"properties":{"parentFolderIds":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Parentfolderids"},"searchTerm":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Searchterm"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Hashtags"},"hashtagsSearchOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hashtagssearchoperator"},"combinedHashtags":{"anyOf":[{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},{"type":"null"}],"title":"Combinedhashtags"},"combinedHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Combinedhashtagsoperator"},"excludingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludinghashtags"},"excludingHashtagsSearchOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Excludinghashtagssearchoperator"},"processState":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProcessStateEnum"},"type":"array"},{"type":"null"}],"title":"Processstate"},"status":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNodeOnOffState"},"type":"array"},{"type":"null"}],"title":"Status"},"nodeType":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNodeType"},"type":"array"},{"type":"null"}],"title":"Nodetype"},"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Knowledgebaseids"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Folderids"},"ownership":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNodeOwnership"},"type":"array"},{"type":"null"}],"title":"Ownership"},"ancestorIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ancestorids"},"hasFaqCandidates":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hasfaqcandidates"},"sourceTypes":{"anyOf":[{"items":{"$ref":"#/components/schemas/DocSourceEnum"},"type":"array"},{"type":"null"}],"title":"Sourcetypes"}},"title":"KnowledgeBaseNodeFilter","type":"object"},"ProcessStateEnum":{"enum":["initializing","parsing","parsing_fail","completed","retrying","post_parsing","post_parsing_fail","post_completed","post_retrying"],"title":"ProcessStateEnum","type":"string"},"KnowledgeBaseNodeOnOffState":{"enum":["on","off"],"title":"KnowledgeBaseNodeOnOffState","type":"string"},"KnowledgeBaseNodeType":{"enum":["file","folder"],"title":"KnowledgeBaseNodeType","type":"string"},"KnowledgeBaseNodeOwnership":{"enum":["personal","shared"],"title":"KnowledgeBaseNodeOwnership","type":"string"},"DocSourceEnum":{"enum":["onedrive","html","google-drive","confluence","sharepoint","notion","github","alli","data_integration_service","box","google_drive_v2"],"title":"DocSourceEnum","type":"string"},"KnowledgeBaseNodeOrder":{"enum":["name_asc","name_desc","updated_at_asc","updated_at_desc","created_at_asc","created_at_desc","file_and_name_asc","file_and_name_desc","folder_and_name_asc","folder_and_name_desc"],"title":"KnowledgeBaseNodeOrder","type":"string"}}}}
```

## The ProcessStateEnum object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ProcessStateEnum":{"enum":["initializing","parsing","parsing_fail","completed","retrying","post_parsing","post_parsing_fail","post_completed","post_retrying"],"title":"ProcessStateEnum","type":"string"}}}}
```

## The ContentSearchRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ContentSearchRequest":{"properties":{"searchTerm":{"description":"The search term of the knowledge base node","title":"Searchterm","type":"string"},"limit":{"default":10,"description":"The limit of the knowledge base node","exclusiveMinimum":0,"lte":10000,"title":"Limit","type":"integer"},"after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The after of the knowledge base node","title":"After"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The folder IDs of the knowledge base node","title":"Folderids"},"searchScope":{"allOf":[{"$ref":"#/components/schemas/SearchScopeEnum"}],"default":"both","description":"The search scope of the knowledge base node"}},"required":["searchTerm"],"title":"ContentSearchRequest","type":"object"},"SearchScopeEnum":{"enum":["title_only","content_only","both"],"title":"SearchScopeEnum","type":"string"}}}}
```

## The SearchScopeEnum object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"SearchScopeEnum":{"enum":["title_only","content_only","both"],"title":"SearchScopeEnum","type":"string"}}}}
```

## The PageContentItem object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"PageContentItem":{"description":"Individual page content item with metadata.","properties":{"kbId":{"description":"Knowledge base ID","title":"Kbid","type":"string"},"title":{"description":"Document title","title":"Title","type":"string"},"text":{"description":"Page text content","title":"Text","type":"string"},"pageNo":{"description":"Page number","title":"Pageno","type":"integer"}},"required":["kbId","title","text","pageNo"],"title":"PageContentItem","type":"object"}}}}
```

## The PageContentSearchResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"PageContentSearchResponse":{"description":"Response model for page content search containing list of page content items with metadata.","properties":{"results":{"description":"List of page content items with metadata","items":{"$ref":"#/components/schemas/PageContentItem"},"title":"Results","type":"array"}},"required":["results"],"title":"PageContentSearchResponse","type":"object"},"PageContentItem":{"description":"Individual page content item with metadata.","properties":{"kbId":{"description":"Knowledge base ID","title":"Kbid","type":"string"},"title":{"description":"Document title","title":"Title","type":"string"},"text":{"description":"Page text content","title":"Text","type":"string"},"pageNo":{"description":"Page number","title":"Pageno","type":"integer"}},"required":["kbId","title","text","pageNo"],"title":"PageContentItem","type":"object"}}}}
```

## The PageContentSearchRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"PageContentSearchRequest":{"properties":{"searchTerms":{"description":"The search terms for page content search","items":{"type":"string"},"title":"Searchterms","type":"array"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The folder IDs to search within","title":"Folderids"},"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The knowledge base IDs to search within","title":"Knowledgebaseids"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The hashtags to filter by","title":"Hashtags"},"hashtagsOperator":{"default":"OR","description":"The hashtags operator (AND/OR)","title":"Hashtagsoperator","type":"string"},"excludeHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The hashtags to exclude","title":"Excludehashtags"},"excludeHashtagsOperator":{"default":"OR","description":"The exclude hashtags operator (AND/OR)","title":"Excludehashtagsoperator","type":"string"},"topN":{"default":1,"description":"The number of top results to return","exclusiveMinimum":0,"lte":100,"title":"Topn","type":"integer"},"mergeSamePage":{"default":false,"description":"Whether to merge content from the same page","title":"Mergesamepage","type":"boolean"}},"required":["searchTerms"],"title":"PageContentSearchRequest","type":"object"}}}}
```

## The UpdateKnowledgeBaseNodeRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UpdateKnowledgeBaseNodeRequest":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ナレッジベースノードのタイトル","title":"Title"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"ハッシュタグ","title":"Hashtags"},"is_overwrite_folder_access":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"アクセス権限の上書きフラグ","title":"Is Overwrite Folder Access"},"access_permission_groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"description":"アクセス許可グループ","title":"Access Permission Groups"},"access_agents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"アクセス管理者","title":"Access Agents"},"access_user_filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessUserFilter"},"type":"array"},{"type":"null"}],"description":"アクセスユーザーフィルター","title":"Access User Filters"},"view_access_to_agent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"管理者の閲覧権限","title":"View Access To Agent"},"view_access_to_user":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"ユーザーの閲覧権限","title":"View Access To User"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"description":"ナレッジベースノードに付与するメタデータ情報","title":"Properties"}},"title":"UpdateKnowledgeBaseNodeRequest","type":"object"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"AccessUserFilter":{"properties":{"variableName":{"$ref":"#/components/schemas/AccessUserFilterEnum","description":"フィルターの変数名"},"value":{"description":"フィルターの値","title":"Value","type":"string"}},"required":["variableName","value"],"title":"AccessUserFilter","type":"object"},"AccessUserFilterEnum":{"description":"システム変数以外の変数を追加する場合は、再設計が必要です。","enum":["CUSTOMER_ID","CUSTOMER_GROUP"],"title":"AccessUserFilterEnum","type":"string"},"KnowledgeBaseFileProperty":{"properties":{"key":{"title":"Key","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"}}}}
```

## The KnowledgeBasePreviewResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBasePreviewResponse":{"description":"Response model for knowledge base preview containing HTML and PDF information.","properties":{"html":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HTML preview of the knowledge base","title":"Html"},"pdfUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"PDF preview of the knowledge base","title":"Pdfurl"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Image preview of the knowledge base","title":"Imageurl"},"previewUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Preview URL of the knowledge base","title":"Previewurl"},"totalPreviewCount":{"default":0,"description":"Total preview count of the knowledge base","title":"Totalpreviewcount","type":"integer"},"piiMasked":{"default":false,"description":"Whether the preview is hidden due to PII masking","title":"Piimasked","type":"boolean"}},"title":"KnowledgeBasePreviewResponse","type":"object"}}}}
```

## The FolderResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"FolderResponse":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"createdAt":{"title":"Createdat","type":"number"},"updatedAt":{"title":"Updatedat","type":"number"},"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentfolderid"},"folderSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Foldersize"}},"required":["id","name","createdAt","updatedAt"],"title":"FolderResponse","type":"object"}}}}
```

## The CreateFolderRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"CreateFolderRequest":{"properties":{"name":{"maxLength":50,"title":"Name","type":"string"},"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentfolderid"},"followParentFolderPermission":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"Followparentfolderpermission"},"permissionGroupEditors":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Permissiongroupeditors"},"permissionGroupViewers":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Permissiongroupviewers"},"agentEditors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Agenteditors"},"agentViewers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Agentviewers"},"userViewers":{"anyOf":[{"$ref":"#/components/schemas/UserAccessPermissionRequest"},{"type":"null"}]},"allowOtherAgentsView":{"default":true,"title":"Allowotheragentsview","type":"boolean"},"allowOtherUsersView":{"default":true,"title":"Allowotherusersview","type":"boolean"}},"required":["name"],"title":"CreateFolderRequest","type":"object"},"UserAccessPermissionRequest":{"properties":{"customerIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customerids"},"customerGroupIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroupids"}},"title":"UserAccessPermissionRequest","type":"object"}}}}
```

## The UserAccessPermissionRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UserAccessPermissionRequest":{"properties":{"customerIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customerids"},"customerGroupIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroupids"}},"title":"UserAccessPermissionRequest","type":"object"}}}}
```

## The UpdateFolderRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UpdateFolderRequest":{"properties":{"name":{"maxLength":50,"title":"Name","type":"string"},"permissionGroupEditors":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Permissiongroupeditors"},"permissionGroupViewers":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Permissiongroupviewers"},"agentEditors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Agenteditors"},"agentViewers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Agentviewers"},"userViewers":{"anyOf":[{"$ref":"#/components/schemas/UserAccessPermissionRequest"},{"type":"null"}]},"allowOtherAgentsView":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allowotheragentsview"},"allowOtherUsersView":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allowotherusersview"}},"required":["name"],"title":"UpdateFolderRequest","type":"object"},"UserAccessPermissionRequest":{"properties":{"customerIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customerids"},"customerGroupIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroupids"}},"title":"UserAccessPermissionRequest","type":"object"}}}}
```

## The AnswerType object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AnswerType":{"description":"回答タイプ","enum":["PARAGRAPH","TABLE","IMAGE"],"title":"AnswerType","type":"string"}}}}
```

## The BboxResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"BboxResponse":{"properties":{"left":{"title":"Left","type":"number"},"top":{"title":"Top","type":"number"},"right":{"title":"Right","type":"number"},"bottom":{"title":"Bottom","type":"number"}},"required":["left","top","right","bottom"],"title":"BboxResponse","type":"object"}}}}
```

## The HighlightResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"HighlightResponse":{"properties":{"bboxes":{"items":{"$ref":"#/components/schemas/BboxResponse"},"title":"Bboxes","type":"array"},"type":{"$ref":"#/components/schemas/AnswerType"}},"required":["bboxes","type"],"title":"HighlightResponse","type":"object"},"BboxResponse":{"properties":{"left":{"title":"Left","type":"number"},"top":{"title":"Top","type":"number"},"right":{"title":"Right","type":"number"},"bottom":{"title":"Bottom","type":"number"}},"required":["left","top","right","bottom"],"title":"BboxResponse","type":"object"},"AnswerType":{"description":"回答タイプ","enum":["PARAGRAPH","TABLE","IMAGE"],"title":"AnswerType","type":"string"}}}}
```

## The KnowledgeBaseDiffResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseDiffResponse":{"properties":{"result":{"items":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDiffer"},"title":"Result","type":"array"}},"required":["result"],"title":"KnowledgeBaseDiffResponse","type":"object"},"KnowledgeBaseDiffResponseLineDiffer":{"properties":{"left":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDelta"},"right":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDelta"},"row":{"title":"Row","type":"integer"},"comment":{"title":"Comment","type":"string"}},"required":["left","right","row","comment"],"title":"KnowledgeBaseDiffResponseLineDiffer","type":"object"},"KnowledgeBaseDiffResponseLineDelta":{"properties":{"status":{"title":"Status","type":"string"},"page":{"title":"Page","type":"integer"},"line":{"title":"Line","type":"integer"},"text":{"title":"Text","type":"string"},"highlight":{"title":"Highlight","type":"string"}},"required":["status","page","line","text","highlight"],"title":"KnowledgeBaseDiffResponseLineDelta","type":"object"}}}}
```

## The KnowledgeBaseDiffResponseLineDelta object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseDiffResponseLineDelta":{"properties":{"status":{"title":"Status","type":"string"},"page":{"title":"Page","type":"integer"},"line":{"title":"Line","type":"integer"},"text":{"title":"Text","type":"string"},"highlight":{"title":"Highlight","type":"string"}},"required":["status","page","line","text","highlight"],"title":"KnowledgeBaseDiffResponseLineDelta","type":"object"}}}}
```

## The KnowledgeBaseDiffResponseLineDiffer object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseDiffResponseLineDiffer":{"properties":{"left":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDelta"},"right":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDelta"},"row":{"title":"Row","type":"integer"},"comment":{"title":"Comment","type":"string"}},"required":["left","right","row","comment"],"title":"KnowledgeBaseDiffResponseLineDiffer","type":"object"},"KnowledgeBaseDiffResponseLineDelta":{"properties":{"status":{"title":"Status","type":"string"},"page":{"title":"Page","type":"integer"},"line":{"title":"Line","type":"integer"},"text":{"title":"Text","type":"string"},"highlight":{"title":"Highlight","type":"string"}},"required":["status","page","line","text","highlight"],"title":"KnowledgeBaseDiffResponseLineDelta","type":"object"}}}}
```

## The KnowledgeBaseDiffRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseDiffRequest":{"properties":{"leftId":{"description":"左のナレッジベースID","title":"Leftid","type":"string"},"rightId":{"description":"正しいナレッジベースID","title":"Rightid","type":"string"}},"required":["leftId","rightId"],"title":"KnowledgeBaseDiffRequest","type":"object"}}}}
```

## The AppsFilters object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AppsFilters":{"description":"Filters for listing apps.","properties":{"searchTerm":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search term for app name or description","title":"Searchterm"},"categories":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Filter by app categories","title":"Categories"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by app type","title":"Type"},"published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter by published status","title":"Published"},"pageSize":{"default":50,"description":"Number of apps per page","maximum":100,"minimum":1,"title":"Pagesize","type":"integer"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for pagination","title":"Cursor"}},"title":"AppsFilters","type":"object"}}}}
```

## The App object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"App":{"description":"App information.","properties":{"id":{"description":"Unique ID of the app","title":"Id","type":"string"},"name":{"description":"Name of the app","title":"Name","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the app","title":"Description"},"type":{"description":"Type of the app","title":"Type","type":"string"},"category":{"description":"Category of the app","title":"Category","type":"string"},"published":{"description":"Whether the app is published","title":"Published","type":"boolean"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"}},"required":["id","name","type","category","published","agentPermission","userPermission"],"title":"App","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"}}}}
```

## The AppsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AppsResponse":{"description":"Response for listing apps.","properties":{"apps":{"description":"List of apps","items":{"$ref":"#/components/schemas/App"},"title":"Apps","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for pagination","title":"Cursor"}},"required":["apps"],"title":"AppsResponse","type":"object"},"App":{"description":"App information.","properties":{"id":{"description":"Unique ID of the app","title":"Id","type":"string"},"name":{"description":"Name of the app","title":"Name","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the app","title":"Description"},"type":{"description":"Type of the app","title":"Type","type":"string"},"category":{"description":"Category of the app","title":"Category","type":"string"},"published":{"description":"Whether the app is published","title":"Published","type":"boolean"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"}},"required":["id","name","type","category","published","agentPermission","userPermission"],"title":"App","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"}}}}
```

## The AgentPermission object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AgentPermission":{"properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermission","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"}}}}
```

## The UpdateAppRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UpdateAppRequest":{"description":"Request schema for updating an app.","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the app","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the app","title":"Description"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Category of the app","title":"Category"},"published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the app is published","title":"Published"},"agentPermission":{"anyOf":[{"$ref":"#/components/schemas/AgentPermission"},{"type":"null"}],"description":"Agent permission"},"userPermission":{"anyOf":[{"$ref":"#/components/schemas/UserPermission"},{"type":"null"}],"description":"User permission"}},"title":"UpdateAppRequest","type":"object"},"AgentPermission":{"properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermission","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"UserPermission":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermission","type":"object"}}}}
```

## The UserPermission object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UserPermission":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermission","type":"object"}}}}
```

## The RunCampaignRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RunCampaignRequest":{"description":"Request body for running a campaign app with streaming (multipart/form-data).","properties":{"conversationId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Existing conversation ID to continue","title":"Conversationid"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User message text","title":"Message"},"choices":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Button/option choice indices (JSON array string, e.g. '[0, 1]')","title":"Choices"},"sendFormInput":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Form submission data (JSON string)","title":"Sendforminput"}},"title":"RunCampaignRequest","type":"object"}}}}
```

## The ConversationFilters object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ConversationFilters":{"properties":{"userIds":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Userids"},"llmAppId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llmappid"},"categoryId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Categoryid"},"startedAt":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"この値以降の最終チャット時間を検索","title":"Startedat"},"endAt":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"この値以前の最後のチャット時間を検索","title":"Endat"},"firstChatStartedAt":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"この値以降に最初のチャット時間を検索","title":"Firstchatstartedat"},"firstChatEndAt":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"この値以前の最初のチャット時間を検索","title":"Firstchatendat"},"searchTerm":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Searchterm"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"variables":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Variables"},"pageSize":{"default":50,"maximum":50,"minimum":1,"title":"Pagesize","type":"integer"},"activeOnly":{"default":false,"title":"Activeonly","type":"boolean"},"backgroundRunning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Backgroundrunning"},"order":{"allOf":[{"enum":["LAST_CHAT_TIME_DESC","LAST_CHAT_TIME_ASC","FIRST_CHAT_TIME_DESC","FIRST_CHAT_TIME_ASC"],"title":"ConversationListOrderEnum","type":"string"}],"default":"LAST_CHAT_TIME_DESC"}},"title":"ConversationFilters","type":"object"}}}}
```

## The ConversationListOrderEnum object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ConversationListOrderEnum":{"enum":["LAST_CHAT_TIME_DESC","LAST_CHAT_TIME_ASC","FIRST_CHAT_TIME_DESC","FIRST_CHAT_TIME_ASC"],"title":"ConversationListOrderEnum","type":"string"}}}}
```

## The Chat object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"Chat":{"properties":{"id":{"description":"チャットのユニークID。","title":"Id","type":"string"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Node type of the chat","title":"Type"},"sender":{"description":"送信者の種別","title":"Sender","type":"string"},"message":{"description":"チャットメッセージ","title":"Message","type":"string"},"source":{"anyOf":[{"$ref":"#/components/schemas/ChatInputSource"},{"type":"null"}],"description":"Source of the chat"},"timestamp":{"description":"チャットメッセージ作成時のタイムスタンプ","title":"Timestamp","type":"number"},"completed":{"description":"Whether the chat generation is completed","title":"Completed","type":"boolean"},"citations":{"anyOf":[{"items":{"$ref":"#/components/schemas/Citation"},"type":"array"},{"type":"null"}],"description":"引用情報","title":"Citations"},"rating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"チャットの評価","title":"Rating"},"agentRating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"管理者の評価","title":"Agentrating"}},"required":["id","sender","message","timestamp","completed","citations","rating","agentRating"],"title":"Chat","type":"object"},"ChatInputSource":{"description":"Chat input source information in response.","properties":{"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of knowledge base IDs","title":"Knowledgebaseids"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of folder IDs","title":"Folderids"},"webSites":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of web sites","title":"Websites"},"searchAllSharedDocument":{"default":false,"description":"Search all shared documents","title":"Searchallshareddocument","type":"boolean"},"searchAllPersonalDocument":{"default":false,"description":"Search all personal documents","title":"Searchallpersonaldocument","type":"boolean"},"includingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Including hashtags","title":"Includinghashtags"},"excludingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Excluding hashtags","title":"Excludinghashtags"},"includingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Including hashtags operator","title":"Includinghashtagsoperator"},"excludingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Excluding hashtags operator","title":"Excludinghashtagsoperator"},"sharedKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Shared knowledge bases with details","title":"Sharedknowledgebases"},"sharedFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Shared folders with details","title":"Sharedfolders"},"personalKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Personal knowledge bases with details","title":"Personalknowledgebases"},"personalFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Personal folders with details","title":"Personalfolders"}},"title":"ChatInputSource","type":"object"},"KnowledgeBaseInfo":{"description":"Knowledge base information in response.","properties":{"id":{"description":"Unique ID of the knowledge base","title":"Id","type":"string"},"name":{"description":"Name of the knowledge base","title":"Name","type":"string"}},"required":["id","name"],"title":"KnowledgeBaseInfo","type":"object"},"FolderInfo":{"description":"Folder information in response.","properties":{"id":{"description":"Unique ID of the folder","title":"Id","type":"string"},"name":{"description":"Name of the folder","title":"Name","type":"string"}},"required":["id","name"],"title":"FolderInfo","type":"object"},"Citation":{"properties":{"clueId":{"description":"回答根拠ページのID","title":"Clueid","type":"string"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用元","title":"Source"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠の文書タイトル","title":"Title"},"knowledgeBaseId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠のドキュメントID","title":"Knowledgebaseid"},"pageNo":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"回答根拠ドキュメントのページ番号","title":"Pageno"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用のURL","title":"Url"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用文のテキスト","title":"Text"}},"required":["clueId"],"title":"Citation","type":"object"}}}}
```

## The ChatInputSource object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ChatInputSource":{"description":"Chat input source information in response.","properties":{"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of knowledge base IDs","title":"Knowledgebaseids"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of folder IDs","title":"Folderids"},"webSites":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of web sites","title":"Websites"},"searchAllSharedDocument":{"default":false,"description":"Search all shared documents","title":"Searchallshareddocument","type":"boolean"},"searchAllPersonalDocument":{"default":false,"description":"Search all personal documents","title":"Searchallpersonaldocument","type":"boolean"},"includingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Including hashtags","title":"Includinghashtags"},"excludingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Excluding hashtags","title":"Excludinghashtags"},"includingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Including hashtags operator","title":"Includinghashtagsoperator"},"excludingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Excluding hashtags operator","title":"Excludinghashtagsoperator"},"sharedKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Shared knowledge bases with details","title":"Sharedknowledgebases"},"sharedFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Shared folders with details","title":"Sharedfolders"},"personalKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Personal knowledge bases with details","title":"Personalknowledgebases"},"personalFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Personal folders with details","title":"Personalfolders"}},"title":"ChatInputSource","type":"object"},"KnowledgeBaseInfo":{"description":"Knowledge base information in response.","properties":{"id":{"description":"Unique ID of the knowledge base","title":"Id","type":"string"},"name":{"description":"Name of the knowledge base","title":"Name","type":"string"}},"required":["id","name"],"title":"KnowledgeBaseInfo","type":"object"},"FolderInfo":{"description":"Folder information in response.","properties":{"id":{"description":"Unique ID of the folder","title":"Id","type":"string"},"name":{"description":"Name of the folder","title":"Name","type":"string"}},"required":["id","name"],"title":"FolderInfo","type":"object"}}}}
```

## The Citation object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"Citation":{"properties":{"clueId":{"description":"回答根拠ページのID","title":"Clueid","type":"string"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用元","title":"Source"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠の文書タイトル","title":"Title"},"knowledgeBaseId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠のドキュメントID","title":"Knowledgebaseid"},"pageNo":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"回答根拠ドキュメントのページ番号","title":"Pageno"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用のURL","title":"Url"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用文のテキスト","title":"Text"}},"required":["clueId"],"title":"Citation","type":"object"}}}}
```

## The Conversation object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"Conversation":{"properties":{"id":{"description":"会話ID","title":"Id","type":"string"},"title":{"description":"会話のタイトル","title":"Title","type":"string"},"user":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"ユーザー情報"},"createdAt":{"description":"会話作成時間","title":"Createdat","type":"number"},"lastChatTime":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"最終チャット時間","title":"Lastchattime"},"isEnd":{"description":"会話の終了状況","title":"Isend","type":"boolean"},"categories":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"会話カテゴリー","title":"Categories"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"会話メモ","title":"Memo"},"chats":{"description":"チャット情報","items":{"$ref":"#/components/schemas/Chat"},"title":"Chats","type":"array"},"chatCount":{"description":"合計会話数","title":"Chatcount","type":"integer"},"llmApp":{"anyOf":[{"$ref":"#/components/schemas/LLMApp"},{"type":"null"}],"description":"アプリ情報"},"variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"変数","title":"Variables"}},"required":["id","title","user","createdAt","lastChatTime","isEnd","categories","memo","chats","chatCount","llmApp","variables"],"title":"Conversation","type":"object"},"User":{"properties":{"userId":{"description":"ユーザーID","title":"Userid","type":"string"},"firstName":{"description":"ユーザーの名","title":"Firstname","type":"string"},"lastName":{"description":"ユーザーの姓","title":"Lastname","type":"string"}},"required":["userId","firstName","lastName"],"title":"User","type":"object"},"Chat":{"properties":{"id":{"description":"チャットのユニークID。","title":"Id","type":"string"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Node type of the chat","title":"Type"},"sender":{"description":"送信者の種別","title":"Sender","type":"string"},"message":{"description":"チャットメッセージ","title":"Message","type":"string"},"source":{"anyOf":[{"$ref":"#/components/schemas/ChatInputSource"},{"type":"null"}],"description":"Source of the chat"},"timestamp":{"description":"チャットメッセージ作成時のタイムスタンプ","title":"Timestamp","type":"number"},"completed":{"description":"Whether the chat generation is completed","title":"Completed","type":"boolean"},"citations":{"anyOf":[{"items":{"$ref":"#/components/schemas/Citation"},"type":"array"},{"type":"null"}],"description":"引用情報","title":"Citations"},"rating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"チャットの評価","title":"Rating"},"agentRating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"管理者の評価","title":"Agentrating"}},"required":["id","sender","message","timestamp","completed","citations","rating","agentRating"],"title":"Chat","type":"object"},"ChatInputSource":{"description":"Chat input source information in response.","properties":{"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of knowledge base IDs","title":"Knowledgebaseids"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of folder IDs","title":"Folderids"},"webSites":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of web sites","title":"Websites"},"searchAllSharedDocument":{"default":false,"description":"Search all shared documents","title":"Searchallshareddocument","type":"boolean"},"searchAllPersonalDocument":{"default":false,"description":"Search all personal documents","title":"Searchallpersonaldocument","type":"boolean"},"includingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Including hashtags","title":"Includinghashtags"},"excludingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Excluding hashtags","title":"Excludinghashtags"},"includingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Including hashtags operator","title":"Includinghashtagsoperator"},"excludingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Excluding hashtags operator","title":"Excludinghashtagsoperator"},"sharedKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Shared knowledge bases with details","title":"Sharedknowledgebases"},"sharedFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Shared folders with details","title":"Sharedfolders"},"personalKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Personal knowledge bases with details","title":"Personalknowledgebases"},"personalFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Personal folders with details","title":"Personalfolders"}},"title":"ChatInputSource","type":"object"},"KnowledgeBaseInfo":{"description":"Knowledge base information in response.","properties":{"id":{"description":"Unique ID of the knowledge base","title":"Id","type":"string"},"name":{"description":"Name of the knowledge base","title":"Name","type":"string"}},"required":["id","name"],"title":"KnowledgeBaseInfo","type":"object"},"FolderInfo":{"description":"Folder information in response.","properties":{"id":{"description":"Unique ID of the folder","title":"Id","type":"string"},"name":{"description":"Name of the folder","title":"Name","type":"string"}},"required":["id","name"],"title":"FolderInfo","type":"object"},"Citation":{"properties":{"clueId":{"description":"回答根拠ページのID","title":"Clueid","type":"string"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用元","title":"Source"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠の文書タイトル","title":"Title"},"knowledgeBaseId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠のドキュメントID","title":"Knowledgebaseid"},"pageNo":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"回答根拠ドキュメントのページ番号","title":"Pageno"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用のURL","title":"Url"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用文のテキスト","title":"Text"}},"required":["clueId"],"title":"Citation","type":"object"},"LLMApp":{"properties":{"id":{"description":"アプリのユニークID","title":"Id","type":"string"},"name":{"description":"アプリの名前","title":"Name","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"アプリの説明","title":"Description"}},"required":["id","name"],"title":"LLMApp","type":"object"}}}}
```

## The ConversationsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ConversationsResponse":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/Conversation"},"title":"Conversations","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ページネーション用のカーソル","title":"Cursor"}},"required":["conversations","cursor"],"title":"ConversationsResponse","type":"object"},"Conversation":{"properties":{"id":{"description":"会話ID","title":"Id","type":"string"},"title":{"description":"会話のタイトル","title":"Title","type":"string"},"user":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"ユーザー情報"},"createdAt":{"description":"会話作成時間","title":"Createdat","type":"number"},"lastChatTime":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"最終チャット時間","title":"Lastchattime"},"isEnd":{"description":"会話の終了状況","title":"Isend","type":"boolean"},"categories":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"会話カテゴリー","title":"Categories"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"会話メモ","title":"Memo"},"chats":{"description":"チャット情報","items":{"$ref":"#/components/schemas/Chat"},"title":"Chats","type":"array"},"chatCount":{"description":"合計会話数","title":"Chatcount","type":"integer"},"llmApp":{"anyOf":[{"$ref":"#/components/schemas/LLMApp"},{"type":"null"}],"description":"アプリ情報"},"variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"変数","title":"Variables"}},"required":["id","title","user","createdAt","lastChatTime","isEnd","categories","memo","chats","chatCount","llmApp","variables"],"title":"Conversation","type":"object"},"User":{"properties":{"userId":{"description":"ユーザーID","title":"Userid","type":"string"},"firstName":{"description":"ユーザーの名","title":"Firstname","type":"string"},"lastName":{"description":"ユーザーの姓","title":"Lastname","type":"string"}},"required":["userId","firstName","lastName"],"title":"User","type":"object"},"Chat":{"properties":{"id":{"description":"チャットのユニークID。","title":"Id","type":"string"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Node type of the chat","title":"Type"},"sender":{"description":"送信者の種別","title":"Sender","type":"string"},"message":{"description":"チャットメッセージ","title":"Message","type":"string"},"source":{"anyOf":[{"$ref":"#/components/schemas/ChatInputSource"},{"type":"null"}],"description":"Source of the chat"},"timestamp":{"description":"チャットメッセージ作成時のタイムスタンプ","title":"Timestamp","type":"number"},"completed":{"description":"Whether the chat generation is completed","title":"Completed","type":"boolean"},"citations":{"anyOf":[{"items":{"$ref":"#/components/schemas/Citation"},"type":"array"},{"type":"null"}],"description":"引用情報","title":"Citations"},"rating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"チャットの評価","title":"Rating"},"agentRating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"管理者の評価","title":"Agentrating"}},"required":["id","sender","message","timestamp","completed","citations","rating","agentRating"],"title":"Chat","type":"object"},"ChatInputSource":{"description":"Chat input source information in response.","properties":{"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of knowledge base IDs","title":"Knowledgebaseids"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of folder IDs","title":"Folderids"},"webSites":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of web sites","title":"Websites"},"searchAllSharedDocument":{"default":false,"description":"Search all shared documents","title":"Searchallshareddocument","type":"boolean"},"searchAllPersonalDocument":{"default":false,"description":"Search all personal documents","title":"Searchallpersonaldocument","type":"boolean"},"includingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Including hashtags","title":"Includinghashtags"},"excludingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Excluding hashtags","title":"Excludinghashtags"},"includingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Including hashtags operator","title":"Includinghashtagsoperator"},"excludingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Excluding hashtags operator","title":"Excludinghashtagsoperator"},"sharedKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Shared knowledge bases with details","title":"Sharedknowledgebases"},"sharedFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Shared folders with details","title":"Sharedfolders"},"personalKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Personal knowledge bases with details","title":"Personalknowledgebases"},"personalFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Personal folders with details","title":"Personalfolders"}},"title":"ChatInputSource","type":"object"},"KnowledgeBaseInfo":{"description":"Knowledge base information in response.","properties":{"id":{"description":"Unique ID of the knowledge base","title":"Id","type":"string"},"name":{"description":"Name of the knowledge base","title":"Name","type":"string"}},"required":["id","name"],"title":"KnowledgeBaseInfo","type":"object"},"FolderInfo":{"description":"Folder information in response.","properties":{"id":{"description":"Unique ID of the folder","title":"Id","type":"string"},"name":{"description":"Name of the folder","title":"Name","type":"string"}},"required":["id","name"],"title":"FolderInfo","type":"object"},"Citation":{"properties":{"clueId":{"description":"回答根拠ページのID","title":"Clueid","type":"string"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用元","title":"Source"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠の文書タイトル","title":"Title"},"knowledgeBaseId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠のドキュメントID","title":"Knowledgebaseid"},"pageNo":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"回答根拠ドキュメントのページ番号","title":"Pageno"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用のURL","title":"Url"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用文のテキスト","title":"Text"}},"required":["clueId"],"title":"Citation","type":"object"},"LLMApp":{"properties":{"id":{"description":"アプリのユニークID","title":"Id","type":"string"},"name":{"description":"アプリの名前","title":"Name","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"アプリの説明","title":"Description"}},"required":["id","name"],"title":"LLMApp","type":"object"}}}}
```

## The FolderInfo object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"FolderInfo":{"description":"Folder information in response.","properties":{"id":{"description":"Unique ID of the folder","title":"Id","type":"string"},"name":{"description":"Name of the folder","title":"Name","type":"string"}},"required":["id","name"],"title":"FolderInfo","type":"object"}}}}
```

## The KnowledgeBaseInfo object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseInfo":{"description":"Knowledge base information in response.","properties":{"id":{"description":"Unique ID of the knowledge base","title":"Id","type":"string"},"name":{"description":"Name of the knowledge base","title":"Name","type":"string"}},"required":["id","name"],"title":"KnowledgeBaseInfo","type":"object"}}}}
```

## The LLMApp object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMApp":{"properties":{"id":{"description":"アプリのユニークID","title":"Id","type":"string"},"name":{"description":"アプリの名前","title":"Name","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"アプリの説明","title":"Description"}},"required":["id","name"],"title":"LLMApp","type":"object"}}}}
```

## The ConversationInfoRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ConversationInfoRequest":{"properties":{"state":{"anyOf":[{"$ref":"#/components/schemas/ConversationStateEnum"},{"type":"null"}],"description":"会話の状態"},"assignee":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"会話の担当者","title":"Assignee"},"categoryIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"カテゴリのID","title":"Categoryids"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"会話のタイトル","title":"Title"}},"title":"ConversationInfoRequest","type":"object"},"ConversationStateEnum":{"enum":["no","eb","ea","eu","wa","wu","wu2","in","pnd","eo","lck"],"title":"ConversationStateEnum","type":"string"}}}}
```

## The ConversationStateEnum object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ConversationStateEnum":{"enum":["no","eb","ea","eu","wa","wu","wu2","in","pnd","eo","lck"],"title":"ConversationStateEnum","type":"string"}}}}
```

## The SetBulkConversationsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"SetBulkConversationsRequest":{"properties":{"userIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"フィルタリング対象のユーザーID","title":"Userids"},"llmAppIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"フィルタリング対象のllmアプリID","title":"Llmappids"},"categoryIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"フィルタリング対象のの会話カテゴリID","title":"Categoryids"},"conversationIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"フィルタリング対象の会話ID","title":"Conversationids"},"conversationInfo":{"$ref":"#/components/schemas/ConversationInfoRequest","description":"更新対象となる会話情報"}},"required":["conversationInfo"],"title":"SetBulkConversationsRequest","type":"object"},"ConversationInfoRequest":{"properties":{"state":{"anyOf":[{"$ref":"#/components/schemas/ConversationStateEnum"},{"type":"null"}],"description":"会話の状態"},"assignee":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"会話の担当者","title":"Assignee"},"categoryIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"カテゴリのID","title":"Categoryids"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"会話のタイトル","title":"Title"}},"title":"ConversationInfoRequest","type":"object"},"ConversationStateEnum":{"enum":["no","eb","ea","eu","wa","wu","wu2","in","pnd","eo","lck"],"title":"ConversationStateEnum","type":"string"}}}}
```

## The ChatsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ChatsResponse":{"properties":{"chats":{"items":{"$ref":"#/components/schemas/Chat"},"title":"Chats","type":"array"},"pageNo":{"title":"Pageno","type":"integer"},"totalCount":{"title":"Totalcount","type":"integer"}},"required":["chats","pageNo","totalCount"],"title":"ChatsResponse","type":"object"},"Chat":{"properties":{"id":{"description":"チャットのユニークID。","title":"Id","type":"string"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Node type of the chat","title":"Type"},"sender":{"description":"送信者の種別","title":"Sender","type":"string"},"message":{"description":"チャットメッセージ","title":"Message","type":"string"},"source":{"anyOf":[{"$ref":"#/components/schemas/ChatInputSource"},{"type":"null"}],"description":"Source of the chat"},"timestamp":{"description":"チャットメッセージ作成時のタイムスタンプ","title":"Timestamp","type":"number"},"completed":{"description":"Whether the chat generation is completed","title":"Completed","type":"boolean"},"citations":{"anyOf":[{"items":{"$ref":"#/components/schemas/Citation"},"type":"array"},{"type":"null"}],"description":"引用情報","title":"Citations"},"rating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"チャットの評価","title":"Rating"},"agentRating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"管理者の評価","title":"Agentrating"}},"required":["id","sender","message","timestamp","completed","citations","rating","agentRating"],"title":"Chat","type":"object"},"ChatInputSource":{"description":"Chat input source information in response.","properties":{"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of knowledge base IDs","title":"Knowledgebaseids"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of folder IDs","title":"Folderids"},"webSites":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of web sites","title":"Websites"},"searchAllSharedDocument":{"default":false,"description":"Search all shared documents","title":"Searchallshareddocument","type":"boolean"},"searchAllPersonalDocument":{"default":false,"description":"Search all personal documents","title":"Searchallpersonaldocument","type":"boolean"},"includingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Including hashtags","title":"Includinghashtags"},"excludingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Excluding hashtags","title":"Excludinghashtags"},"includingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Including hashtags operator","title":"Includinghashtagsoperator"},"excludingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Excluding hashtags operator","title":"Excludinghashtagsoperator"},"sharedKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Shared knowledge bases with details","title":"Sharedknowledgebases"},"sharedFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Shared folders with details","title":"Sharedfolders"},"personalKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Personal knowledge bases with details","title":"Personalknowledgebases"},"personalFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Personal folders with details","title":"Personalfolders"}},"title":"ChatInputSource","type":"object"},"KnowledgeBaseInfo":{"description":"Knowledge base information in response.","properties":{"id":{"description":"Unique ID of the knowledge base","title":"Id","type":"string"},"name":{"description":"Name of the knowledge base","title":"Name","type":"string"}},"required":["id","name"],"title":"KnowledgeBaseInfo","type":"object"},"FolderInfo":{"description":"Folder information in response.","properties":{"id":{"description":"Unique ID of the folder","title":"Id","type":"string"},"name":{"description":"Name of the folder","title":"Name","type":"string"}},"required":["id","name"],"title":"FolderInfo","type":"object"},"Citation":{"properties":{"clueId":{"description":"回答根拠ページのID","title":"Clueid","type":"string"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用元","title":"Source"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠の文書タイトル","title":"Title"},"knowledgeBaseId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠のドキュメントID","title":"Knowledgebaseid"},"pageNo":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"回答根拠ドキュメントのページ番号","title":"Pageno"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用のURL","title":"Url"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用文のテキスト","title":"Text"}},"required":["clueId"],"title":"Citation","type":"object"}}}}
```

## The ConversationRunningStatusResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ConversationRunningStatusResponse":{"properties":{"isRunning":{"description":"バックグラウンド実行ステータス","title":"Isrunning","type":"boolean"}},"required":["isRunning"],"title":"ConversationRunningStatusResponse","type":"object"}}}}
```

## The ChatDetail object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ChatDetail":{"description":"Detailed chat information compatible with LLMResponse for run_apps API response verification.\n\nExtends Chat with additional fields for verifying streaming responses from run_apps API.","properties":{"id":{"description":"Unique ID of the chat","title":"Id","type":"string"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Node type of the chat","title":"Type"},"sender":{"description":"Sender Type","title":"Sender","type":"string"},"message":{"description":"Chat message","title":"Message","type":"string"},"source":{"anyOf":[{"$ref":"#/components/schemas/ChatInputSource"},{"type":"null"}],"description":"Source of the chat"},"timestamp":{"description":"Timestamp of the chat message creation time","title":"Timestamp","type":"number"},"completed":{"description":"Whether the chat generation is completed","title":"Completed","type":"boolean"},"citations":{"anyOf":[{"items":{"$ref":"#/components/schemas/Citation"},"type":"array"},{"type":"null"}],"description":"Citations information","title":"Citations"},"rating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Rating of the chat","title":"Rating"},"agentRating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Agent rating of the chat","title":"Agentrating"},"intermediateSteps":{"anyOf":[{"items":{"$ref":"#/components/schemas/IntermediateStepResponse"},"type":"array"},{"type":"null"}],"description":"Intermediate steps during chat generation","title":"Intermediatesteps"}},"required":["id","sender","message","timestamp","completed","citations","rating","agentRating"],"title":"ChatDetail","type":"object"},"ChatInputSource":{"description":"Chat input source information in response.","properties":{"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of knowledge base IDs","title":"Knowledgebaseids"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of folder IDs","title":"Folderids"},"webSites":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"List of web sites","title":"Websites"},"searchAllSharedDocument":{"default":false,"description":"Search all shared documents","title":"Searchallshareddocument","type":"boolean"},"searchAllPersonalDocument":{"default":false,"description":"Search all personal documents","title":"Searchallpersonaldocument","type":"boolean"},"includingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Including hashtags","title":"Includinghashtags"},"excludingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Excluding hashtags","title":"Excludinghashtags"},"includingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Including hashtags operator","title":"Includinghashtagsoperator"},"excludingHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Excluding hashtags operator","title":"Excludinghashtagsoperator"},"sharedKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Shared knowledge bases with details","title":"Sharedknowledgebases"},"sharedFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Shared folders with details","title":"Sharedfolders"},"personalKnowledgeBases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseInfo"},"type":"array"},{"type":"null"}],"description":"Personal knowledge bases with details","title":"Personalknowledgebases"},"personalFolders":{"anyOf":[{"items":{"$ref":"#/components/schemas/FolderInfo"},"type":"array"},{"type":"null"}],"description":"Personal folders with details","title":"Personalfolders"}},"title":"ChatInputSource","type":"object"},"KnowledgeBaseInfo":{"description":"Knowledge base information in response.","properties":{"id":{"description":"Unique ID of the knowledge base","title":"Id","type":"string"},"name":{"description":"Name of the knowledge base","title":"Name","type":"string"}},"required":["id","name"],"title":"KnowledgeBaseInfo","type":"object"},"FolderInfo":{"description":"Folder information in response.","properties":{"id":{"description":"Unique ID of the folder","title":"Id","type":"string"},"name":{"description":"Name of the folder","title":"Name","type":"string"}},"required":["id","name"],"title":"FolderInfo","type":"object"},"Citation":{"properties":{"clueId":{"description":"回答根拠ページのID","title":"Clueid","type":"string"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用元","title":"Source"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠の文書タイトル","title":"Title"},"knowledgeBaseId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"回答根拠のドキュメントID","title":"Knowledgebaseid"},"pageNo":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"回答根拠ドキュメントのページ番号","title":"Pageno"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用のURL","title":"Url"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"引用文のテキスト","title":"Text"}},"required":["clueId"],"title":"Citation","type":"object"},"IntermediateStepResponse":{"description":"Intermediate step information for chat generation progress.","properties":{"key":{"description":"Unique key for the step","title":"Key","type":"string"},"createdAt":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Timestamp when the step was created","title":"Createdat"},"completed":{"description":"Whether the step is completed","title":"Completed","type":"boolean"},"statusMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Status message for the step","title":"Statusmessage"},"markdownMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Markdown formatted message for the step","title":"Markdownmessage"}},"required":["key","completed"],"title":"IntermediateStepResponse","type":"object"}}}}
```

## The IntermediateStepResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"IntermediateStepResponse":{"description":"Intermediate step information for chat generation progress.","properties":{"key":{"description":"Unique key for the step","title":"Key","type":"string"},"createdAt":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Timestamp when the step was created","title":"Createdat"},"completed":{"description":"Whether the step is completed","title":"Completed","type":"boolean"},"statusMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Status message for the step","title":"Statusmessage"},"markdownMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Markdown formatted message for the step","title":"Markdownmessage"}},"required":["key","completed"],"title":"IntermediateStepResponse","type":"object"}}}}
```

## The SetConversationTitleRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"SetConversationTitleRequest":{"properties":{"title":{"description":"会話のタイトル。","title":"Title","type":"string"}},"required":["title"],"title":"SetConversationTitleRequest","type":"object"}}}}
```

## The FeedbackResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"FeedbackResponse":{"properties":{"conversationId":{"title":"Conversationid","type":"string"},"chatId":{"title":"Chatid","type":"string"},"rating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rating"}},"required":["conversationId","chatId"],"title":"FeedbackResponse","type":"object"}}}}
```

## The FeedbackRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"FeedbackRequest":{"properties":{"rating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"チャットの評価","title":"Rating"},"feedbackSelection":{"anyOf":[{"items":{"$ref":"#/components/schemas/UserAnswerFeedbackSelection"},"type":"array"},{"type":"null"}],"description":"フィードバック選択","title":"Feedbackselection"},"suggestedAnswer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"提案された回答","title":"Suggestedanswer"}},"title":"FeedbackRequest","type":"object"},"UserAnswerFeedbackSelection":{"enum":["not_relevant","inaccurate","not_best_answer","wrong_intent","too_slow","low_quality","etc"],"title":"UserAnswerFeedbackSelection","type":"string"}}}}
```

## The UserAnswerFeedbackSelection object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"UserAnswerFeedbackSelection":{"enum":["not_relevant","inaccurate","not_best_answer","wrong_intent","too_slow","low_quality","etc"],"title":"UserAnswerFeedbackSelection","type":"string"}}}}
```

## The ConversationCategoriesResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ConversationCategoriesResponse":{"properties":{"categories":{"items":{"$ref":"#/components/schemas/ConversationCategoryResponse"},"title":"Categories","type":"array"}},"required":["categories"],"title":"ConversationCategoriesResponse","type":"object"},"ConversationCategoryResponse":{"properties":{"categoryId":{"description":"カテゴリID","title":"Categoryid","type":"string"},"name":{"description":"カテゴリー名","title":"Name","type":"string"}},"required":["categoryId","name"],"title":"ConversationCategoryResponse","type":"object"}}}}
```

## The ConversationCategoryResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ConversationCategoryResponse":{"properties":{"categoryId":{"description":"カテゴリID","title":"Categoryid","type":"string"},"name":{"description":"カテゴリー名","title":"Name","type":"string"}},"required":["categoryId","name"],"title":"ConversationCategoryResponse","type":"object"}}}}
```

## The CreateConversationCategoryRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"CreateConversationCategoryRequest":{"properties":{"name":{"title":"Name","type":"string"}},"required":["name"],"title":"CreateConversationCategoryRequest","type":"object"}}}}
```

## The LLMPromptDynamicInputResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMPromptDynamicInputResponse":{"properties":{"name":{"description":"動的インプット項目の名前","title":"Name","type":"string"},"variableName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"変数名","title":"Variablename"},"isClipToken":{"default":false,"description":"これがクリップトークンかどうか","title":"Iscliptoken","type":"boolean"}},"required":["name"],"title":"LLMPromptDynamicInputResponse","type":"object"}}}}
```

## The LLMPromptMessageResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMPromptMessageResponse":{"properties":{"role":{"$ref":"#/components/schemas/LLMPromptMessageRole","description":"メッセージの役割"},"content":{"description":"メッセージの内容","title":"Content","type":"string"}},"required":["role","content"],"title":"LLMPromptMessageResponse","type":"object"},"LLMPromptMessageRole":{"enum":["system","user"],"title":"LLMPromptMessageRole","type":"string"}}}}
```

## The LLMPromptMessageRole object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMPromptMessageRole":{"enum":["system","user"],"title":"LLMPromptMessageRole","type":"string"}}}}
```

## The LLMPromptResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMPromptResponse":{"properties":{"llmPromptId":{"description":"プロンプトのID","title":"Llmpromptid","type":"string"},"name":{"description":"プロンプト名","title":"Name","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"プロンプトの説明文","title":"Description"},"messages":{"description":"プロンプトの内容","items":{"$ref":"#/components/schemas/LLMPromptMessageResponse"},"title":"Messages","type":"array"},"dynamicInputs":{"description":"プロンプトの動的インプット","items":{"$ref":"#/components/schemas/LLMPromptDynamicInputResponse"},"title":"Dynamicinputs","type":"array"}},"required":["llmPromptId","name","messages","dynamicInputs"],"title":"LLMPromptResponse","type":"object"},"LLMPromptMessageResponse":{"properties":{"role":{"$ref":"#/components/schemas/LLMPromptMessageRole","description":"メッセージの役割"},"content":{"description":"メッセージの内容","title":"Content","type":"string"}},"required":["role","content"],"title":"LLMPromptMessageResponse","type":"object"},"LLMPromptMessageRole":{"enum":["system","user"],"title":"LLMPromptMessageRole","type":"string"},"LLMPromptDynamicInputResponse":{"properties":{"name":{"description":"動的インプット項目の名前","title":"Name","type":"string"},"variableName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"変数名","title":"Variablename"},"isClipToken":{"default":false,"description":"これがクリップトークンかどうか","title":"Iscliptoken","type":"boolean"}},"required":["name"],"title":"LLMPromptDynamicInputResponse","type":"object"}}}}
```

## The LLMPromptDynamicInputRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMPromptDynamicInputRequest":{"description":"リクエスト内のLLMプロンプト動的インプット用のPydanticモデル","properties":{"name":{"description":"動的入力項目の名前","title":"Name","type":"string"},"variableName":{"description":"変数名","title":"Variablename","type":"string"},"isClipToken":{"default":false,"description":"クリップトークンかどうか","title":"Iscliptoken","type":"boolean"}},"required":["name","variableName"],"title":"LLMPromptDynamicInputRequest","type":"object"}}}}
```

## The LLMPromptInfoRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMPromptInfoRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"プロンプト名","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"プロンプトの説明文","title":"Description"},"messages":{"anyOf":[{"items":{"$ref":"#/components/schemas/LLMPromptMessageRequest"},"type":"array"},{"type":"null"}],"description":"プロンプトの内容","title":"Messages"},"dynamicInputs":{"anyOf":[{"items":{"$ref":"#/components/schemas/LLMPromptDynamicInputRequest"},"type":"array"},{"type":"null"}],"description":"プロンプトの動的入力","title":"Dynamicinputs"}},"required":["name"],"title":"LLMPromptInfoRequest","type":"object"},"LLMPromptMessageRequest":{"description":"リクエスト内のLLMプロンプトメッセージ用のPydanticモデル","properties":{"role":{"$ref":"#/components/schemas/LLMPromptMessageRole","description":"メッセージの役割(システム、ユーザーなど)"},"content":{"description":"メッセージの内容。","title":"Content","type":"string"}},"required":["role","content"],"title":"LLMPromptMessageRequest","type":"object"},"LLMPromptMessageRole":{"enum":["system","user"],"title":"LLMPromptMessageRole","type":"string"},"LLMPromptDynamicInputRequest":{"description":"リクエスト内のLLMプロンプト動的インプット用のPydanticモデル","properties":{"name":{"description":"動的入力項目の名前","title":"Name","type":"string"},"variableName":{"description":"変数名","title":"Variablename","type":"string"},"isClipToken":{"default":false,"description":"クリップトークンかどうか","title":"Iscliptoken","type":"boolean"}},"required":["name","variableName"],"title":"LLMPromptDynamicInputRequest","type":"object"}}}}
```

## The LLMPromptMessageRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMPromptMessageRequest":{"description":"リクエスト内のLLMプロンプトメッセージ用のPydanticモデル","properties":{"role":{"$ref":"#/components/schemas/LLMPromptMessageRole","description":"メッセージの役割(システム、ユーザーなど)"},"content":{"description":"メッセージの内容。","title":"Content","type":"string"}},"required":["role","content"],"title":"LLMPromptMessageRequest","type":"object"},"LLMPromptMessageRole":{"enum":["system","user"],"title":"LLMPromptMessageRole","type":"string"}}}}
```

## The LLMPromptFilters object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMPromptFilters":{"properties":{"offset":{"default":0,"description":"LLMプロンプトのオフセット","title":"Offset","type":"integer"},"limit":{"default":100,"description":"LLMプロンプトの取得件数","title":"Limit","type":"integer"},"order":{"allOf":[{"enum":["modified_at","-modified_at","name","-name"],"title":"LLMPromptOrder","type":"string"}],"default":"-modified_at","description":"LLMプロンプトの並び順"}},"title":"LLMPromptFilters","type":"object"}}}}
```

## The LLMPromptOrder object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMPromptOrder":{"enum":["modified_at","-modified_at","name","-name"],"title":"LLMPromptOrder","type":"string"}}}}
```

## The DirectoryIntegrationResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"DirectoryIntegrationResponse":{"description":"ディレクトリ統合トリガーのレスポンス内容。","properties":{"success":{"description":"統合が正常に開始されたかどうか","title":"Success","type":"boolean"},"message":{"description":"レスポンスメッセージ","title":"Message","type":"string"},"task_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"操作を追跡するためのタスクID","title":"Task Id"}},"required":["success","message"],"title":"DirectoryIntegrationResponse","type":"object"}}}}
```

## The DirectoryIntegrationRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"DirectoryIntegrationRequest":{"description":"ディレクトリ統合をトリガーするためのリクエスト内容","properties":{"directory_path":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"統合するディレクトリへのパス","title":"Directory Path"},"folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"同期するフォルダのID","title":"Folder Id"}},"title":"DirectoryIntegrationRequest","type":"object"}}}}
```

## The AnalyticsSummaryMetric object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AnalyticsSummaryMetric":{"enum":["REQUEST_COUNT","CREDIT_COUNT","LLM_CALL_COUNT","ACTIVE_USER_COUNT","CREATION_COUNT","DELETION_COUNT"],"title":"AnalyticsSummaryMetric","type":"string"}}}}
```

## The AppStatisticHistoryRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"AppStatisticHistoryRequest":{"description":"LLMアプリのコール数の統計データ。","properties":{"startDate":{"description":"開始日(YYYY-MM-DD形式)","title":"Startdate","type":"string"},"endDate":{"description":"終了日(YYYY-MM-DD形式)","title":"Enddate","type":"string"},"metricName":{"allOf":[{"enum":["REQUEST_COUNT","CREDIT_COUNT","LLM_CALL_COUNT","ACTIVE_USER_COUNT","CREATION_COUNT","DELETION_COUNT"],"title":"AnalyticsSummaryMetric","type":"string"}],"default":"REQUEST_COUNT","description":"Metric name"},"llmAppId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"LLMアプリのID","title":"Llmappid"},"llmAppCategory":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"LLMアプリのカテゴリー","title":"Llmappcategory"}},"required":["startDate","endDate"],"title":"AppStatisticHistoryRequest","type":"object"}}}}
```

## The CountByPeriodResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"CountByPeriodResponse":{"description":"日付での期間別でレスポンスしたLLMのカウントの統計。","properties":{"date":{"description":"YYYY-MM-DD形式の日付","title":"Date","type":"string"},"count":{"description":"指定された日付のカウント数","title":"Count","type":"integer"}},"required":["date","count"],"title":"CountByPeriodResponse","type":"object"}}}}
```

## The HistoryResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"HistoryResponse":{"description":"利用履歴のレスポンスの統計データ","properties":{"result":{"description":"日付期間別のカウントのリスト。","items":{"$ref":"#/components/schemas/CountByPeriodResponse"},"title":"Result","type":"array"}},"required":["result"],"title":"HistoryResponse","type":"object"},"CountByPeriodResponse":{"description":"日付での期間別でレスポンスしたLLMのカウントの統計。","properties":{"date":{"description":"YYYY-MM-DD形式の日付","title":"Date","type":"string"},"count":{"description":"指定された日付のカウント数","title":"Count","type":"integer"}},"required":["date","count"],"title":"CountByPeriodResponse","type":"object"}}}}
```

## The LLMStatisticHistoryRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMStatisticHistoryRequest":{"description":"LLMコール数の統計データ。","properties":{"startDate":{"description":"開始日(YYYY-MM-DD形式)","title":"Startdate","type":"string"},"endDate":{"description":"終了日(YYYY-MM-DD形式)","title":"Enddate","type":"string"},"metricName":{"allOf":[{"enum":["successful_requests","credit","total_tokens"],"title":"LLMUsageMetric","type":"string"}],"default":"successful_requests","description":"Metric name"},"llmModel":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"LLMモデル","title":"Llmmodel"}},"required":["startDate","endDate"],"title":"LLMStatisticHistoryRequest","type":"object"}}}}
```

## The LLMUsageMetric object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMUsageMetric":{"enum":["successful_requests","credit","total_tokens"],"title":"LLMUsageMetric","type":"string"}}}}
```

## The RAGEvaluationSubmitResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RAGEvaluationSubmitResponse":{"description":"Evaluation submit response schema","properties":{"task_id":{"title":"Task Id","type":"string"},"status":{"title":"Status","type":"string"}},"required":["task_id","status"],"title":"RAGEvaluationSubmitResponse","type":"object"}}}}
```

## The RAGEvaluationRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RAGEvaluationRequest":{"description":"RAG Agent evaluation request schema\n\nEither `endpoint` or `model_name` must be provided (not both).\n\n- endpoint: OpenAI-compatible API URL (e.g., \"http://vllm-server:8000\")\n- model_name: LLMModel enum name (e.g., \"GPT4_O\", \"GPT4_O_MINI\")\n- reasoning_effort: Reasoning effort setting for the model.\n    - null/omitted: Don't send reasoning_effort parameter (default)\n    - false: Disable reasoning (\"none\")\n    - true: Enable reasoning with \"medium\" effort\n    - string: Use the specified effort level (e.g., \"low\", \"high\", \"minimal\")","properties":{"endpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint"},"model_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Name"},"subset":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subset"},"reasoning_effort":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"null"}],"title":"Reasoning Effort"}},"title":"RAGEvaluationRequest","type":"object"}}}}
```

## The RAGEvaluationStatusResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RAGEvaluationStatusResponse":{"description":"Evaluation status response schema","properties":{"task_id":{"title":"Task Id","type":"string"},"status":{"title":"Status","type":"string"},"evaluation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evaluation Id"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"}},"required":["task_id","status"],"title":"RAGEvaluationStatusResponse","type":"object"}}}}
```

## The LLMModelInfo object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMModelInfo":{"description":"LLM Model information schema","properties":{"name":{"title":"Name","type":"string"},"display_name":{"title":"Display Name","type":"string"},"provider":{"title":"Provider","type":"string"},"model_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Name"},"max_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Tokens"},"max_output_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Output Tokens"},"generally_available":{"default":false,"title":"Generally Available","type":"boolean"}},"required":["name","display_name","provider"],"title":"LLMModelInfo","type":"object"}}}}
```

## The LLMModelsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"LLMModelsResponse":{"description":"Response schema for available LLM models","properties":{"models":{"items":{"$ref":"#/components/schemas/LLMModelInfo"},"title":"Models","type":"array"},"count":{"title":"Count","type":"integer"}},"required":["models","count"],"title":"LLMModelsResponse","type":"object"},"LLMModelInfo":{"description":"LLM Model information schema","properties":{"name":{"title":"Name","type":"string"},"display_name":{"title":"Display Name","type":"string"},"provider":{"title":"Provider","type":"string"},"model_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Name"},"max_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Tokens"},"max_output_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Output Tokens"},"generally_available":{"default":false,"title":"Generally Available","type":"boolean"}},"required":["name","display_name","provider"],"title":"LLMModelInfo","type":"object"}}}}
```

## The MediaContentResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"MediaContentResponse":{"description":"Response containing base64-encoded media content.","properties":{"content":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Base64-encoded media content, or ``null`` if the media was not found.","title":"Content"}},"required":["content"],"title":"MediaContentResponse","type":"object"}}}}
```

## The MediaContentRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"MediaContentRequest":{"description":"Request body for retrieving media content.","properties":{"media_id":{"description":"The ID of the media to retrieve content for.","title":"Media Id","type":"string"},"media_type":{"default":"image","description":"The type of media to retrieve.","enum":["image","audio"],"title":"Media Type","type":"string"}},"required":["media_id"],"title":"MediaContentRequest","type":"object"}}}}
```

## The GenerateFileResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"GenerateFileResponse":{"description":"Response containing the generated file location or error details.","properties":{"fileName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the generated file.","title":"Filename"},"fileUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Download URL of the generated file.","title":"Fileurl"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Error code, present only on failure.","title":"Error"},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Human-readable error description.","title":"Errormessage"}},"title":"GenerateFileResponse","type":"object"}}}}
```

## The GenerateFileRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"GenerateFileRequest":{"description":"Request body for generating a downloadable file.","properties":{"userId":{"description":"ID of the user requesting file generation.","title":"Userid","type":"string"},"title":{"description":"Title of the generated document.","title":"Title","type":"string"},"fileFormat":{"description":"Output file format.","enum":["pdf","docx","pptx","xlsx"],"title":"Fileformat","type":"string"},"markdownText":{"description":"Markdown content to convert into the document.","title":"Markdowntext","type":"string"}},"required":["userId","title","fileFormat","markdownText"],"title":"GenerateFileRequest","type":"object"}}}}
```

## The Page object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"Page":{"properties":{"pageId":{"title":"Pageid","type":"string"},"pageNumber":{"title":"Pagenumber","type":"integer"},"content":{"title":"Content","type":"string"},"title":{"default":"","title":"Title","type":"string"}},"required":["pageId","pageNumber","content"],"title":"Page","type":"object"}}}}
```

## The RetrieveResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RetrieveResponse":{"properties":{"pages":{"items":{"$ref":"#/components/schemas/Page"},"title":"Pages","type":"array"}},"required":["pages"],"title":"RetrieveResponse","type":"object"},"Page":{"properties":{"pageId":{"title":"Pageid","type":"string"},"pageNumber":{"title":"Pagenumber","type":"integer"},"content":{"title":"Content","type":"string"},"title":{"default":"","title":"Title","type":"string"}},"required":["pageId","pageNumber","content"],"title":"Page","type":"object"}}}}
```

## The RetrieveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RetrieveRequest":{"properties":{"query":{"minLength":1,"title":"Query","type":"string"},"topN":{"default":10,"maximum":100,"minimum":1,"title":"Topn","type":"integer"},"enablePersonalFolderSearch":{"default":true,"title":"Enablepersonalfoldersearch","type":"boolean"},"enableSharedFolderSearch":{"default":true,"title":"Enablesharedfoldersearch","type":"boolean"},"personalDocumentIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Personaldocumentids"},"personalFolderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Personalfolderids"},"sharedDocumentIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Shareddocumentids"},"sharedFolderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"$ref":"#/components/schemas/TargetFolderFilter"},{"type":"null"}],"title":"Sharedfolderids"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Hashtags"},"hashtagsOperator":{"default":"or","title":"Hashtagsoperator","type":"string"},"excludeHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludehashtags"},"excludeHashtagsOperator":{"default":"or","title":"Excludehashtagsoperator","type":"string"}},"required":["query"],"title":"RetrieveRequest","type":"object"},"TargetFolderFilter":{"enum":["all","empty","no_empty"],"title":"TargetFolderFilter","type":"string"}}}}
```

## The TargetFolderFilter object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"TargetFolderFilter":{"enum":["all","empty","no_empty"],"title":"TargetFolderFilter","type":"string"}}}}
```

## The GetPagesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"GetPagesRequest":{"properties":{"kbId":{"minLength":1,"title":"Kbid","type":"string"},"offset":{"default":0,"minimum":0,"title":"Offset","type":"integer"},"limit":{"default":10,"maximum":100,"minimum":0,"title":"Limit","type":"integer"}},"required":["kbId"],"title":"GetPagesRequest","type":"object"}}}}
```

## The Document object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"Document":{"properties":{"docId":{"title":"Docid","type":"string"},"docName":{"title":"Docname","type":"string"},"totalPages":{"title":"Totalpages","type":"integer"}},"required":["docId","docName","totalPages"],"title":"Document","type":"object"}}}}
```

## The GetDocumentsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"GetDocumentsRequest":{"properties":{"kbIds":{"items":{"type":"string"},"minItems":1,"title":"Kbids","type":"array"}},"required":["kbIds"],"title":"GetDocumentsRequest","type":"object"}}}}
```

## The KnowledgeBaseFile object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"KnowledgeBaseFile":{"properties":{"kbId":{"title":"Kbid","type":"string"},"fileName":{"title":"Filename","type":"string"}},"required":["kbId","fileName"],"title":"KnowledgeBaseFile","type":"object"}}}}
```

## The SearchDocumentTitlesResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"SearchDocumentTitlesResponse":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/Document"},"title":"Documents","type":"array"}},"required":["documents"],"title":"SearchDocumentTitlesResponse","type":"object"},"Document":{"properties":{"docId":{"title":"Docid","type":"string"},"docName":{"title":"Docname","type":"string"},"totalPages":{"title":"Totalpages","type":"integer"}},"required":["docId","docName","totalPages"],"title":"Document","type":"object"}}}}
```

## The SearchDocumentTitlesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"SearchDocumentTitlesRequest":{"properties":{"query":{"minLength":1,"title":"Query","type":"string"},"topN":{"default":10,"maximum":100,"minimum":1,"title":"Topn","type":"integer"},"enablePersonalFolderSearch":{"default":true,"title":"Enablepersonalfoldersearch","type":"boolean"},"enableSharedFolderSearch":{"default":true,"title":"Enablesharedfoldersearch","type":"boolean"},"personalDocumentIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Personaldocumentids"},"personalFolderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Personalfolderids"},"sharedDocumentIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Shareddocumentids"},"sharedFolderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"$ref":"#/components/schemas/TargetFolderFilter"},{"type":"null"}],"title":"Sharedfolderids"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Hashtags"},"hashtagsOperator":{"default":"or","title":"Hashtagsoperator","type":"string"},"excludeHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludehashtags"},"excludeHashtagsOperator":{"default":"or","title":"Excludehashtagsoperator","type":"string"}},"required":["query"],"title":"SearchDocumentTitlesRequest","type":"object"},"TargetFolderFilter":{"enum":["all","empty","no_empty"],"title":"TargetFolderFilter","type":"string"}}}}
```

## The SearchResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"SearchResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/WebSearchApiResult"},"title":"Results","type":"array"}},"required":["results"],"title":"SearchResponse","type":"object"},"WebSearchApiResult":{"properties":{"id":{"title":"Id","type":"integer"},"url":{"title":"Url","type":"string"},"title":{"title":"Title","type":"string"},"snippet":{"title":"Snippet","type":"string"}},"required":["id","url","title","snippet"],"title":"WebSearchApiResult","type":"object"}}}}
```

## The WebSearchApiResult object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"WebSearchApiResult":{"properties":{"id":{"title":"Id","type":"integer"},"url":{"title":"Url","type":"string"},"title":{"title":"Title","type":"string"},"snippet":{"title":"Snippet","type":"string"}},"required":["id","url","title","snippet"],"title":"WebSearchApiResult","type":"object"}}}}
```

## The SearchRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"SearchRequest":{"properties":{"query":{"title":"Query","type":"string"},"topN":{"default":10,"title":"Topn","type":"integer"},"includeSite":{"default":"","title":"Includesite","type":"string"},"excludeSite":{"default":"","title":"Excludesite","type":"string"},"freshness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Freshness"},"useExpandedSnippet":{"default":false,"title":"Useexpandedsnippet","type":"boolean"},"expandSnippetMargin":{"default":1000,"title":"Expandsnippetmargin","type":"integer"},"expandSnippetTimeout":{"default":1,"title":"Expandsnippettimeout","type":"number"}},"required":["query"],"title":"SearchRequest","type":"object"}}}}
```

## The FetchResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"FetchResponse":{"properties":{"page":{"$ref":"#/components/schemas/WebPage"}},"required":["page"],"title":"FetchResponse","type":"object"},"WebPage":{"properties":{"url":{"title":"Url","type":"string"},"content":{"title":"Content","type":"string"}},"required":["url","content"],"title":"WebPage","type":"object"}}}}
```

## The WebPage object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"WebPage":{"properties":{"url":{"title":"Url","type":"string"},"content":{"title":"Content","type":"string"}},"required":["url","content"],"title":"WebPage","type":"object"}}}}
```

## The FetchRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"FetchRequest":{"properties":{"url":{"title":"Url","type":"string"},"timeout":{"default":5,"title":"Timeout","type":"number"}},"required":["url"],"title":"FetchRequest","type":"object"}}}}
```

## The GetSynonymsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"GetSynonymsResponse":{"properties":{"synonyms":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"title":"Synonyms","type":"object"}},"required":["synonyms"],"title":"GetSynonymsResponse","type":"object"}}}}
```

## The GetSynonymsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"GetSynonymsRequest":{"properties":{"questions":{"items":{"type":"string"},"title":"Questions","type":"array"}},"required":["questions"],"title":"GetSynonymsRequest","type":"object"}}}}
```

## The ChatCompletionsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ChatCompletionsRequest":{"properties":{"messages":{"description":"Conversation messages","items":{"$ref":"#/components/schemas/ChatMessage"},"title":"Messages","type":"array"},"model":{"default":"gpt4_o","description":"LLM model name (Mally internal name)","title":"Model","type":"string"},"temperature":{"default":0.3,"description":"Sampling temperature","title":"Temperature","type":"number"},"mode":{"default":"sync","description":"sync or stream","enum":["sync","stream"],"title":"Mode","type":"string"},"max_tokens":{"default":2048,"description":"Max completion tokens","title":"Max Tokens","type":"integer"}},"required":["messages"],"title":"ChatCompletionsRequest","type":"object"},"ChatMessage":{"properties":{"role":{"description":"Role: system, developer, user, assistant","enum":["system","developer","assistant","user"],"title":"Role","type":"string"},"content":{"description":"Message content","title":"Content","type":"string"}},"required":["role","content"],"title":"ChatMessage","type":"object"}}}}
```

## The ChatMessage object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ChatMessage":{"properties":{"role":{"description":"Role: system, developer, user, assistant","enum":["system","developer","assistant","user"],"title":"Role","type":"string"},"content":{"description":"Message content","title":"Content","type":"string"}},"required":["role","content"],"title":"ChatMessage","type":"object"}}}}
```

## The ResetScope object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"ResetScope":{"properties":{"scope":{"default":"all","title":"Scope","type":"string"}},"title":"ResetScope","type":"object"}}}}
```

## The RareStatusResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RareStatusResponse":{"properties":{"build_status":{"title":"Build Status","type":"string"},"job_status":{"title":"Job Status","type":"string"},"job_type":{"title":"Job Type","type":"string"},"build_run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Build Run Id"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"build_progress":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Build Progress"},"generate_progress":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Generate Progress"},"build_stats":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Build Stats"},"generate_stats":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Generate Stats"},"folder_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Folder Ids"},"default_model":{"default":"","title":"Default Model","type":"string"},"generation_model":{"default":"","title":"Generation Model","type":"string"}},"required":["build_status","job_status","job_type"],"title":"RareStatusResponse","type":"object"}}}}
```

## The RareJobResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RareJobResponse":{"properties":{"message":{"title":"Message","type":"string"},"task_id":{"title":"Task Id","type":"string"}},"required":["message","task_id"],"title":"RareJobResponse","type":"object"}}}}
```

## The RareBuildRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RareBuildRequest":{"properties":{"language":{"default":"Korean","title":"Language","type":"string"},"default_model":{"default":"gpt54_nano","title":"Default Model","type":"string"},"similarity_threshold":{"default":0.5,"title":"Similarity Threshold","type":"number"},"top_k_per_chunk":{"default":1,"title":"Top K Per Chunk","type":"integer"},"max_similar_items":{"default":256,"title":"Max Similar Items","type":"integer"},"max_workers":{"default":100,"title":"Max Workers","type":"integer"},"folder_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Folder Ids"}},"title":"RareBuildRequest","type":"object"}}}}
```

## The RareGenerateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RareGenerateRequest":{"properties":{"num_samples":{"default":10,"title":"Num Samples","type":"integer"},"input_pool_size":{"default":50,"title":"Input Pool Size","type":"integer"},"num_questions":{"default":10,"title":"Num Questions","type":"integer"},"num_information":{"default":2,"title":"Num Information","type":"integer"},"language":{"default":"Korean","title":"Language","type":"string"},"default_model":{"default":"gpt54_nano","title":"Default Model","type":"string"},"generation_model":{"default":"gpt54","title":"Generation Model","type":"string"},"rare_user_prompt":{"default":"","title":"Rare User Prompt","type":"string"}},"title":"RareGenerateRequest","type":"object"}}}}
```

## The RareResultItem object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RareResultItem":{"properties":{"id":{"title":"Id","type":"string"},"created_at":{"title":"Created At","type":"string"},"n_samples":{"title":"N Samples","type":"integer"},"rare_config":{"title":"Rare Config","type":"string"},"result_file_url":{"title":"Result File Url","type":"string"}},"required":["id","created_at","n_samples","rare_config","result_file_url"],"title":"RareResultItem","type":"object"}}}}
```

## The RareResultsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"RareResultsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/RareResultItem"},"title":"Results","type":"array"}},"required":["results"],"title":"RareResultsResponse","type":"object"},"RareResultItem":{"properties":{"id":{"title":"Id","type":"string"},"created_at":{"title":"Created At","type":"string"},"n_samples":{"title":"N Samples","type":"integer"},"rare_config":{"title":"Rare Config","type":"string"},"result_file_url":{"title":"Result File Url","type":"string"}},"required":["id","created_at","n_samples","rare_config","result_file_url"],"title":"RareResultItem","type":"object"}}}}
```

## The FaqChatResponse object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"FaqChatResponse":{"properties":{"answer":{"description":"봇 응답 메시지","title":"Answer","type":"string"},"conversationId":{"description":"대화 ID","title":"Conversationid","type":"string"},"faqSearchElapsed":{"description":"FAQ 검색 소요 시간 (초)","title":"Faqsearchelapsed","type":"number"},"llmElapsed":{"description":"LLM 응답 생성 소요 시간 (초)","title":"Llmelapsed","type":"number"}},"required":["answer","conversationId","faqSearchElapsed","llmElapsed"],"title":"FaqChatResponse","type":"object"}}}}
```

## The FaqChatRequest object

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"components":{"schemas":{"FaqChatRequest":{"properties":{"message":{"description":"고객 메시지","title":"Message","type":"string"},"ownUserId":{"description":"호출 주체 식별 ID (고객별 고유값)","title":"Ownuserid","type":"string"},"conversationId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"기존 대화를 이어갈 때 사용","title":"Conversationid"},"mode":{"default":"sync","description":"sync 또는 stream","enum":["sync","stream"],"title":"Mode","type":"string"},"model":{"default":"gpt5","description":"LLM 모델명","title":"Model","type":"string"}},"required":["message","ownUserId"],"title":"FaqChatRequest","type":"object"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.allganize.ai/api-reference/ja-1/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.