Amazon Kendra Tidak lagi terbuka untuk pelanggan baru. Untuk kemampuan yang mirip dengan Amazon Kendra, jelajahi Amazon Bedrock Knowledge Bases. Pelajari selengkapnya.
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Skema templat sumber data
Berikut ini adalah skema template untuk sumber data di mana template didukung.
Topik
Adobe Experience Manager skema template
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan URL Adobe
Experience Manager host, jenis otentikasi, dan apakah Anda menggunakan Adobe Experience Manager (AEM) sebagai Layanan Cloud atau AEM On-Premise sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga, tentukan jenis sumber data sebagaiAEM, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Untuk informasi selengkapnya, lihat Adobe Experience Manager Skema JSON.
Tabel berikut menjelaskan parameter skema JSON AEM.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| AEMurl | URL Adobe Experience Manager host. Misalnya, jika Anda menggunakan AEM On-Premise, Anda menyertakan nama host dan port:. https://hostname:port Atau, jika Anda menggunakan AEM as a Layanan Cloud, Anda dapat menggunakan URL penulis: https://author-xxxxxx-xxxxxxx.adobeaemcloud.com. |
| AuthType | Jenis otentikasi yang Anda gunakan, apakah Basic atauOAuth2. |
| Jenis penerapan | Jenis Adobe Experience Manager yang Anda gunakan, baik CLOUD atauON_PREMISE. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang Adobe Experience Manager halaman dan aset Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| waktu ZoneId |
Jika Anda menggunakan AEM On-Premise dan zona waktu server Anda berbeda dari zona waktu konektor atau indeks Amazon Kendra AEM, Anda dapat menentukan zona waktu server untuk menyelaraskan dengan konektor atau indeks AEM. Zona waktu default untuk AEM On-Premise adalah zona waktu konektor atau Amazon Kendra indeks AEM. Zona waktu default untuk AEM sebagai Layanan Cloud adalah Greenwich Mean Time. |
|
Daftar jalur root untuk halaman dan aset. Misalnya, jalur root untuk halaman bisa menjadi/content/subdan jalur root untuk aset bisa menjadi/content/sub/ass et1. |
| Aset Crawl | trueuntuk merayapi aset. |
| CrawlPages | trueuntuk merayapi halaman. |
|
Daftar pola ekspresi reguler untuk menyertakan halaman dan aset tertentu dalam sumber Adobe Experience Manager data Anda. Halaman dan aset yang cocok dengan pola disertakan dalam indeks. Halaman dan aset yang tidak cocok dengan pola dikecualikan dari indeks. Jika halaman atau aset cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan konten tidak disertakan dalam indeks. |
|
Daftar pola ekspresi reguler untuk mengecualikan halaman dan aset tertentu di sumber Adobe Experience Manager data Anda. Halaman dan aset yang cocok dengan pola dikecualikan dari indeks. Halaman dan aset yang tidak cocok dengan pola disertakan dalam indeks. Jika halaman atau aset cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan konten tidak disertakan dalam indeks. |
| Komponen Halaman | Daftar nama untuk komponen halaman tertentu yang ingin Anda indeks. |
| konten FragmentVariations | Daftar nama untuk variasi Fragmen Kon Adobe Experience Manager ten tertentu yang disimpan yang ingin Anda indeks. |
| jenis | Jenis sumber data. Tentukan AEM sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Adobe Experience Manager Anda. Untuk informasi tentang pasangan kunci-nilai ini, lihat Petunjuk koneksi untuk Adobe Experience Manager. |
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "aemUrl": { "type": "string", "pattern": "https:.*" }, "authType": { "type": "string", "enum": ["Basic", "OAuth2"] }, "deploymentType": { "type": "string", "enum": ["CLOUD","ON_PREMISE"] } }, "required": [ "aemUrl", "authType", "deploymentType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "asset": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "timeZoneId": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT0", "Greenwich", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROK", "Singapore", "SystemV/AST4", "SystemV/AST4ADT", "SystemV/CST6", "SystemV/CST6CDT", "SystemV/EST5", "SystemV/EST5EDT", "SystemV/HST10", "SystemV/MST7", "SystemV/MST7MDT", "SystemV/PST8", "SystemV/PST8PDT", "SystemV/YST9", "SystemV/YST9YDT", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "EST", "HST", "MST", "ACT", "AET", "AGT", "ART", "AST", "BET", "BST", "CAT", "CNT", "CST", "CTT", "EAT", "ECT", "IET", "IST", "JST", "MIT", "NET", "NST", "PLT", "PNT", "PRT", "PST", "SST", "VST" ] }, "pageRootPaths": { "type": "array", "items": { "type": "string" } }, "assetRootPaths": { "type": "array", "items": { "type": "string" } }, "crawlAssets": { "type": "boolean" }, "crawlPages": { "type": "boolean" }, "pagePathInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pagePathExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageNameInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageNameExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetPathInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetPathExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetTypeInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetTypeExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetNameInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetNameExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageComponents": { "type": "array", "items": { "type": "object" } }, "contentFragmentVariations": { "type": "array", "items": { "type": "object" } }, "cugExemptedPrincipals": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "type": { "type": "string", "pattern": "AEM" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon FSx Skema templat (Windows)
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan ID sistem file sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Anda juga harus menentukan jenis sumber data sebagaiFSX, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Amazon FSx (Windows) Skema JSON.
Tabel berikut menjelaskan parameter skema JSON Amazon FSx (Windows).
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| berkas SystemId | Pengidentifikasi sistem Amazon FSx file. Anda dapat menemukan ID sistem file Anda di dasbor Sistem File di Amazon FSx konsol. |
| berkas SystemType | Jenis sistem Amazon FSx file. Untuk digunakan Windows File
Server sebagai jenis sistem file Anda, tentukanWINDOWS. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| Semua | Daftar objek yang memetakan atribut atau nama bidang file Anda di sumber Amazon FSx data Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| adalah CrawlAcl | trueuntuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. ACL menentukan dokumen mana yang dapat diakses pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat Pemfilteran konteks pengguna. |
| Pola inklusi | Daftar pola ekspresi reguler untuk menyer takan file tertentu dalam sumber Amazon FSx data Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
| Pola pengecualian | Daftar pola ekspresi reguler untuk meng ecualikan file tertentu di sumber Amazon FSx data Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| jenis | Jenis sumber data. Untuk sumber data sistem file Windows, tentukanFSX. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "fileSystemId": { "type": "string", "pattern": "fs-.*" }, "fileSystemType": { "type": "string", "pattern": "WINDOWS" } }, "required": ["fileSystemId", "fileSystemType"] } } }, "repositoryConfigurations": { "type": "object", "properties": { "All": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] } }, "required": ["All"] }, "additionalProperties": { "type": "object", "properties": { "isCrawlAcl": { "type": "boolean" }, "exclusionPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionPatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "type" : { "type" : "string", "pattern": "FSX" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "enableIdentityCrawler", "additionalProperties", "type" ] }
Amazon FSx (NetApp ONTAP) skema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan ID sistem file dan mesin virtual penyimpanan (SVM) sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Anda juga harus menentukan jenis sumber data sebagaiFSXONTAP, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Amazon FSx (NetApp ONTAP) Skema JSON.
Tabel berikut menjelaskan parameter skema JSON Amazon FSx (NetApp ONTAP).
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| berkas SystemId | Pengidentifikasi sistem Amazon FSx file. Anda dapat menemukan ID sistem file Anda di dasbor Sistem File di Amazon FSx konsol. Untuk informasi tentang cara membuat sistem file di Amazon FSx konsol untuk NetApp ONTAP, lihat Panduan Mem ulai untuk NetApp ONTAP di Panduan FSx for ONTAP Pengguna. |
| berkas SystemType | Jenis sistem Amazon FSx file. Untuk digunakan NetApp ONTAP sebagai jenis sistem file Anda, tentukanONTAP. |
| SVMid | Pengidentifikasi mesin virtual penyimpanan (SVM) yang digunakan dengan sistem Amazon FSx file Anda untukNetApp ONTAP. Anda dapat menemukan ID SVM Anda dengan membuka dasbor Sistem File di Amazon FSx konsol, memilih ID sistem file Anda, dan kemudian memilih mesin virtual Storage. Untuk informasi tentang cara membuat sistem file di Amazon FSx konsol untukNetApp ONTAP, lihat Panduan Memulai untuk NetApp ONTAP di Panduan FSx for ONTAP Pengguna. |
| ProtokolTipe | Apakah Anda menggunakan protokol Common Internet File System (CIFS) untuk Windows, atau protokol Network File System (NFS) untuk Linux. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| file | Daftar objek yang memetakan atribut atau nama bidang file Anda di sumber Amazon FSx data Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. Nama bidang sumber data harus ada dalam metadata kustom file Anda. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| CrawlaCl | trueuntuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. ACL menentukan dokumen mana yang dapat diakses pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat Pemfilteran konteks pengguna. |
| Pola inklusi | Daftar pola ekspresi reguler untuk menyer takan file tertentu dalam sumber Amazon FSx data Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
| Pola pengecualian | Daftar pola ekspresi reguler untuk meng ecualikan file tertentu di sumber Amazon FSx data Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
| jenis | Jenis sumber data. Untuk sumber data sistem NetApp ONTAP file, tentukanFSXONTAP. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris |
Nama Sumber Daya Amazon (ARN) dari sebuah AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke sistem Amazon FSx file Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
Jika Anda menggunakan protokol NFS untuk sistem Amazon FSx file Anda, rahasia disimpan dalam struktur JSON dengan kunci berikut:
|
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "fileSystemId": { "type": "string", "pattern": "^(fs-[0-9a-f]{8,21})$" }, "fileSystemType": { "type": "string", "enum": ["ONTAP"] }, "svmId": { "type": "string", "pattern": "^(svm-[0-9a-f]{17,21})$" }, "protocolType": { "type": "string", "enum": [ "CIFS", "NFS" ] } }, "required": [ "fileSystemId", "fileSystemType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string", "pattern": "^([a-zA-Z_]{1,20})$" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string", "pattern": "^([a-zA-Z_]{1,20})$" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ], "maxItems": 50 } }, "required": [ "fieldMappings" ] } }, "required": [ "file" ] }, "additionalProperties": { "type": "object", "properties": { "crawlAcl": { "type": "boolean" }, "inclusionPatterns": { "type": "array", "items": { "type": "string", "maxLength": 30 }, "maxItems": 100 }, "exclusionPatterns": { "type": "array", "items": { "type": "string", "maxLength": 30 }, "maxItems": 100 } } }, "type": { "type": "string", "pattern": "FSXONTAP" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "secretArn": { "type": "string", "pattern": "arn:aws:secretsmanager:.*" } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "secretArn", "type" ] }
Alfresco skema template
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan ID Alfresco situs, URL repositori, URL antarmuka pengguna, jenis otentikasi, apakah Anda menggunakan cloud atau lokal, dan jenis konten yang ingin Anda jelajahi. Anda memberikan ini sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiALFRESCO, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Alfresco Skema JSON.
Tabel berikut menjelaskan parameter skema Alfresco JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| ID Situs | Pengidentifikasi situs Alfresco. |
| RepourL | URL Alfresco repositori Anda. Anda bisa mendapatkan URL repositori tersebut dari administrator Alfresco Anda. Misalnya, jika Anda menggunakan Alfresco Cloud (PaaS), URL repositori tersebut dapat berupa https://company.alfrescocloud.com. Atau, jika Anda menggunakan Alfresco On-Premises, URL repositori bisa jadi https://company-alfresco-instance.company-domain.suffix:port. |
| web AppUrl | URL antarmuka Alfresco pengguna Anda. Anda bisa mendapatkan URL antarmuka pengguna Alfresco dari administrator Alfresco Anda. Misalnya, URL antarmuka pengguna dapat berupa https://example.com. |
| repositori AdditionalProperties | Properti tambahan untuk terhubung dengan titik akhir repository/data sumber. |
| AuthType | Jenis otentikasi yang Anda gunakan, apakah OAuth2 atauBasic. |
| jenis (penyebaran) | Jenis Alfresco yang Anda gunakan, apakah PAAS atauON-PREM. |
| Tipe Crawl | Jenis konten yang ingin Anda jelajahi, apakah ASPECT (konten yang ditandai dengan 'Aspek' diAlfresco), SITE_ID (konten dalam Alfresco situs tertentu), atau ALL_SITES (konten di semua Alfresco situs Anda). |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang dokumen dan komentar Alfresco Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| Nama Aspek |
Nama 'Aspek' tertentu yang ingin Anda indeks. |
| AspectProperties |
Daftar properti konten 'Aspek' tertentu yang ingin Anda indeks. |
| mengaktifkan FineGrainedControl |
|
| adalah CrawlComment |
|
|
Daftar pola ekspresi reguler untuk menyertakan file tertentu dalam sumber Alfresco data Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan file tidak disertakan dalam indeks. |
|
Daftar pola ekspresi reguler untuk mengecualikan file tertentu di sumber Alfresco data Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan file tidak disertakan dalam indeks. |
| jenis | Jenis sumber data. Tentukan ALFRESCO sebagai jenis sumber data Anda. |
| Sekretaris |
Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Anda. Alfresco Rahasianya harus berisi struktur JSON dengan kunci berikut: Jika menggunakan otentikasi dasar:
Jika menggunakan otentikasi OAuth 2.0:
|
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "siteId": { "type": "string" }, "repoUrl": { "type": "string" }, "webAppUrl": { "type": "string" }, "repositoryAdditionalProperties": { "type": "object", "properties": { "authType": { "type": "string", "enum": [ "OAuth2", "Basic" ] }, "type": { "type": "string", "enum": [ "PAAS", "ON_PREM" ] }, "crawlType": { "type": "string", "enum": [ "ASPECT", "SITE_ID", "ALL_SITES" ] } } } } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "aspectName": { "type": "string" }, "aspectProperties": { "type": "array" }, "enableFineGrainedControl": { "type": "boolean" }, "isCrawlComment": { "type": "boolean" }, "inclusionFileNamePatterns": { "type": "array" }, "exclusionFileNamePatterns": { "type": "array" }, "inclusionFileTypePatterns": { "type": "array" }, "exclusionFileTypePatterns": { "type": "array" }, "inclusionFilePathPatterns": { "type": "array" }, "exclusionFilePathPatterns": { "type": "array" } } }, "type": { "type": "string", "pattern": "ALFRESCO" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "enableIdentityCrawler": { "type": "boolean" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "type", "secretArn" ] }
Aurora (MySQL) skema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaimysql, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Aurora (MySQL) Skema JSON.
Tabel berikut menjelaskan parameter skema JSON Aurora (MySQL).
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Aurora Skema templat (PostgreSQL)
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaipostgresql, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Aurora (PostgreSQL) Skema JSON.
Tabel berikut menjelaskan parameter skema JSON Aurora (PostgreSQL).
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon RDS Skema templat (Microsoft SQL Server)
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaisqlserver, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Amazon RDS (Microsoft SQL Server) Skema JSON.
Tabel berikut menjelaskan parameter skema JSON Amazon RDS (Microsoft SQL Server).
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon RDS (MySQL) skema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaimysql, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Amazon RDS (MySQL) Skema JSON.
Tabel berikut menjelaskan parameter skema JSON Amazon RDS (MySQL).
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon RDS Skema templat (Oracle)
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaioracle, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Amazon RDS (Oracle) Skema JSON.
Tabel berikut menjelaskan parameter skema JSON Amazon RDS (Oracle).
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon RDS Skema templat (PostgreSQL)
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaipostgresql, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Amazon RDS (PostgreSQL) Skema JSON.
Tabel berikut menjelaskan parameter skema JSON Amazon RDS (PostgreSQL).
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon S3 skema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari konfigurasi template. Anda memberikan nama bucket S3 sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiS3, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON S3.
Tabel berikut menjelaskan parameter skema Amazon S3 JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| BucketName | Nama Amazon S3 ember Anda. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
|
Daftar pola ekspresi reguler untuk menyertakan atau mengecualikan file tertentu dalam sumber Amazon S3 data Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
| acl ConfigurationFilePath | Jalur file yang mengontrol akses ke dokumen dalam Amazon Kendra indeks. |
| metadata FilesPrefix | Lokasi dalam bucket Anda untuk file metadata. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| jenis | Jenis sumber data. Tentukan S3 sebagai jenis sumber data Anda. |
| versi | Versi template yang didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "BucketName": { "type": "string" } }, "required": [ "BucketName" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING" ] }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ "document" ] }, "additionalProperties": { "type": "object", "properties": { "inclusionPatterns": { "type": "array" }, "exclusionPatterns": { "type": "array" }, "inclusionPrefixes": { "type": "array" }, "exclusionPrefixes": { "type": "array" }, "aclConfigurationFilePath": { "type": "string" }, "metadataFilesPrefix": { "type": "string" } } }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL" ] }, "type": { "type": "string", "pattern": "S3" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "type", "syncMode", "repositoryConfigurations" ] }
Amazon Kendra Skema templat Web Crawler
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek.
Anda memberikan URL titik awal atau titik awal, atau Anda dapat memberikan URL peta situs, sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Alih-alih mencantumkan semua URL secara manual, Anda dapat menyediakan jalur ke Amazon S3 bucket yang menyimpan file teks untuk daftar URL benih atau file XML peta situs, yang dapat Anda gabungkan bersama dalam file ZIP di S3.
Anda juga menentukan jenis sumber data sebagaiWEBCRAWLERV2, kredentif otentikasi situs web dan jenis otentikasi jika situs web Anda memerlukan otentikasi, dan konfigurasi lain yang diperlukan.
Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
penting
Pembuatan konektor Web Crawler v2.0 tidak didukung oleh. CloudFormation Gunakan konektor Web Crawler v1.0 jika Anda membutuhkan CloudFormation dukungan.
Saat memilih situs web untuk diindeks, Anda harus mematuhi Kebijakan Penggunaan yang Diterima Amazon
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Amazon Kendra Skema JSON Perayap Web.
Tabel berikut menjelaskan parameter skema JSON Amazon Kendra Web Crawler.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| situs MapUrls | Daftar URL peta situs untuk situs web yang ingin Anda jelajahi. Anda dapat mencantumkan hingga tiga URL peta situs. |
| s3 SeedUrl | Jalur S3 ke file teks yang menyimpan daftar URL titik awal atau titik awal. Misalnya, s3://bucket-name/directory/. Setiap URL dalam file teks harus diformat pada baris terpisah. Anda dapat mencantumkan hingga 100 URL benih dalam file. |
| s3 SiteMapUrl | Jalur S3 ke file XML sitemap. Misalnya, s3://bucket-name/directory/. Anda dapat mencantumkan hingga tiga file XML sitemap. Anda dapat menggabungkan beberapa file sitemap ke dalam file ZIP dan menyimpan file ZIP di Amazon S3 bucket Anda. |
| benih UrlConnections | Daftar URL titik awal atau titik awal untuk situs web yang ingin Anda jelajahi. Anda dapat mencantumkan hingga 100 URL benih. |
| SeedURL | URL benih atau titik awal. |
| autentikasi | Jenis otentikasi jika situs web Anda memerlukan otentikasi yang sama, jika tidak, tentukanNoAuthentication. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang halaman web dan file halaman web Anda ke nama bidang Amazon Kendra indeks. Misalnya, tag judul halaman web HTML dapat dipetakan ke bidang _document_title indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| Tarif Limit | Jumlah maksimum URL yang dirayapi per host situs web per menit. |
| maks FileSize | Ukuran maksimum (dalam MB) halaman web atau lampiran untuk di-crawl. |
| Crawl Depth | Jumlah level dari URL benih untuk merayapi. Misalnya, halaman URL seed adalah kedalaman 1 dan hyperlink apa pun di halaman ini yang juga dirayapi adalah kedalaman 2. |
| maks LinksPerUrl | Jumlah maksimum URL pada halaman web untuk disertakan saat merayapi situs web. Jumlah ini per halaman web. Saat halaman web situs web di-crawl, URL apa pun yang ditautkan ke halaman web juga akan dirayapi. URL pada halaman web dirayapi dalam urutan tampilan. |
| merangkak SubDomain | trueuntuk merayapi domain situs web dengan subdomain. Misalnya, jika URL benih adalah "abc.example.com“, maka" "dana.abc.example.com" b.abc.example.com "juga akan di-crawl. Jika Anda tidak menyet crawlSubDomain el atau crawlAllDomain ketrue, maka Amazon Kendra hanya merayapi domain situs web yang ingin Anda jelajahi. |
| merangkak AllDomain | trueuntuk merayapi domain situs web dengan subdomain dan domain lain yang ditautkan halaman web. Jika Anda tidak menyet crawlSubDomain el atau crawlAllDomain ketrue, maka Amazon Kendra hanya merayapi domain situs web yang ingin Anda jelajahi. |
| HonorRobot | trueuntuk menghormati arahan robots.txt dari situs web yang ingin Anda jelajahi. Arahan ini mengontrol bagaimana Amazon Kendra Web Crawler merayapi situs web, apakah hanya Amazon Kendra dapat merayapi konten tertentu atau tidak merayapi konten apa pun. |
| CrawlAttachments | trueuntuk merayapi file yang ditautkan ke halaman web. |
|
Daftar pola ekspresi reguler untuk menyer takan crawling URL tertentu dan pengindeksan hyperlink apa pun di halaman web URL ini. URL yang cocok dengan pola disertakan dalam indeks. URL yang tidak cocok dengan pola dikecualikan dari indeks. Jika URL cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan URL/website, dan halaman web tidak disertakan dalam indeks. |
|
Daftar pola ekspresi reguler untuk meng ecualikan crawling URL tertentu dan mengindeks hyperlink apa pun di halaman web URL ini. URL yang cocok dengan pola dikecualikan dari indeks. URL yang tidak cocok dengan pola disertakan dalam indeks. Jika URL cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan URL/website, dan halaman web tidak disertakan dalam indeks. |
| inklusi FileIndexPatterns | Daftar pola ekspresi reguler untuk menyer takan file halaman web tertentu. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan file tidak disertakan dalam indeks. |
| pengecualian FileIndexPatterns | Daftar pola ekspresi reguler untuk meng ecualikan file halaman web tertentu. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan file tidak disertakan dalam indeks. |
| implisit WaitDuration |
implisit WaitDuration menentukan berapa lama konektor akan menunggu, dalam hitungan detik, sebelum merayapi halaman web. Rentang: 0-10 misalnya. “implisit WaitDuration “: “5" |
| proxy | Informasi konfigurasi diperlukan untuk terhubung ke situs web internal Anda melalui proxy web. |
| host | Nama host dari server proxy yang ingin Anda gunakan untuk terhubung ke situs web internal. Misalnya, nama host https://a.example.com/page1.html adalah "a.example.com”. |
| port | Nomor port server proxy yang ingin Anda gunakan untuk terhubung ke situs web internal. Misalnya, 443 adalah port standar untuk HTTPS. |
| Sekretaris (proxy) | Jika kredenSIAL proxy web diperlukan untuk terhubung ke host situs web, Anda dapat membuat AWS Secrets Manager rahasia yang menyimpan kredenSIAL. Berikan Nama Sumber Daya Amazon (ARN) dari rahasia tersebut. |
| jenis | Jenis sumber data. Tentukan WEBCRAWLERV2 sebagai jenis sumber data Anda. |
| Sekretaris |
Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang digunakan jika situs web Anda memerlukan otentikasi untuk mengakses situs web. Anda menyimpan kredentif otentikasi untuk situs web dalam rahasia yang berisi pasangan kunci-nilai JSON. Jika Anda menggunakan dasar, atau NTML/Kerberos, masukkan nama pengguna dan kata sandi. Kunci JSON dalam rahasia harus Jika Anda menggunakan SAML atau otentikasi formulir, masukkan nama pengguna dan kata sandi, XPath untuk bidang nama pengguna (dan tombol nama pengguna jika menggunakan SAML), XPath untuk bidang dan tombol kata sandi, dan URL halaman login. Kunci JSON dalam rahasia harus Amazon Kendra juga memeriksa apakah informasi titik akhir (URL benih) yang disertakan dalam rahasia sama dengan informasi titik akhir yang ditentukan dalam detail konfigurasi titik akhir sumber data Anda. |
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "siteMapUrls": { "type": "array", "items":{ "type": "string", "pattern": "https://.*" } }, "s3SeedUrl": { "type": "string", "pattern": "s3:.*" }, "s3SiteMapUrl": { "type": "string", "pattern": "s3:.*" }, "seedUrlConnections": { "type": "array", "items": [ { "type": "object", "properties": { "seedUrl":{ "type": "string", "pattern": "https://.*" } }, "required": [ "seedUrl" ] } ] }, "authentication": { "type": "string", "enum": [ "NoAuthentication", "BasicAuth", "NTLM_Kerberos", "Form", "SAML" ] } } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "webPage": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "additionalProperties": { "type": "object", "properties": { "rateLimit": { "type": "string", "default": "300" }, "maxFileSize": { "type": "string", "default": "50" }, "crawlDepth": { "type": "string", "default": "2" }, "maxLinksPerUrl": { "type": "string", "default": "100" }, "crawlSubDomain": { "type": "boolean", "default": false }, "crawlAllDomain": { "type": "boolean", "default": false }, "honorRobots": { "type": "boolean", "default": false }, "crawlAttachments": { "type": "boolean", "default": false }, "inclusionURLCrawlPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionURLCrawlPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionURLIndexPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionURLIndexPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileIndexPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileIndexPatterns": { "type": "array", "items": { "type": "string" } }, "proxy": { "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "string" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } } } }, "implicitWaitDuration": { "type":"object", "properties": { "innerNumber" : { "type": "number", "minimum": 0, "maximum": 10 } } }, "required": [ "rateLimit", "maxFileSize", "crawlDepth", "crawlSubDomain", "crawlAllDomain", "maxLinksPerUrl", "honorRobots" ] }, "type": { "type": "string", "pattern": "WEBCRAWLERV2" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "type", "additionalProperties" ] }
Skema templat pertemuan
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan URL host Confluence, metode hosting, dan jenis otentikasi sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiCONFLUENCEV2, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON pertemuan.
Tabel berikut menjelaskan parameter skema JSON Confluence.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| HostURL | URL untuk instance Confluence Anda. Misalnya, https://example.confluence.com. |
| jenis | Metode hosting untuk instance Confluence Anda, apakah SAAS dan. ON_PREM |
| AuthType | Metode otentikasi untuk instance Confluence Anda, apakah, BasicOAuth2, atau. Personal-token |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang ruang Confluence, halaman, blog, komentar, dan lampiran ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. Nama bidang sumber data Confluence harus ada di metadata kustom Confluence Anda. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| adalah CrawlAcl | Konfigur true asikan untuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. Perhatikan bahwa ACL menentukan dokumen mana yang dapat diakses pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Ini berarti bahwa jika isCrawlACL dimatikan, dokumen dapat dicari secara publik. Untuk informasi selengkapnya, lihat Pemfilteran konteks pengguna. |
| bidang ForUserId | Tentukan email apakah Anda ingin menggunakan email pengguna untuk ID pengguna. emaildigunakan secara default dan saat ini merupakan satu-satunya jenis ID pengguna yang didukung. |
|
Daftar pola ekspresi reguler untuk disertakan and/or mengecualikan file tertentu dalam sumber data Confluence Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
| ProxyHost | Nama host dari proxy web yang Anda gunakan, tanpa https:// protokol http:// or. |
|
ProxyPort |
Nomor port yang digunakan oleh protokol transportasi URL host. Harus berupa nilai numerik antara 0 dan 65535. |
|
trueuntuk merayapi file di ruang pribadi Confluence Anda, halaman, blog, komentar halaman, lampiran halaman, komentar blog, dan lampiran blog. |
| maks FileSizeInMegaBytes | Tentukan batas ukuran file dalam MB yang Amazon Kendra dapat merayapi. Amazon Kendra merayapi hanya file dalam batas ukuran yang Anda tentukan. Ukuran default file adalah 50 MB. Ukuran file maksimum harus lebih besar dari 0 MB dan kurang dari atau sama dengan 50 MB. |
| jenis | Jenis sumber data. Tentukan CONFLUENCEV2 sebagai jenis sumber data Anda. |
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Mode sinkronisasi | Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari sebuah AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Confluence Anda. Untuk informasi tentang pasangan kunci-nilai ini, lihat Petunjuk koneksi untuk Confluence. |
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" }, "type": { "type": "string", "enum": [ "SAAS", "ON_PREM" ] }, "authType": { "type": "string", "enum": [ "Basic", "OAuth2", "Personal-token" ] } }, "required": [ "hostUrl", "type", "authType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "space": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "blog": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "usersAclS3FilePath": { "type": "string" }, "isCrawlAcl": { "type": "boolean" }, "fieldForUserId": { "type": "string" }, "inclusionSpaceKeyFilter": { "type": "array", "items": { "type": "string" } }, "exclusionSpaceKeyFilter": { "type": "array", "items": { "type": "string" } }, "pageTitleRegEX": { "type": "array", "items": { "type": "string" } }, "blogTitleRegEX": { "type": "array", "items": { "type": "string" } }, "commentTitleRegEX": { "type": "array", "items": { "type": "string" } }, "attachmentTitleRegEX": { "type": "array", "items": { "type": "string" } }, "isCrawlPersonalSpace": { "type": "boolean" }, "isCrawlArchivedSpace": { "type": "boolean" }, "isCrawlArchivedPage": { "type": "boolean" }, "isCrawlPage": { "type": "boolean" }, "isCrawlBlog": { "type": "boolean" }, "isCrawlPageComment": { "type": "boolean" }, "isCrawlPageAttachment": { "type": "boolean" }, "isCrawlBlogComment": { "type": "boolean" }, "isCrawlBlogAttachment": { "type": "boolean" }, "maxFileSizeInMegaBytes": { "type":"string" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUrlPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionUrlPatterns": { "type": "array", "items": { "type": "string" } }, "proxyHost": { "type": "string" }, "proxyPort": { "type": "string" } }, "required": [] }, "type": { "type": "string", "pattern": "CONFLUENCEV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skema template Dropbox
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan kunci aplikasi Dropbox, rahasia aplikasi, dan token akses sebagai bagian dari rahasia Anda yang menyimpan kredentif otentikasi Anda. Juga tentukan jenis sumber data sebagaiDROPBOX, jenis token akses yang ingin Anda gunakan (sementara atau permanen), dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON Dropbox.
Tabel berikut menjelaskan parameter skema JSON Dropbox.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. Sumber data ini tidak menentukan titik akhir direpositoryEndpointMetadata. Sebaliknya, informasi koneksi disertakan dalam AWS Secrets Manager rahasia yang Anda berikansecretArn. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang file Dropbox Anda, Dropbox Paper, dan pintasan untuk meng Amazon Kendra indeks nama bidang. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari sebuah AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Dropbox Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| adalah CrawlAcl | trueuntuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. ACL menentukan dokumen mana yang dapat diakses pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat Pemfilteran konteks pengguna. |
|
Daftar pola ekspresi reguler untuk menyer takan nama dan jenis file tertentu di sumber data Dropbox Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
|
Daftar pola ekspresi reguler untuk meng ecualikan nama dan jenis file tertentu di sumber data Dropbox Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
|
trueuntuk merayapi file di Dropbox, dokumen Dropbox Paper, templat Dropbox Paper, dan pintasan halaman web yang disimpan di Dropbox Anda. |
| jenis | Jenis sumber data. Tentukan DROPBOX sebagai jenis sumber data Anda. |
| TokenType | Tentukan jenis token akses Anda: token akses permanen atau sementara. Anda disarankan untuk membuat token akses refresh yang tidak pernah kedaluwarsa di Dropbox daripada mengandalkan token akses satu kali yang kedaluwarsa setelah 4 jam. Anda membuat aplikasi dan token akses refresh di konsol pengembang Dropbox dan memberikan token akses dalam rahasia Anda. |
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "paper": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "papert": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "shortcut": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] } } }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "isCrawlAcl": { "type": "boolean" }, "inclusionFileNamePatterns": { "type": "array" }, "exclusionFileNamePatterns": { "type": "array" }, "inclusionFileTypePatterns": { "type": "array" }, "exclusionFileTypePatterns": { "type": "array" }, "crawlFile": { "type": "boolean" }, "crawlPaper": { "type": "boolean" }, "crawlPapert": { "type": "boolean" }, "crawlShortcut": { "type": "boolean" } } }, "type": { "type": "string", "pattern": "DROPBOX" }, "tokenType": { "type": "string", "enum": [ "PERMANENT", "TEMPORARY" ] }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "additionalProperties": false, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "syncMode", "enableIdentityCrawler", "secretArn", "type", "tokenType" ] }
Skema template Drupal
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan URL host Drupal dan jenis otentikasi sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai DRUPAL, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON Drupal.
Tabel berikut menjelaskan parameter skema JSON Drupal.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| HostURL | URL host situs web Drupal Anda. Misalnya, https://<hostname>/<drupalsitename>. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. |
|
Daftar objek yang memetakan atribut atau nama bidang file Drupal Anda. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. Nama bidang sumber data Drupal harus ada di metadata kustom Drupal Anda. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
|
Daftar pola ekspresi reguler untuk memasukkan file tertentu dalam sumber data Drupal Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
|
Daftar pola ekspresi reguler untuk meng ecualikan file tertentu di sumber data Drupal Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
KontenDefinisi
|
Tentukan jenis konten yang akan di-crawl dan apakah akan merayapi komentar dan lampiran untuk jenis konten yang Anda pilih. |
| jenis | Jenis sumber data. Tentukan DRUPAL sebagai jenis sumber data Anda. |
| AuthType | Jenis otentikasi yang Anda gunakan, apakah BASIC-AUTH atauOAUTH2. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Drupal Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: Jika menggunakan otentikasi dasar:
Jika menggunakan otentikasi OAuth 2.0:
|
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" } }, "required": [ "hostUrl" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "content": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "isCrawlArticle": { "type": "boolean" }, "isCrawlBasicPage": { "type": "boolean" }, "isCrawlBasicBlock": { "type": "boolean" }, "crawlCustomContentTypesList": { "type": "array", "items": { "type": "string" } }, "crawlCustomBlockTypesList": { "type": "array", "items": { "type": "string" } }, "filePath": { "anyOf": [ { "type": "string", "pattern": "s3:.*" }, { "type": "string", "pattern": "" } ] }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "articleTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "articleTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customContentTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customContentTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "basicBlockTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "basicBlockTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customBlockTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customBlockTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "contentDefinitions": { "type": "array", "items": { "properties": { "contentType": { "type": "string" }, "fieldDefinition": { "type": "array", "items": [ { "type": "object", "properties": { "machineName": { "type": "string" }, "type": { "type": "string" } }, "required": [ "machineName", "type" ] } ] }, "isCrawlComments": { "type": "boolean" }, "isCrawlFiles": { "type": "boolean" } } }, "required": [ "contentType", "fieldDefinition", "isCrawlComments", "isCrawlFiles" ] } }, "required": [] }, "type": { "type": "string", "pattern": "DRUPAL" }, "authType": { "type": "string", "enum": [ "BASIC-AUTH", "OAUTH2" ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
GitHub skema template
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan URL GitHub host, nama organisasi, dan apakah Anda menggunakan GitHub cloud atau lokal GitHub sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiGITHUB, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat GitHub Skema JSON.
Tabel berikut menjelaskan parameter skema GitHub JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| jenis | Tentukan jenisnya sebagai salah satu SAAS atauON_PREMISE. |
| HostURL | URL GitHub host. Misalnya, jika Anda menggunakan GitHub SaaS/Enterprise Cloud: https://api.github.com. Atau, jika Anda menggunakan GitHub on- premises/Enterprise Server: https://on-prem-host-url/api/v3/. |
| Nama Organisasi | Anda dapat menemukan nama organisasi Anda saat masuk ke GitHub desktop dan pergi ke Organisasi Anda di bawah dropdown gambar profil Anda. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang GitHub konten Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| adalah CrawlAcl | trueuntuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. ACL menentukan dokumen mana yang dapat diakses dan dicari oleh pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat Pemfilteran konteks pengguna. |
| bidang ForUserId | Tentukan jenis ID pengguna yang ingin Anda gunakan untuk crawling ACL. T email entukan apakah Anda ingin menggunakan email pengguna untuk ID pengguna, atau username jika Anda ingin menggunakan nama pengguna untuk ID pengguna. Jika Anda tidak menentukan opsi maka email digunakan secara default. |
| Filter repositori | Daftar nama repositori tertentu dan nama cabang yang ingin Anda indeks. |
| CrawlRepository | trueuntuk merayapi repositori. |
| merangkak RepositoryDocuments | trueuntuk merayapi dokumen repositori. |
| CrawlisSue | trueuntuk masalah merangkak. |
| merangkak IssueComment | trueuntuk merayapi komentar masalah. |
| merangkak IssueCommentAttachment | trueuntuk merayapi lampiran komentar masalah. |
| merangkak PullRequest | trueuntuk merangkak permintaan tarik. |
| merangkak PullRequestComment | trueuntuk merayapi komentar permintaan tarik. |
| merangkak PullRequestCommentAttachment | trueuntuk merayapi lampiran komentar permintaan tarik. |
|
Daftar pola ekspresi reguler untuk menyertakan konten tertentu dalam sumber GitHub data Anda. Konten yang cocok dengan pola disertakan dalam indeks. Konten yang tidak cocok dengan pola dikecualikan dari indeks. Jika ada konten yang cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan konten tidak disertakan dalam indeks. |
|
Daftar pola ekspresi reguler untuk mengecualikan konten tertentu di sumber GitHub data Anda. Konten yang cocok dengan pola dikecualikan dari indeks. Konten yang tidak cocok dengan pola disertakan dalam indeks. Jika ada konten yang cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan konten tidak disertakan dalam indeks. |
| jenis | Jenis sumber data. Tentukan GITHUB sebagai jenis sumber data Anda. |
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris |
Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Anda. GitHub Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template ini yang saat ini didukung. |
Berikut ini adalah skema GitHub JSON:
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "type": { "type": "string" }, "hostUrl": { "type": "string", "pattern": "https://.*" }, "organizationName": { "type": "string" } }, "required": [ "type", "hostUrl", "organizationName" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "ghRepository": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghCommit": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghIssueDocument": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghIssueComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghIssueAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghPRDocument": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghPRComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghPRAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "isCrawlAcl": { "type": "boolean" }, "fieldForUserId": { "type": "string" }, "crawlRepository": { "type": "boolean" }, "crawlRepositoryDocuments": { "type": "boolean" }, "crawlIssue": { "type": "boolean" }, "crawlIssueComment": { "type": "boolean" }, "crawlIssueCommentAttachment": { "type": "boolean" }, "crawlPullRequest": { "type": "boolean" }, "crawlPullRequestComment": { "type": "boolean" }, "crawlPullRequestCommentAttachment": { "type": "boolean" }, "repositoryFilter": { "type": "array", "items": [ { "type": "object", "properties": { "repositoryName": { "type": "string" }, "branchNameList": { "type": "array", "items": { "type": "string" } } } } ] }, "inclusionFolderNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFolderNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "type": { "type": "string", "pattern": "GITHUB" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "enableIdentityCrawler" ] }
Skema template Gmail
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiGMAIL, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON Gmail.
Tabel berikut menjelaskan parameter skema JSON Gmail.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. Sumber data ini tidak menentukan titik akhir direpositoryEndpointMetadata. Sebaliknya, informasi koneksi disertakan dalam AWS Secrets Manager rahasia yang Anda berikansecretArn. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
Daftar objek yang memetakan atribut atau nama bidang pesan Gmail dan lampiran Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
|
Daftar pola ekspresi reguler untuk menyertakan atau mengecualikan pesan dengan nama subjek tertentu di sumber data Gmail Anda. File yang cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan file tidak disertakan dalam indeks. |
| sebelum DateFilter | Tentukan pesan dan lampiran yang akan disertakan sebelum tanggal tertentu. |
| setelah DateFilter | Tentukan pesan dan lampiran yang akan disertakan setelah tanggal tertentu. |
| adalah CrawlAttachment | Nilai Boolean untuk memilih apakah Anda ingin merayapi lampiran. Pesan akan di-crawl secara otomatis. |
| jenis | Jenis sumber data. Tentukan GMAIL sebagai jenis sumber data Anda. |
| harus CrawlDraftMessages | Nilai Boolean untuk memilih apakah Anda ingin merayapi draf pesan. |
| Mode sinkronisasi | Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
pentingKarena tidak ada API untuk memperbarui pesan Gmail yang dihapus secara permanen, semua konten baru, dimodifikasi, atau dihapus sinkronisasi:
Untuk menyinkronkan perubahan label sumber data Gmail dan pesan email yang dihapus secara permanen ke Amazon Kendra indeks, Anda harus menjalankan perayapan penuh secara berkala. |
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Gmail Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { } }, "repositoryConfigurations": { "type": "object", "properties": { "message": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "attachments": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING"] }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } } }, "required": [] }, "additionalProperties": { "type": "object", "properties": { "inclusionLabelNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionLabelNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAttachmentTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionAttachmentTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAttachmentNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionAttachmentNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionSubjectFilter": { "type": "array", "items": { "type": "string" } }, "exclusionSubjectFilter": { "type": "array", "items": { "type": "string" } }, "isSubjectAnd": { "type": "boolean" }, "inclusionFromFilter": { "type": "array", "items": { "type": "string" } }, "exclusionFromFilter": { "type": "array", "items": { "type": "string" } }, "inclusionToFilter": { "type": "array", "items": { "type": "string" } }, "exclusionToFilter": { "type": "array", "items": { "type": "string" } }, "inclusionCcFilter": { "type": "array", "items": { "type": "string" } }, "exclusionCcFilter": { "type": "array", "items": { "type": "string" } }, "inclusionBccFilter": { "type": "array", "items": { "type": "string" } }, "exclusionBccFilter": { "type": "array", "items": { "type": "string" } }, "beforeDateFilter": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "afterDateFilter": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "isCrawlAttachment": { "type": "boolean" }, "shouldCrawlDraftMessages": { "type": "boolean" } }, "required": [ "isCrawlAttachment", "shouldCrawlDraftMessages" ] }, "type" : { "type" : "string", "pattern": "GMAIL" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "secretArn": { "type": "string" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "syncMode", "secretArn", "type" ] }
Skema templat Google Drive
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiGOOGLEDRIVE2, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON Google Drive.
Tabel berikut menjelaskan parameter skema JSON Google Drive.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. Sumber data ini tidak menentukan titik akhir. Anda memilih jenis otentikasi Anda: serviceAccount danOAuth2. Informasi koneksi disertakan dalam AWS Secrets Manager rahasia yang Anda berikansecretArn. |
| AuthType | Pilih antara serviceAccount dan OAuth2 berdasarkan kasus penggunaan Anda. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang Google Drive Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
|
Tentukan batas ukuran file dalam MB yang Amazon Kendra harus merayapi. |
|
trueuntuk merayapi komentar di sumber data Google Drive Anda. |
|
trueuntuk meray MyDrive api dan Berbagi Drive Dengan Saya di sumber data Google Drive Anda. |
|
trueuntuk merayapi Drive Bersama di sumber data Google Drive Anda. |
| adalah CrawlAcl | trueuntuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. ACL menentukan dokumen mana yang dapat diakses dan dicari oleh pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat Pemfilteran konteks pengguna. |
|
Daftar pola ekspresi reguler untuk meng ecualikan file tertentu di sumber data Google Drive Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian diutamakan, dan file tidak disertakan dalam indeks. |
|
Daftar pola ekspresi reguler untuk menyer takan file tertentu di sumber data Google Drive Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan file tidak disertakan dalam indeks. |
| jenis | Jenis sumber data. Tentukan GOOOGLEDRIVEV2 sebagai jenis sumber data Anda. |
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Google Drive Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: Jika menggunakan otentikasi Akun Layanan Google:
Jika menggunakan otentikasi OAuth 2.0:
|
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "authType": { "type": "string", "enum": [ "serviceAccount", "OAuth2" ] } }, "required": [ "authType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "maxFileSizeInMegaBytes": { "type": "string" }, "isCrawlComment": { "type": "boolean" }, "isCrawlMyDriveAndSharedWithMe": { "type": "boolean" }, "isCrawlSharedDrives": { "type": "boolean" }, "isCrawlAcl": { "type": "boolean" }, "excludeUserAccounts": { "type": "array", "items": { "type": "string" } }, "excludeSharedDrives": { "type": "array", "items": { "type": "string" } }, "excludeMimeTypes": { "type": "array", "items": { "type": "string" } }, "includeUserAccounts": { "type": "array", "items": { "type": "string" } }, "includeSharedDrives": { "type": "array", "items": { "type": "string" } }, "includeMimeTypes": { "type": "array", "items": { "type": "string" } }, "includeTargetAudienceGroup": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFilePathFilter": { "type": "array", "items": { "type": "string" } }, "exclusionFilePathFilter": { "type": "array", "items": { "type": "string" } } } }, "type": { "type": "string", "pattern": "GOOGLEDRIVEV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skema templat IBM DB2
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaidb2, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat IBM DB2 JSON skema.
Tabel berikut menjelaskan parameter skema IBM DB2 JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skema template Microsoft Exchange
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan ID penyewa sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiMSEXCHANGE, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON Microsoft Exchange.
Tabel berikut menjelaskan parameter skema Microsoft Exchange JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| TenantID | ID penyewa Microsoft 365. Anda dapat menemukan ID tenant Anda di Properti Portal Direktori Aktif Azure atau di aplikasi OAuth Anda. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang sumber data Microsoft Exchange Anda ke bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten di sumber data Anda |
| Pola inklusi | Daftar pola ekspresi reguler untuk menyer takan file tertentu dalam sumber data Microsoft Exchange Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
| Pola pengecualian | Daftar pola ekspresi reguler untuk meng ecualikan file tertentu di sumber data Microsoft Exchange Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
|
Daftar pola ekspresi reguler untuk menyer takan pengguna tertentu dan file pengguna dalam sumber data Microsofot Exchange Anda. Pengguna yang cocok dengan pola disertakan dalam indeks. Pengguna yang tidak cocok dengan pola dikecualikan dari indeks. Jika pengguna mencocokkan pola inklusi dan pengecualian, pola pengecualian diutamakan dan pengguna tidak disertakan dalam indeks. |
|
Daftar pola ekspresi reguler untuk meng ecualikan pengguna dan file pengguna tertentu di sumber data Microsoft Exchange Anda. Pengguna yang cocok dengan pola dikecualikan dari indeks. Pengguna yang tidak cocok dengan pola disertakan dalam indeks. Jika pengguna mencocokkan pola pengecualian dan inklusi, pola pengecualian diutamakan dan pengguna tidak disertakan dalam indeks. |
| S3BucketName | Nama bucket S3 Anda jika ingin Anda gunakan. |
|
trueuntuk merayapi jenis konten ini dan mengakses informasi kontrol sumber data Microsoft Exchange Anda. |
| mulai CalendarDateTime | Anda dapat mengonfigurasi tanggal-waktu mulai tertentu untuk konten kalender Anda. |
| mengakhiri CalendarDateTime | Anda dapat mengonfigurasi tanggal-waktu akhir tertentu untuk konten kalender. |
| subjek | Anda dapat mengonfigurasi baris subjek tertentu untuk konten email Anda. |
| EmailDari | Anda dapat mengonfigurasi email tertentu untuk konten email 'Dari' atau pengirim. |
| E-mailTo | Anda dapat mengonfigurasi email tertentu untuk konten email 'Kepada' atau penerima. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| jenis | Jenis sumber data. Tentukan MSEXCHANGE sebagai jenis sumber data Anda. |
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Microsoft Exchange Anda. Ini termasuk ID klien Anda dan rahasia klien Anda yang dihasilkan saat Anda membuat aplikasi OAuth di portal Azure. |
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": ["tenantId"] } } }, "repositoryConfigurations": { "type": "object", "properties": { "email": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "DATE","LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "calendar": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "contacts": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "notes": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": ["email" ] }, "additionalProperties": { "type": "object", "properties": { "inclusionPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUsersList": { "type": "array", "items": { "type": "string", "format": "email" } }, "exclusionUsersList": { "type": "array", "items": { "type": "string", "format": "email" } }, "s3bucketName": { "type": "string" }, "inclusionUsersFileName": { "type": "string" }, "exclusionUsersFileName": { "type": "string" }, "inclusionDomainUsers": { "type": "array", "items": { "type": "string" } }, "exclusionDomainUsers": { "type": "array", "items": { "type": "string" } }, "crawlCalendar": { "type": "boolean" }, "crawlNotes": { "type": "boolean" }, "crawlContacts": { "type": "boolean" }, "crawlFolderAcl": { "type": "boolean" }, "startCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "endCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "subject": { "type": "array", "items": { "type": "string" } }, "emailFrom": { "type": "array", "items": { "type": "string", "format": "email" } }, "emailTo": { "type": "array", "items": { "type": "string", "format": "email" } } }, "required": [ ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "type" : { "type" : "string", "pattern": "MSEXCHANGE" }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skem OneDrive a template Microsoft
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan ID penyewa sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiONEDRIVEV2, dan rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema Microsoft OneDrive JSON.
Tabel berikut menjelaskan parameter skema Microsoft OneDrive JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| TenantID | ID penyewa Microsoft 365. Anda dapat menemukan ID tenant Anda di Properti Portal Direktori Aktif Azure atau di aplikasi OAuth Anda. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| file | Daftar objek yang memetakan atribut atau nama bidang OneDrive file Microsoft Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
|
Anda dapat memilih untuk mengindeks file tertentu, OneNote bagian, OneNote halaman, dan memfilter berdasarkan nama pengguna. |
| adalah UserNameOnS3 | trueuntuk menyediakan daftar nama pengguna dalam file yang disimpan dalam file Amazon S3. |
| jenis | Jenis sumber data. Tentukan ONEDRIVEV2 sebagai jenis sumber data Anda. |
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| jenis | Jenis sumber data. Tentukan ONEDRIVEV2 sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Microsoft Anda. OneDrive Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": [ "tenantId" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "userNameFilter": { "type": "array", "items": { "type": "string" } }, "userFilterPath": { "type": "string" }, "isUserNameOnS3": { "type": "boolean" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFilePathPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFilePathPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "enableIdentityCrawler": { "type": "boolean" }, "type": { "type": "string", "pattern": "ONEDRIVEV2" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skem SharePoint a template Microsoft
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan SharePoint situs URL/URLs, domain, dan juga ID penyewa jika diperlukan sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiSHAREPOINTV2, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE sebagai Jenis saat Anda memanggil CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat SharePoint Skema JSON.
Tabel berikut menjelaskan parameter skema Microsoft SharePoint JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data |
| TenantID | ID penyewa SharePoint akun Anda. |
| domain | Domain SharePoint akun Anda. |
| Siteurls | URL host SharePoint akun Anda. |
| repositori AdditionalProperties | Properti tambahan untuk terhubung dengan titik akhir repository/data sumber. |
| S3BucketName | Nama Amazon S3 bucket yang menyimpan X.509 sertifikat Azure AD yang ditandatangani sendiri. |
| Nama Sertifikat S3 | Nama X.509 sertifikat Azure AD yang ditandatangani sendiri yang disimpan di Amazon S3 bucket Anda. |
| AuthType | Jenis otentikasi yang Anda gunakan, apakah OAuth2OAuth2Certificate,OAuth2App,Basic,OAuth2_RefreshToken,NTLM, atauKerberos. |
| versi | SharePoint Versi yang Anda gunakan, apakah Server atauOnline. |
| pada PremVersion | Versi SharePoint Server yang Anda gunakan, apakah 2013 atauSubscriptionEdition. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang SharePoint konten Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
|
Daftar pola ekspresi reguler untuk konten include/exclude tertentu di sumber SharePoint data Anda. Item konten yang cocok dengan pola inklusi disertakan dalam indeks. Item konten yang tidak cocok dengan pola inklusi dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan file tidak disertakan dalam indeks. |
|
trueuntuk merayapi jenis konten ini. |
| CrawlaCl | trueuntuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. ACL menentukan dokumen mana yang dapat diakses dan dicari oleh pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat Pemfilteran konteks pengguna. |
| bidang ForUserId | T email entukan apakah Anda ingin menggunakan email pengguna untuk ID pengguna, atau userPrincipalName jika Anda ingin menggunakan nama pengguna untuk ID pengguna. Jika Anda tidak menentukan opsi maka email digunakan secara default. |
| ACLKonfigurasi | Tentukan salah ACLWithLDAPEmailFmt satuACLWithManualEmailFmt,, atauACLWithUsernameFmtM. |
| EmailDomain | Domain email. Misalnya, "amazon.com”. |
|
trueuntuk merayapi informasi pemetaan grup. |
| ProxyHost | Nama host proxy web yang Anda gunakan, tanpa protokol http://atau https://. |
| ProxyPort | Nomor port yang digunakan oleh protokol transportasi URL host. Harus berupa nilai numerik antara 0 dan 65535. |
| jenis | Tentukan SHAREPOINTV2 sebagai jenis sumber data Anda |
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Anda. SharePoint Untuk informasi tentang pasangan kunci-nilai ini, lihat Petunjuk koneksi untuk SharePoint Online dan SharePoint Server. |
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "domain": { "type": "string" }, "siteUrls": { "type": "array", "items": { "type": "string", "pattern": "https://.*" } }, "repositoryAdditionalProperties": { "type": "object", "properties": { "s3bucketName": { "type": "string" }, "s3certificateName": { "type": "string" }, "authType": { "type": "string", "enum": [ "OAuth2", "OAuth2Certificate", "OAuth2App", "Basic", "OAuth2_RefreshToken", "NTLM", "Kerberos" ] }, "version": { "type": "string", "enum": [ "Server", "Online" ] }, "onPremVersion": { "type": "string", "enum": [ "", "2013", "SubscriptionEdition" ] } }, "required": [ "authType", "version" ] } }, "required": [ "siteUrls", "domain", "repositoryAdditionalProperties" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "event": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "link": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "eventTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "pageTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "linkTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "inclusionFilePath": { "type": "array", "items": { "type": "string" } }, "exclusionFilePath": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "crawlFiles": { "type": "boolean" }, "crawlPages": { "type": "boolean" }, "crawlEvents": { "type": "boolean" }, "crawlComments": { "type": "boolean" }, "crawlLinks": { "type": "boolean" }, "crawlAttachments": { "type": "boolean" }, "crawlListData": { "type": "boolean" }, "crawlAcl": { "type": "boolean" }, "fieldForUserId": { "type": "string" }, "aclConfiguration": { "type": "string", "enum": [ "ACLWithLDAPEmailFmt", "ACLWithManualEmailFmt", "ACLWithUsernameFmt" ] }, "emailDomain": { "type": "string" }, "isCrawlLocalGroupMapping": { "type": "boolean" }, "isCrawlAdGroupMapping": { "type": "boolean" }, "proxyHost": { "type": "string" }, "proxyPort": { "type": "string" } }, "required": [ ] }, "type": { "type": "string", "pattern": "SHAREPOINTV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "enableIdentityCrawler", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skema template Microsoft SQL Server
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaisqlserver, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON Microsoft SQL Server.
Tabel berikut menjelaskan parameter skema JSON Micorosft SQL Server.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skema template Microsoft Teams
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan ID penyewa sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiMSTEAMS, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON Microsoft Teams.
Tabel berikut menjelaskan parameter skema Microsoft Teams JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| TenantID | ID penyewa Microsoft 365. Anda dapat menemukan ID tenant Anda di Properti Portal Direktori Aktif Azure atau di aplikasi OAuth Anda. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang konten Microsoft Teams Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| Model Pembayaran | Menentukan jenis model pembayaran yang akan digunakan dengan sumber data Microsoft Teams Anda. Model pembayaran Model A dibatasi untuk lisensi dan model pembayaran yang memerlukan kepatuhan keamanan. Model pembayaran Model B cocok untuk lisensi dan model pembayaran yang tidak memerlukan kepatuhan keamanan. |
|
Daftar pola ekspresi reguler untuk menyer takan konten tertentu dalam sumber data Microsoft Teams Anda. Konten yang cocok dengan pola disertakan dalam indeks. Konten yang tidak cocok dengan pola dikecualikan dari indeks. Jika konten cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan konten tidak disertakan dalam indeks. |
|
Daftar pola ekspresi reguler untuk meng ecualikan konten tertentu di sumber data Microsoft Teams Anda. Konten yang cocok dengan pola dikecualikan dari indeks. Konten yang tidak cocok dengan pola disertakan dalam indeks. Jika konten cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan konten tidak disertakan dalam indeks. |
|
trueuntuk merayapi jenis konten ini di sumber data Microsoft Teams Anda. |
| mulai CalendarDateTime | Anda dapat mengonfigurasi tanggal-waktu mulai tertentu untuk konten kalender Anda. |
| mengakhiri CalendarDateTime | Anda dapat mengonfigurasi tanggal-waktu akhir tertentu untuk konten kalender. |
| jenis | Jenis sumber data. Tentukan MSTEAMS sebagai jenis sumber data Anda. |
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Microsoft Teams Anda. Ini termasuk ID klien Anda dan rahasia klien yang dihasilkan saat Anda membuat aplikasi OAuth di portal Azure. |
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": [ "tenantId" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "chatMessage": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "chatAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "channelPost": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "channelWiki": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "channelAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "meetingChat": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "meetingFile": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "meetingNote": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "calendarMeeting": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "paymentModel": { "type": "string", "enum": [ "A", "B", "Evaluation Mode" ] }, "inclusionTeamNameFilter": { "type": "array", "items": { "type": "string" } }, "exclusionTeamNameFilter": { "type": "array", "items": { "type": "string" } }, "inclusionChannelNameFilter": { "type": "array", "items": { "type": "string" } }, "exclusionChannelNameFilter": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUserEmailFilter": { "type": "array", "items": { "type": "string" } }, "inclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "isCrawlChatMessage": { "type": "boolean" }, "isCrawlChatAttachment": { "type": "boolean" }, "isCrawlChannelPost": { "type": "boolean" }, "isCrawlChannelAttachment": { "type": "boolean" }, "isCrawlChannelWiki": { "type": "boolean" }, "isCrawlCalendarMeeting": { "type": "boolean" }, "isCrawlMeetingChat": { "type": "boolean" }, "isCrawlMeetingFile": { "type": "boolean" }, "isCrawlMeetingNote": { "type": "boolean" }, "startCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "endCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] } }, "required": [] }, "type": { "type": "string", "pattern": "MSTEAMS" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skema templat Microsoft Yammer
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiYAMMER, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE sebagai Jenis saat Anda memanggil CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini.
Tabel berikut menjelaskan parameter skema Microsoft Yammer JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. Sumber data ini tidak menentukan titik akhir direpositoryEndpointMetadata. Sebaliknya, informasi koneksi disertakan dalam AWS Secrets Manager rahasia yang Anda berikansecretArn. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang konten Microsoft Yammer ke nama bidang indeks Amazon Kendra. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
| Pola inklusi | Daftar pola ekspresi reguler untuk menyer takan file tertentu dalam sumber data Microsoft Yammer Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
| Pola pengecualian | Daftar pola ekspresi reguler untuk meng ecualikan file tertentu di sumber data Microsoft Yammer Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
| Sejak Tanggal | Anda dapat memilih untuk mengonfigurasi sinceDate parameter sehingga konektor Microsoft Yammer merayapi konten berdasarkan tertentu. sinceDate |
| komunitas NameFilter | Anda dapat memilih untuk mengindeks konten komunitas tertentu. |
|
trueuntuk merayapi pesan, lampiran pesan, dan pesan pribadi. |
| jenis | Tentukan YAMMER sebagai jenis sumber data Anda. |
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Microsoft Yammer Anda. Ini termasuk nama pengguna dan kata sandi Microsoft Yammer Anda, serta ID klien dan rahasia klien yang dihasilkan saat Anda membuat aplikasi OAuth di portal Azure. |
| menggunakan ChangeLog | trueuntuk menggunakan log perubahan Microsoft Yammer untuk menentukan dokumen mana yang perlu diperbarui dalam indeks. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "community": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "user": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "message": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "inclusionPatterns": { "type": "array" }, "exclusionPatterns": { "type": "array" }, "sinceDate": { "type": "string", "pattern": "^(19|2[0-9])[0-9]{2}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])((\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]))?$" }, "communityNameFilter": { "type": "array", "items": { "type": "string" } }, "isCrawlMessage": { "type": "boolean" }, "isCrawlAttachment": { "type": "boolean" }, "isCrawlPrivateMessage": { "type": "boolean" } }, "required": [ "sinceDate" ] }, "type": { "type": "string", "pattern": "YAMMER" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "useChangeLog": { "type": "string", "enum": [ "true", "false" ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "type", "secretArn", "syncMode" ] }
Skema template MySQL
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaimysql, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema MySQL JSON.
Tabel berikut menjelaskan parameter skema MySQL JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skema templat Oracle Database
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaioracle, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON Database Oracle.
Tabel berikut menjelaskan parameter skema JSON Oracle Database.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skema templat PostgreSQL
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Tentukan jenis sumber data sebagaiJDBC, jenis database sebagaipostgresql, rahasia untuk kredentif otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat PostgreSQL JSON skema.
Tabel berikut menjelaskan parameter skema PostgreSQL JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.
|
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
|
dokumen |
Daftar objek yang memetakan atribut atau nama bidang konten database Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| Kunci Utama | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| Kolom Tubuh | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SQLQuery | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi stempel waktu untuk mendeteksi perubahan pada konten Anda dan hanya menyinkronkan konten yang diubah. |
| Format TimeStamp | Masukkan nama kolom yang berisi format stempel waktu untuk digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| Ubah DetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| diperbolehkan UsersColumns | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| diperbolehkan GroupsColumn | Masukkan nama kolom yang berisi ID Pengguna untuk diizinkan akses ke konten. |
| SumberUriKolumn | Masukkan nama kolom yang berisi URL Sumber yang akan diindeks. |
| adalah SslEnabled | Masukkan pernyataan query SQL seperti operasi SELECT dan JOIN. Query SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai jenis sumber data Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari rahasia Manajer Rahasia yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skema templat Salesforce
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan URL host Salesforce sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiSALESFORCEV2, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Skema JSON Salesforce.
Tabel berikut menjelaskan parameter skema JSON Salesforce.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| HostURL | URL instance Salesforce yang akan diindeks. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang entitas Salesforce Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Salesforce Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: Untuk Alur KredenSIAL Klien:
Untuk Username-Password Aliran:
|
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
|
Kumpulan string yang menentukan entitas mana yang akan difilter. |
Pola inklusi
|
Daftar pola ekspresi reguler untuk menyer takan file tertentu dalam sumber data Salesforce Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
Pola pengecualian
|
Daftar pola ekspresi reguler untuk meng ecualikan file tertentu di sumber data Salesforce Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
|
trueuntuk merayapi jenis file ini di akun Salesforce Anda. |
| jenis | Jenis sumber data. Tentukan SALESFORCEV2 sebagai jenis sumber data Anda. |
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" }, "authType": { "type": "string", "enum": [ "clientCredentials", "usernamePassword" ] } }, "required": [ "hostUrl" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "account": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "contact": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "campaign": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "case": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "product": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "lead": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "contract": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "partner": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "profile": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "idea": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "pricebook": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "task": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "solution": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "user": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "knowledgeArticles": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "group": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "opportunity": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "chatter": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "customEntity": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "accountFilter":{ "type": "array", "items": { "type": "string" } }, "contactFilter":{ "type": "array", "items": { "type": "string" } }, "caseFilter":{ "type": "array", "items": { "type": "string" } }, "campaignFilter":{ "type": "array", "items": { "type": "string" } }, "contractFilter":{ "type": "array", "items": { "type": "string" } }, "groupFilter":{ "type": "array", "items": { "type": "string" } }, "leadFilter":{ "type": "array", "items": { "type": "string" } }, "productFilter":{ "type": "array", "items": { "type": "string" } }, "opportunityFilter":{ "type": "array", "items": { "type": "string" } }, "partnerFilter":{ "type": "array", "items": { "type": "string" } }, "pricebookFilter":{ "type": "array", "items": { "type": "string" } }, "ideaFilter":{ "type": "array", "items": { "type": "string" } }, "profileFilter":{ "type": "array", "items": { "type": "string" } }, "taskFilter":{ "type": "array", "items": { "type": "string" } }, "solutionFilter":{ "type": "array", "items": { "type": "string" } }, "userFilter":{ "type": "array", "items": { "type": "string" } }, "chatterFilter":{ "type": "array", "items": { "type": "string" } }, "documentFilter":{ "type": "array", "items": { "type": "string" } }, "knowledgeArticleFilter":{ "type": "array", "items": { "type": "string" } }, "customEntities":{ "type": "array", "items": { "type": "string" } }, "isCrawlAccount": { "type": "boolean" }, "isCrawlContact": { "type": "boolean" }, "isCrawlCase": { "type": "boolean" }, "isCrawlCampaign": { "type": "boolean" }, "isCrawlProduct": { "type": "boolean" }, "isCrawlLead": { "type": "boolean" }, "isCrawlContract": { "type": "boolean" }, "isCrawlPartner": { "type": "boolean" }, "isCrawlProfile": { "type": "boolean" }, "isCrawlIdea": { "type": "boolean" }, "isCrawlPricebook": { "type": "boolean" }, "isCrawlDocument": { "type": "boolean" }, "crawlSharedDocument": { "type": "boolean" }, "isCrawlGroup": { "type": "boolean" }, "isCrawlOpportunity": { "type": "boolean" }, "isCrawlChatter": { "type": "boolean" }, "isCrawlUser": { "type": "boolean" }, "isCrawlSolution":{ "type": "boolean" }, "isCrawlTask":{ "type": "boolean" }, "isCrawlAccountAttachments": { "type": "boolean" }, "isCrawlContactAttachments": { "type": "boolean" }, "isCrawlCaseAttachments": { "type": "boolean" }, "isCrawlCampaignAttachments": { "type": "boolean" }, "isCrawlLeadAttachments": { "type": "boolean" }, "isCrawlContractAttachments": { "type": "boolean" }, "isCrawlGroupAttachments": { "type": "boolean" }, "isCrawlOpportunityAttachments": { "type": "boolean" }, "isCrawlChatterAttachments": { "type": "boolean" }, "isCrawlSolutionAttachments":{ "type": "boolean" }, "isCrawlTaskAttachments":{ "type": "boolean" }, "isCrawlCustomEntityAttachments":{ "type": "boolean" }, "isCrawlKnowledgeArticles": { "type": "object", "properties": { "isCrawlDraft": { "type": "boolean" }, "isCrawlPublish": { "type": "boolean" }, "isCrawlArchived": { "type": "boolean" } } }, "inclusionDocumentFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionDocumentFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionDocumentFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionDocumentFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAccountFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionAccountFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAccountFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionAccountFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCampaignFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionCampaignFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionCampaignFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCampaignFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCaseFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCaseFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCaseFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCaseFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContactFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContactFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContactFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContactFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContractFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContractFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContractFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContractFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionLeadFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionLeadFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionLeadFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionLeadFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionOpportunityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionOpportunityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionOpportunityFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionOpportunityFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionSolutionFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionSolutionFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionSolutionFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionSolutionFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionTaskFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionTaskFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionTaskFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionTaskFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionGroupFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionGroupFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionGroupFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionGroupFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionChatterFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionChatterFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionChatterFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionChatterFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCustomEntityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCustomEntityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCustomEntityFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCustomEntityFileNamePatterns":{ "type": "array", "items": { "type": "string" } } }, "required": [] }, "enableIdentityCrawler": { "type": "boolean" }, "type": { "type": "string", "pattern": "SALESFORCEV2" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
ServiceNow skema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan URL ServiceNow host, jenis otentikasi, dan versi instance sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiSERVICENOWV2, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat ServiceNow Skema JSON.
Tabel berikut menjelaskan parameter skema ServiceNow JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| HostURL | URL ServiceNow host. Misalnya, your-domain.service-now.com. |
| AuthType | Jenis otentikasi yang Anda gunakan, apakah basicAuth atauOAuth2. |
| service now InstanceVersion | ServiceNow Versi yang Anda gunakan. Anda dapat memilih antaraTokyo,Sandiego,Rome, danOthers. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang artikel ServiceNow pengetahuan Anda, lampiran, katalog layanan, dan insiden ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. Nama bidang sumber ServiceNow data harus ada di metadata ServiceNow kustom Anda. |
| properti tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| maks FileSizeInMegaBytes | Tentukan batas ukuran file dalam MB yang akan di-crawl oleh Amazon Kendra. Amazon Kendra hanya akan merayapi file dalam batas ukuran yang Anda tentukan. Ukuran default file adalah 50 MB. Ukuran file maksimum harus lebih besar dari 0 MB dan kurang dari atau sama dengan 50 MB. |
|
Daftar pola ekspresi reguler untuk menyertakan and/or mengecualikan file tertentu dalam sumber ServiceNow data Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan dan file tidak disertakan dalam indeks. |
|
trueuntuk meray ServiceNow api artikel pengetahuan, katalog layanan, insiden, dan lampiran. |
| jenis | Jenis sumber data. Tentukan SERVICENOWV2 sebagai jenis sumber data Anda. |
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Mode sinkronisasi | Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Anda. ServiceNow Rahasianya harus berisi struktur JSON dengan kunci berikut: Jika Anda menggunakan otentikasi OAuth2, rahasia Anda harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(.service-now.com|.servicenowservices.com)$", "minLength": 1, "maxLength": 2048 }, "authType": { "type": "string", "enum": [ "basicAuth", "OAuth2" ] }, "servicenowInstanceVersion": { "type": "string", "enum": [ "Tokyo", "Sandiego", "Rome", "Others" ] } }, "required": [ "hostUrl", "authType", "servicenowInstanceVersion" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "knowledgeArticle": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "LONG", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "serviceCatalog": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "incident": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "maxFileSizeInMegaBytes": { "type": "string" }, "isCrawlKnowledgeArticle": { "type": "boolean" }, "isCrawlKnowledgeArticleAttachment": { "type": "boolean" }, "includePublicArticlesOnly": { "type": "boolean" }, "knowledgeArticleFilter": { "type": "string" }, "incidentQueryFilter": { "type": "string" }, "serviceCatalogQueryFilter": { "type": "string" }, "isCrawlServiceCatalog": { "type": "boolean" }, "isCrawlServiceCatalogAttachment": { "type": "boolean" }, "isCrawlActiveServiceCatalog": { "type": "boolean" }, "isCrawlInactiveServiceCatalog": { "type": "boolean" }, "isCrawlIncident": { "type": "boolean" }, "isCrawlIncidentAttachment": { "type": "boolean" }, "isCrawlActiveIncident": { "type": "boolean" }, "isCrawlInactiveIncident": { "type": "boolean" }, "applyACLForKnowledgeArticle": { "type": "boolean" }, "applyACLForServiceCatalog": { "type": "boolean" }, "applyACLForIncident": { "type": "boolean" }, "incidentStateType": { "type": "array", "items": { "type": "string", "enum": [ "Open", "Open - Unassigned", "Resolved", "All" ] } }, "knowledgeArticleTitleRegExp": { "type": "string" }, "serviceCatalogTitleRegExp": { "type": "string" }, "incidentTitleRegExp": { "type": "string" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "type": { "type": "string", "pattern": "SERVICENOWV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Skema template slack
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan URL host sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiSLACK, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Slack Slack Schema JSON.
Tabel berikut menjelaskan parameter skema Slack JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| ID Tim | ID tim Slack yang Anda salin dari URL halaman utama Slack Anda. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| Semua | Daftar objek yang memetakan atribut atau nama bidang Slack konten Anda ke nama bidang Amazon Kendra indeks. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| Pola inklusi | Daftar pola ekspresi reguler untuk menyertakan konten tertentu dalam sumber Slack data Anda. Konten yang cocok dengan pola disertakan dalam indeks. Konten yang tidak cocok dengan pola dikecualikan dari indeks. Jika ada konten yang cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan konten tidak disertakan dalam indeks. |
| Pola pengecualian | Daftar pola ekspresi reguler untuk mengecualikan konten tertentu di sumber Slack data Anda. Konten yang cocok dengan pola dikecualikan dari indeks. Konten yang tidak cocok dengan pola disertakan dalam indeks. Jika ada konten yang cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan konten tidak disertakan dalam indeks. |
| merangkak BotMessages | trueuntuk merayapi pesan bot. |
| EksklusiDiarsipkan | trueuntuk mengecualikan crawling pesan yang diarsipkan. |
| Jenis Percakapan | Jenis percakapan yang ingin Anda indeks apakahPUBLIC_CHANNEL,PRIVATE_CHANNEL, GROUP_MESSAGE danDIRECT_MESSAGE. |
| ChannelFilter | Jenis saluran yang ingin Anda indeks apakah private_channel ataupublic_channel. |
| SinceDate | Anda dapat memilih untuk mengonfigurasi sinceDate parameter sehingga Slack konektor merayapi konten berdasarkan tertentusinceDate. |
| Melihat kembali | Anda dapat memilih untuk mengonfigurasi lookBack parameter sehingga Slack konektor merayapi konten yang diperbarui atau dihapus hingga jumlah jam tertentu sebelum sinkronisasi konektor terakhir Anda. |
| Mode sinkronisasi |
Tentukan bagaimana Amazon Kendra harus memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara:
|
| jenis | Jenis sumber data. Tentukan SLACK sebagai jenis sumber data Anda. |
| mengaktifkan IdentityCrawler | trueuntuk menggunakan per Amazon Kendra ayap identitas untuk menyinkron identity/principal kan informasi tentang pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan perayap identitas dimatikan, Anda dapat menggunakan PutPrincipalMapping API untuk mengunggah informasi akses pengguna dan grup. |
| Sekretaris |
Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Anda. Slack Rahasianya harus berisi struktur JSON dengan kunci berikut:
|
| versi | Versi template ini yang saat ini didukung. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "teamId": { "type": "string" } }, "required": ["teamId"] } } }, "repositoryConfigurations": { "type": "object", "properties": { "All": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE","LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "exclusionPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionPatterns": { "type": "array", "items": { "type": "string" } }, "crawlBotMessages": { "type": "boolean" }, "excludeArchived": { "type": "boolean" }, "conversationType": { "type": "array", "items": { "type": "string", "enum": [ "PUBLIC_CHANNEL", "PRIVATE_CHANNEL", "GROUP_MESSAGE", "DIRECT_MESSAGE" ] } }, "channelFilter": { "type": "object", "properties": { "private_channel": { "type": "array", "items": { "type": "string" } }, "public_channel": { "type": "array", "items": { "type": "string" } } } }, "channelIdFilter": { "type": "array", "items": { "type": "string" } }, "sinceDate": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "lookBack": { "type": "string", "pattern": "^[0-9]*$" } }, "required": [ ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "type" : { "type" : "string", "pattern": "SLACK" }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type", "enableIdentityCrawler" ] }
Skema templat Zendesk
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari TemplateConfiguration objek. Anda memberikan URL host sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagaiZENDESK, rahasia untuk kredenSIAL otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan TEMPLATE Type saat Anda menelepon CreateDataSource.
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat Zendesk JSON skema.
Tabel berikut menjelaskan parameter skema Zendesk JSON.
| Konfigurasi | Deskripsi |
|---|---|
| KoneksiKonfigurasi | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositori EndpointMetadata | Informasi titik akhir untuk sumber data. |
| HostURL | URL host Zendesk. Misalnya, https://yoursubdomain.zendesk.com. |
| Konfigurasi repositori | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
|
Daftar objek yang memetakan atribut atau nama bidang tiket Zendesk ke nama bidang indeks Amazon Kendra. Untuk informasi lebih lanjut, lihat Memetakan bidang sumber data. |
| Sekretaris | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Zendesk Anda. Rahasia harus berisi struktur JSON dengan kunci berikut: URL host, ID klien, rahasia klien, nama pengguna, dan kata sandi. |
| Properti Tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
| organisasi NameFilter | Anda dapat memilih untuk mengindeks tiket yang ada dalam Organisasi tertentu. |
| SinceDate | Anda dapat memilih untuk mengonfigurasi sinceDate parameter sehingga konektor Zendesk merayapi konten berdasarkan yang spesifik. sinceDate |
| Pola inklusi | Daftar pola ekspresi reguler untuk memasukkan file tertentu dalam sumber data Zendesk Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian diutamakan, dan file tidak disertakan dalam indeks. |
| Pola pengecualian | Daftar pola ekspresi reguler untuk meng ecualikan file tertentu di sumber data Zendesk Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian diutamakan, dan file tidak disertakan dalam indeks. |
|
Masukkan "true" untuk merayapi jenis konten ini. |
| jenis | Tentukan ZENDESK sebagai jenis sumber data Anda. |
| menggunakan ChangeLog | Masukkan "true" untuk menggunakan log perubahan Zendesk untuk menentukan dokumen mana yang perlu diperbarui dalam indeks. Bergantung pada ukuran log perubahan, mungkin lebih cepat untuk memindai dokumen di Zendesk. Jika Anda menyinkronkan sumber data Zendesk dengan indeks Anda untuk pertama kalinya, semua dokumen dipindai. |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" } }, "required": [ "hostUrl" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "ticket": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "ticketComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "ticketCommentAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "article": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "communityPostComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "articleComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "articleAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "communityTopic": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] } } }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "additionalProperties": { "type": "object", "properties": { "organizationNameFilter": { "type": "array" }, "sinceDate": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$" }, "inclusionPatterns": { "type": "array" }, "exclusionPatterns": { "type": "array" }, "isCrawTicket": { "type": "string" }, "isCrawTicketComment": { "type": "string" }, "isCrawTicketCommentAttachment": { "type": "string" }, "isCrawlArticle": { "type": "string" }, "isCrawlArticleAttachment": { "type": "string" }, "isCrawlArticleComment": { "type": "string" }, "isCrawlCommunityTopic": { "type": "string" }, "isCrawlCommunityPost": { "type": "string" }, "isCrawlCommunityPostComment": { "type": "string" } } }, "type": { "type": "string", "pattern": "ZENDESK" }, "useChangeLog": { "type": "string", "enum": ["true", "false"] } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "additionalProperties": false, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "useChangeLog", "secretArn", "type" ] }
