Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Schemi di modelli di origini dati
Di seguito sono riportati gli schemi di modelli per le fonti di dati in cui sono supportati i modelli.
Argomenti
- Adobe Experience Managerschema del modello
- Amazon FSx schema del modello (Windows)
- Amazon FSx schema del modello (NetApp ONTAP)
- Alfrescoschema modello
- Aurora Schema del modello (MySQL)
- Aurora Schema del modello (PostgreSQL)
- Amazon RDS Schema del modello (Microsoft SQL Server)
- Amazon RDS Schema del modello (MySQL)
- Amazon RDS schema modello (Oracle)
- Amazon RDS Schema del modello (PostgreSQL)
- Amazon S3 schema modello
- Amazon Kendra Schema del modello Web Crawler
- Schema del modello Confluence
- Schema del modello Dropbox
- Schema del modello Drupal
- GitHub schema modello
- Schema del modello Gmail
- Schema del modello di Google Drive
- Schema del modello IBM DB2
- Schema del modello di Microsoft Exchange
- Schema OneDrive modello Microsoft
- Schema SharePoint modello Microsoft
- Schema del modello di Microsoft SQL Server
- Schema del modello Microsoft Teams
- Schema del modello di Microsoft Yammer
- Schema del modello MySQL
- Schema del modello di database Oracle
- Schema del modello PostgreSQL
- Schema del modello Salesforce
- ServiceNow schema modello
- Schema del modello Slack
- Schema del modello Zendesk
Adobe Experience Managerschema del modello
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Fornisci l'URL dell'Adobe
Experience Managerhost, il tipo di autenticazione e se utilizzi Adobe Experience Manager (AEM) come servizio cloud o AEM On-Premise come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Inoltre, specifica il tipo di origine datiAEM
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. Specificate quindi TEMPLATE
come Type
quando chiamate. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per ulteriori informazioni, consulta Adobe Experience ManagerSchema JSON.
La tabella seguente descrive i parametri dello schema AEM JSON.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
AEMUrl | L'URL dell'Adobe Experience Managerhost. Ad esempio, se utilizzi AEM On-Premise, includi il nome host e la porta:. https://hostname:port Oppure, se utilizzi AEM come servizio cloud, puoi utilizzare l'URL dell'autore:. https://author-xxxxxx-xxxxxxx.adobeaemcloud.com |
authType | Il tipo di autenticazione che usi, se Basic oOAuth2 . |
deploymentType | Il tipo di Adobe Experience Manager quello che usi, o. CLOUD ON_PREMISE |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi dei campi delle Adobe Experience Manager pagine e delle risorse per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
timeZoneId |
Se utilizzi AEM On-Premise e il fuso orario del server è diverso dal fuso orario del connettore o dell'indice Amazon Kendra AEM, puoi specificare il fuso orario del server da allineare al connettore o all'indice AEM. Il fuso orario predefinito per AEM On-Premise è il fuso orario del connettore o dell'indice AEM. Amazon Kendra Il fuso orario predefinito per AEM come servizio cloud è l'ora media di Greenwich. |
|
Un elenco di percorsi principali per pagine e risorse. Ad esempio, il percorso principale di una pagina potrebbe essere /content/sub e il percorso principale per una risorsa potrebbe essere /content/sub/asset1. |
CrawlAssets | true per eseguire la scansione delle risorse. |
Scansiona le pagine | true per eseguire la scansione delle pagine. |
|
Un elenco di modelli di espressioni regolari per includere determinate pagine e risorse nella fonte di Adobe Experience Manager dati. Le pagine e le risorse che corrispondono ai modelli sono incluse nell'indice. Le pagine e le risorse che non corrispondono ai modelli sono escluse dall'indice. Se una pagina o una risorsa corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il contenuto non è incluso nell'indice. |
|
Un elenco di modelli di espressioni regolari per escludere determinate pagine e risorse dalla fonte di Adobe Experience Manager dati. Le pagine e le risorse che corrispondono ai modelli sono escluse dall'indice. Le pagine e le risorse che non corrispondono ai modelli sono incluse nell'indice. Se una pagina o una risorsa corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il contenuto non è incluso nell'indice. |
Componenti della pagina | Un elenco di nomi per i componenti specifici della pagina che desideri indicizzare. |
contentFragmentVariations | Un elenco di nomi per le varianti specifiche salvate di Adobe Experience Manager Content Fragments che desiderate indicizzare. |
tipo | Il tipo di origine dati. Specificare AEM come tipo di origine dati. |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi ad Adobe Experience Manager. Per informazioni su queste coppie chiave-valore, consulta le istruzioni di connessione per Adobe Experience Manager. |
version | La versione di questo modello attualmente supportata. |
{ "$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 schema del modello (Windows)
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. L'ID del file system viene fornito come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. È inoltre necessario specificare il tipo di origine datiFSX
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Amazon FSx (Windows) Schema JSON.
La tabella seguente descrive i parametri dello schema JSON Amazon FSx (Windows).
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
fileSystemId | L'identificatore del Amazon FSx file system. È possibile trovare l'ID del file system nella dashboard dei file system della Amazon FSx console. |
fileSystemType | Il tipo di Amazon FSx file system. Da utilizzare Windows File
Server come tipo di file system, specificareWINDOWS . |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
Tutti | Un elenco di oggetti che mappano gli attributi o i nomi dei campi dei file nell'origine Amazon FSx dati per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
isCrawlAcl | true per eseguire la scansione delle informazioni dell'elenco di controllo degli accessi (ACL) per i documenti, se disponi di un ACL e desideri utilizzarlo per il controllo degli accessi. L'ACL specifica a quali documenti possono accedere utenti e gruppi. Le informazioni ACL vengono utilizzate per filtrare i risultati della ricerca in base all'accesso dell'utente o del relativo gruppo ai documenti. Per ulteriori informazioni, consulta Filtraggio del contesto utente. |
Modelli di inclusione | Un elenco di modelli di espressioni regolari per includere determinati file nella fonte di dati Amazon FSx . I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di esclusione sia a un modello di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
Modelli di esclusione | Un elenco di modelli di espressioni regolari per escludere determinati file nella fonte di Amazon FSx dati. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di esclusione che a uno di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
tipo | Il tipo di fonte di dati. Per le origini dati del file system Windows, specificareFSX . |
{ "$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 schema del modello (NetApp ONTAP)
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. L'ID del file system e la macchina virtuale di archiviazione (SVM) vengono forniti come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. È inoltre necessario specificare il tipo di origine datiFSXONTAP
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Amazon FSx (NetApp ONTAP) Schema JSON.
La tabella seguente descrive i parametri dello schema JSON Amazon FSx (NetApp ONTAP).
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
fileSystemId | L'identificatore del Amazon FSx file system. È possibile trovare l'ID del file system nella dashboard dei file system della Amazon FSx console. Per informazioni su come creare un file system nella Amazon FSx console per NetApp ONTAP, consulta la Guida introduttiva di NetApp ONTAP nella Guida per l'FSx for ONTAP utente. |
fileSystemType | Il tipo di Amazon FSx file system. Da utilizzare NetApp ONTAP come tipo di file system, specificareONTAP . |
SVMid | L'identificatore della macchina virtuale di archiviazione (SVM) utilizzata con il Amazon FSx file system per. NetApp ONTAP Puoi trovare il tuo ID SVM accedendo alla dashboard File Systems nella Amazon FSx console, selezionando l'ID del file system e quindi selezionando Storage virtual machines. Per informazioni su come creare un file system nella Amazon FSx console perNetApp ONTAP, consulta la Guida introduttiva di NetApp ONTAP nella Guida per l'FSx for ONTAP utente. |
Tipo di protocollo | Sia che si utilizzi il protocollo Common Internet File System (CIFS) per Windows o il protocollo Network File System (NFS) per Linux. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
file | Un elenco di oggetti che mappano gli attributi o i nomi dei campi dei file nell'origine Amazon FSx dati per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. I nomi dei campi dell'origine dati devono esistere nei metadati personalizzati dei file. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
Scansiona LACL | true per eseguire la scansione delle informazioni dell'elenco di controllo degli accessi (ACL) per i documenti, se si dispone di un ACL e si desidera utilizzarlo per il controllo degli accessi. L'ACL specifica a quali documenti possono accedere utenti e gruppi. Le informazioni ACL vengono utilizzate per filtrare i risultati della ricerca in base all'accesso dell'utente o del relativo gruppo ai documenti. Per ulteriori informazioni, consulta Filtraggio del contesto utente. |
Modelli di inclusione | Un elenco di modelli di espressioni regolari per includere determinati file nella fonte di dati Amazon FSx . I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di esclusione sia a un modello di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
Modelli di esclusione | Un elenco di modelli di espressioni regolari per escludere determinati file nella fonte di Amazon FSx dati. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di esclusione che a uno di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
tipo | Il tipo di origine dati. Per le fonti di dati del NetApp ONTAP file system, specificareFSXONTAP . |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN |
L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi al file system. Amazon FSx Il segreto deve contenere una struttura JSON con le seguenti chiavi:
Se utilizzi il protocollo NFS per il tuo Amazon FSx file system, il segreto viene archiviato in una struttura JSON con le seguenti chiavi:
|
{ "$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" ] }
Alfrescoschema modello
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Fornisci l'ID del Alfresco sito, l'URL del repository, l'URL dell'interfaccia utente, il tipo di autenticazione, se utilizzi il cloud o in locale e il tipo di contenuto che desideri sottoporre a scansione. Lo fornisci come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate inoltre il tipo di origine datiALFRESCO
, come segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta AlfrescoSchema JSON.
La tabella seguente descrive i parametri dello schema JSON di Alfresco.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
SiteID | L'identificatore del sito Alfresco. |
RepoUrl | L'URL del tuo repository. Alfresco Puoi ottenere l'URL del repository dal tuo Alfresco amministratore. Ad esempio, se utilizzi Alfresco Cloud (PaaS), l'URL del repository potrebbe essere. https://company.alfrescocloud.com Oppure, se utilizzi Alfresco On-Premises, l'URL del repository potrebbe essere. https://company-alfresco-instance.company-domain.suffix:port |
webAppUrl | L'URL della tua interfaccia Alfresco utente. Puoi ottenere l'URL Alfresco dell'interfaccia utente dal tuo Alfresco amministratore. Ad esempio, l'URL dell'interfaccia utente potrebbe essere https://example.com. |
repositoryAdditionalProperties | Proprietà aggiuntive per la connessione all'endpoint del repository/origine dati. |
authType | Il tipo di autenticazione che usi, se OAuth2 oBasic . |
tipo (distribuzione) | Il tipo di Alfresco quello che usi, se PAAS oON-PREM . |
Tipo di scansione | Il tipo di contenuto che desideri sottoporre a scansione, che si tratti di ASPECT (contenuti contrassegnati con «Aspetti» inAlfresco), SITE_ID (contenuti all'interno di un Alfresco sito specifico) o ALL_SITES (contenuti presenti in tutti i Alfresco siti). |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi dei campi dei documenti e dei commenti Alfresco ai Amazon Kendra nomi dei campi indicizzati. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
Nome dell'aspetto |
Il nome di un 'Aspect' specifico che desideri indicizzare. |
Proprietà dell'aspetto |
Un elenco di proprietà di contenuto specifiche di «Aspect» che desideri indicizzare. |
enableFineGrainedControllo |
|
isCrawlComment |
|
|
Un elenco di modelli di espressioni regolari per includere determinati file nella fonte di Alfresco dati. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di inclusione che di esclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
|
Un elenco di modelli di espressioni regolari per escludere determinati file nella fonte di Alfresco dati. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
tipo | Il tipo di origine dati. Specificare ALFRESCO come tipo di origine dati. |
Segretario ARN |
L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi al tuo. Alfresco Il segreto deve contenere una struttura JSON con le seguenti chiavi: Se utilizzi l'autenticazione di base:
Se si utilizza l'autenticazione OAuth 2.0:
|
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
version | La versione di questo modello attualmente supportata. |
{ "$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 Schema del modello (MySQL)
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Specificate il tipo di origine dati comeJDBC
, il tipo di database comemysql
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Aurora Schema JSON (MySQL).
La tabella seguente descrive i parametri dello schema JSON Aurora (MySQL).
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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 Schema del modello (PostgreSQL)
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Specificate il tipo di origine dati comeJDBC
, il tipo di database comepostgresql
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Aurora Schema JSON (PostgreSQL).
La tabella seguente descrive i parametri dello schema Aurora JSON (PostgreSQL).
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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 Schema del modello (Microsoft SQL Server)
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Specificate il tipo di origine dati comeJDBC
, il tipo di database comesqlserver
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Amazon RDS Schema JSON (Microsoft SQL Server).
La tabella seguente descrive i parametri dello schema JSON Amazon RDS (Microsoft SQL Server).
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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 Schema del modello (MySQL)
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Specificate il tipo di origine dati comeJDBC
, il tipo di database comemysql
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Amazon RDS Schema JSON (MySQL).
La tabella seguente descrive i parametri dello schema JSON Amazon RDS (MySQL).
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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 schema modello (Oracle)
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Specificate il tipo di origine dati comeJDBC
, il tipo di database comeoracle
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Amazon RDS Schema JSON (Oracle).
La tabella seguente descrive i parametri dello schema JSON Amazon RDS (Oracle).
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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 Schema del modello (PostgreSQL)
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Specificate il tipo di origine dati comeJDBC
, il tipo di database comepostgresql
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Amazon RDS Schema JSON (PostgreSQL).
La tabella seguente descrive i parametri dello schema Amazon RDS JSON (PostgreSQL).
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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 schema modello
Includi un JSON che contiene lo schema dell'origine dati come parte della configurazione del modello. Fornisci il nome del bucket S3 come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate anche il tipo di origine dati e le altre configurazioni S3
necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama CreateDataSource.
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON S3.
La tabella seguente descrive i parametri dello schema Amazon S3 JSON.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
BucketName | Il nome del tuo Amazon S3 bucket. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati |
|
Un elenco di modelli di espressioni regolari per includere o escludere file specifici nella fonte di dati. Amazon S3 I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di esclusione sia a un modello di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
aclConfigurationFilePercorso | Il percorso del file che controlla l'accesso ai documenti in un Amazon Kendra indice. |
metadataFilesPrefix | La posizione all'interno del bucket per i file di metadati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
tipo | Il tipo di fonte di dati. Specificare S3 come tipo di origine dati. |
version | La versione del modello supportata. |
{ "$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 Schema del modello Web Crawler
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration
Fornisci gli URL iniziali o del punto di partenza oppure puoi fornire gli URL della mappa del sito, come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Invece di elencare manualmente tutti gli URL, puoi fornire il percorso del Amazon S3 bucket che memorizza un file di testo per l'elenco di URL iniziali o file XML della mappa del sito, che puoi raggruppare in un file ZIP in S3.
Specificate anche il tipo di origine datiWEBCRAWLERV2
, come le credenziali di autenticazione del sito Web e il tipo di autenticazione se i siti Web richiedono l'autenticazione e altre configurazioni necessarie.
È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Importante
La creazione di connettori Web Crawler v2.0 non è supportata da. AWS CloudFormation Utilizza il connettore Web Crawler v1.0 se hai bisogno di assistenza. AWS CloudFormation
Quando selezioni i siti Web da indicizzare, devi rispettare la Policy di uso accettabile di Amazon
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Amazon Kendra Schema JSON di Web Crawler.
La tabella seguente descrive i parametri dello schema JSON di Amazon Kendra Web Crawler.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
siteMapUrls | L'elenco degli URL della mappa del sito per i siti Web di cui desideri eseguire la scansione. Puoi elencare fino a tre URL di mappa del sito. |
s3 SeedUrl | Il percorso S3 del file di testo che memorizza l'elenco degli URL iniziali o dei punti di partenza. Ad esempio, s3://bucket-name/directory/. Ogni URL nel file di testo deve essere formattato su una riga separata. Puoi elencare fino a 100 URL iniziali in un file. |
s3 SiteMapUrl | Il percorso S3 dei file XML della mappa del sito. Ad esempio, s3://bucket-name/directory/. Puoi elencare fino a tre file XML della mappa del sito. Puoi raggruppare più file Sitemap in un file ZIP e archiviare il file ZIP nel tuo Amazon S3 bucket. |
seedUrlConnections | L'elenco degli URL iniziali o dei punti di partenza per i siti Web che desideri scansionare. Puoi elencare fino a 100 URL iniziali. |
Vedi URL | L'URL del seme o del punto di partenza. |
autenticazione | Il tipo di autenticazione se i tuoi siti web richiedono la stessa autenticazione, altrimenti specificaNoAuthentication . |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi dei campi delle pagine Web e dei file di pagine Web per Amazon Kendra indicizzare i nomi dei campi. Ad esempio, il tag del titolo della pagina Web HTML può essere mappato al campo dell'_document_title indice. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
Limite di velocità | Il numero massimo di URL di cui viene eseguita la ricerca per indicizzazione per host di sito Web al minuto. |
maxFileSize | La dimensione massima (in MB) di una pagina Web o di un allegato da sottoporre a scansione. |
Profondità di scansione | Il numero di livelli dall'URL iniziale a cui sottoporre a scansione. Ad esempio, la pagina URL iniziale ha la profondità 1 e tutti i collegamenti ipertestuali di questa pagina che vengono sottoposti a scansione hanno la profondità 2. |
maxLinksPerUrl | Il numero massimo di URL su una pagina Web da includere durante la scansione di un sito Web. Questo numero è per pagina Web. Quando si esegue la scansione delle pagine Web di un sito Web, vengono sottoposti a scansione anche tutti gli URL a cui le pagine Web rimandano. Gli URL di una pagina Web vengono sottoposti a scansione in ordine di visualizzazione. |
crawlSubDomain | true per eseguire la scansione dei domini del sito Web con sottodomini. Ad esempio, se l'URL iniziale è "abc.example.com«, vengono sottoposti a scansione anche" a.abc.example.com "e" b.abc.example.com ". Se non lo imposti crawlSubDomain o crawlAllDomain non lo faitrue , esegue la scansione Amazon Kendra solo dei domini dei siti web che desideri sottoporre a scansione. |
crawlAllDomain | true per eseguire la scansione dei domini dei siti Web con sottodomini e altri domini a cui si collegano le pagine Web. Se non lo imposti crawlSubDomain o non lo faitrue , esegue crawlAllDomain la scansione Amazon Kendra solo dei domini dei siti Web di cui desideri eseguire la scansione. |
HonorRobots | true per rispettare le direttive robots.txt dei siti Web di cui si desidera eseguire la scansione. Queste direttive controllano il modo in cui Amazon Kendra Web Crawler esegue la scansione dei siti Web, se Amazon Kendra può eseguire la scansione solo di contenuti specifici o non eseguire la scansione di alcun contenuto. |
CrawlAttachments | true per eseguire la scansione dei file a cui si collegano le pagine Web. |
|
Un elenco di modelli di espressioni regolari che includono la scansione di determinati URL e l'indicizzazione di eventuali collegamenti ipertestuali su queste pagine Web con URL. Gli URL che corrispondono ai modelli sono inclusi nell'indice. Gli URL che non corrispondono ai modelli sono esclusi dall'indice. Se un URL corrisponde sia a un modello di inclusione che di esclusione, il modello di esclusione ha la precedenza e le pagine Web dell'URL/sito Web non sono incluse nell'indice. |
|
Un elenco di modelli di espressioni regolari per escludere la scansione di determinati URL e l'indicizzazione di eventuali collegamenti ipertestuali su queste pagine Web con URL. Gli URL che corrispondono ai modelli sono esclusi dall'indice. Gli URL che non corrispondono ai modelli sono inclusi nell'indice. Se un URL corrisponde sia a un modello di inclusione che di esclusione, il modello di esclusione ha la precedenza e le pagine Web dell'URL/sito Web non sono incluse nell'indice. |
inclusionFileIndexSchemi | Un elenco di modelli di espressioni regolari per includere determinati file di pagine Web. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di inclusione che di esclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
exclusionFileIndexSchemi | Un elenco di modelli di espressioni regolari per escludere determinati file di pagine Web. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
proxy | Informazioni sulla configurazione richiesta per effettuare la connessione ai siti Web interni tramite un proxy Web. |
host | Il nome host del server proxy che desideri utilizzare per connetterti ai siti Web interni. Ad esempio, il nome host di https://a.example.com/page1.htmlè "a.example.com». |
port | Il numero di porta del server proxy che desideri utilizzare per connetterti ai siti Web interni. Ad esempio, 443 è la porta standard per HTTPS. |
SecretArn (proxy) | Se sono necessarie le credenziali del proxy Web per connettersi all'host di un sito Web, è possibile creare un AWS Secrets Manager segreto che memorizza le credenziali. Fornisci l'Amazon Resource Name (ARN) del segreto. |
tipo | Il tipo di origine dati. Specificare WEBCRAWLERV2 come tipo di origine dati. |
Segretario ARN |
L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto utilizzato se i tuoi siti Web richiedono l'autenticazione per accedere ai siti Web. Memorizzi le credenziali di autenticazione per il sito Web nel segreto che contiene coppie chiave-valore JSON. Se utilizzi basic o NTML/Kerberos, inserisci il nome utente e la password. Le chiavi JSON nel segreto devono essere e. Se utilizzi SAML o l'autenticazione tramite modulo, inserisci il nome utente e la password, XPath per il campo del nome utente (e il pulsante del nome utente se usi SAML), XPaths per il campo e il pulsante della password e l'URL della pagina di accesso. Le chiavi JSON nel segreto devono essere Amazon Kendra verifica inoltre se le informazioni sull'endpoint (URL iniziali) incluse nel segreto sono le stesse informazioni sull'endpoint specificate nei dettagli di configurazione dell'endpoint dell'origine dati. |
version | La versione di questo modello attualmente supportata. |
{ "$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 } } } }, "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" ] }
Schema del modello Confluence
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Fornisci l'URL dell'host Confluence, il metodo di hosting e il tipo di autenticazione come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate anche il tipo di origine datiCONFLUENCEV2
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Confluence.
La tabella seguente descrive i parametri dello schema JSON di Confluence.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
HostUrl | L'URL per la tua istanza Confluence. Ad esempio, https://example.confluence.com. |
tipo | Il metodo di hosting per l'istanza Confluence, se SAAS e. ON_PREM |
authType | Il metodo di autenticazione per l'istanza di Confluence, ifBasic , OAuth2 or. Personal-token |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi dei campi degli spazi, delle pagine, dei blog, dei commenti e degli allegati di Confluence ai Amazon Kendra nomi dei campi indice. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. I nomi dei campi dell'origine dei dati Confluence devono essere presenti nei metadati personalizzati di Confluence. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
isCrawlAcl | true per eseguire la scansione delle informazioni dell'elenco di controllo degli accessi (ACL) per i documenti, se disponi di un ACL e desideri utilizzarlo per il controllo degli accessi. L'ACL specifica a quali documenti possono accedere utenti e gruppi. Le informazioni ACL vengono utilizzate per filtrare i risultati della ricerca in base all'accesso dell'utente o del relativo gruppo ai documenti. Per ulteriori informazioni, consulta Filtraggio del contesto utente. |
fieldForUserId | Specificare email se si desidera utilizzare l'e-mail dell'utente come ID utente. email viene utilizzato per impostazione predefinita ed è attualmente l'unico tipo di ID utente supportato. |
|
Un elenco di modelli di espressioni regolari per includere e/o escludere determinati file nella fonte dati Confluence. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di esclusione sia a un modello di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
ProxyHost | Il nome host del proxy web che utilizzi, senza il protocollo http:// orhttps:// . |
ProxyPort |
Il numero di porta utilizzato dal protocollo di trasporto dell'URL dell'host. Deve essere un valore numerico compreso tra 0 e 65535. |
|
true per eseguire la scansione dei file negli spazi personali, nelle pagine, nei blog, nei commenti alle pagine, negli allegati delle pagine, nei commenti e negli allegati del blog di Confluence. |
maxFileSizeInMegaBytes | Specificate il limite di dimensione del file in MB che può essere sottoposto a scansione. Amazon Kendra Amazon Kendra esegue la scansione solo dei file entro il limite di dimensione definito. La dimensione predefinita del file è 50 MB. La dimensione massima del file deve essere superiore a 0 MB e inferiore o uguale a 50 MB. |
tipo | Il tipo di origine dati. Specificare CONFLUENCEV2 come tipo di origine dati. |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
SyncMode | Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi a Confluence. Per informazioni su queste coppie chiave-valore, consulta le istruzioni di connessione per Confluence. |
version | La versione di questo modello attualmente supportata. |
{ "$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" ] }
Schema del modello Dropbox
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Fornisci la chiave dell'app Dropbox, il segreto dell'app e il token di accesso come parte del segreto che memorizza le tue credenziali di autenticazione. Specificate inoltre il tipo di origine datiDROPBOX
, il tipo di token di accesso che desiderate utilizzare (temporaneo o permanente) e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama CreateDataSource.
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Dropbox.
La tabella seguente descrive i parametri dello schema JSON di Dropbox.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. Questa fonte di dati non specifica un endpoint in. repositoryEndpointMetadata Piuttosto, le informazioni di connessione sono incluse in un AWS Secrets Manager segreto fornito dall'secretArn utente. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi dei campi dei tuoi file Dropbox, Dropbox Paper e scorciatoie per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
Secretarn | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi al tuo Dropbox. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
isCrawlAcl | true per eseguire la scansione delle informazioni dell'elenco di controllo degli accessi (ACL) per i documenti, se disponi di un ACL e desideri utilizzarlo per il controllo degli accessi. L'ACL specifica a quali documenti possono accedere utenti e gruppi. Le informazioni ACL vengono utilizzate per filtrare i risultati della ricerca in base all'accesso dell'utente o del relativo gruppo ai documenti. Per ulteriori informazioni, consulta Filtraggio del contesto utente. |
|
Un elenco di modelli di espressioni regolari per includere determinati nomi e tipi di file nella tua fonte di dati Dropbox. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di esclusione sia a un modello di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
|
Un elenco di modelli di espressioni regolari per escludere determinati nomi e tipi di file dalla tua fonte di dati Dropbox. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di esclusione che a uno di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
|
true per scansionare i file nei tuoi documenti Dropbox, Dropbox Paper, modelli di Dropbox Paper e collegamenti alle pagine web archiviati nel tuo Dropbox. |
tipo | Il tipo di fonte di dati. Specificare DROPBOX come tipo di origine dati. |
TokenType | Specificate il tipo di token di accesso: token di accesso permanente o temporaneo. Ti consigliamo di creare un token di accesso di aggiornamento che non scada mai in Dropbox anziché affidarti a un token di accesso monouso che scade dopo 4 ore. Crei un'app e un token di accesso di aggiornamento nella console per sviluppatori Dropbox e fornisci il token di accesso come segreto. |
version | La versione di questo modello attualmente supportata. |
{ "$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" ] }
Schema del modello Drupal
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Fornisci l'URL dell'host Drupal e il tipo di autenticazione come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate anche il tipo di fonte di dati come DRUPAL, un segreto per le vostre credenziali di autenticazione e altre configurazioni necessarie. Quindi specifichi TEMPLATE
come quando chiami. Type
CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Drupal.
La tabella seguente descrive i parametri dello schema JSON di Drupal.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
HostUrl | L'URL host del tuo sito web Drupal. <hostname><drupalsitename>Ad esempio, https:/// . |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. |
|
Un elenco di oggetti che mappano gli attributi o i nomi dei campi dei file Drupal. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. I nomi dei campi delle sorgenti dati Drupal devono esistere nei metadati personalizzati di Drupal. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
|
Un elenco di modelli di espressioni regolari per includere determinati file nella fonte di dati Drupal. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di esclusione sia a un modello di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
|
Un elenco di modelli di espressioni regolari per escludere determinati file nella fonte di dati Drupal. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di esclusione che a uno di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
Definizioni dei contenuti
|
Specificate i tipi di contenuto da sottoporre a scansione e se eseguire la scansione di commenti e allegati per i tipi di contenuto selezionati. |
tipo | Il tipo di origine dati. Specificare DRUPAL come tipo di origine dati. |
authType | Il tipo di autenticazione che usi, se BASIC-AUTH oOAUTH2 . |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
Secretarn | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi a Drupal. Il segreto deve contenere una struttura JSON con le seguenti chiavi: Se utilizzi l'autenticazione di base:
Se si utilizza l'autenticazione OAuth 2.0:
|
version | La versione di questo modello attualmente supportata. |
{ "$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 schema modello
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Fornisci l'URL dell' GitHub host, il nome dell'organizzazione e se utilizzi il GitHub cloud o in GitHub locale come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate anche il tipo di origine datiGITHUB
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta GitHub Schema JSON.
La tabella seguente descrive i parametri dello schema GitHub JSON.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
tipo | Specificate il tipo come SAAS oON_PREMISE . |
HostUrl | L'URL dell' GitHub host. Ad esempio, se utilizzi GitHub SaaS/Enterprise Cloud:. https://api.github.com Oppure, se utilizzi GitHub On-premise/Enterprise Server:. https://on-prem-host-url/api/v3/ |
Nome dell'organizzazione | Puoi trovare il nome della tua organizzazione quando accedi al GitHub desktop e vai alla sezione Le mie organizzazioni nel menu a discesa dell'immagine del profilo. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi di campo dei tuoi GitHub contenuti per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
isCrawlAcl | true per eseguire la scansione delle informazioni dell'elenco di controllo degli accessi (ACL) per i documenti, se disponi di un ACL e desideri utilizzarlo per il controllo degli accessi. L'ACL specifica a quali documenti possono accedere e cercare utenti e gruppi. Le informazioni ACL vengono utilizzate per filtrare i risultati della ricerca in base all'accesso dell'utente o del relativo gruppo ai documenti. Per ulteriori informazioni, consulta Filtraggio del contesto utente. |
fieldForUserId | Specificate il tipo di ID utente che desiderate utilizzare per la scansione ACL. Specificate email se desiderate utilizzare l'e-mail dell'utente per l'ID utente o username se desiderate utilizzare il nome utente per l'ID utente. Se non si specifica un'opzione, email viene utilizzata per impostazione predefinita. |
RepositoryFilter | Un elenco di nomi dei repository e dei nomi dei rami specifici che desideri indicizzare. |
CrawlRepository | true per eseguire la scansione dei repository. |
crawlRepositoryDocuments | true per eseguire la scansione dei documenti del repository. |
problema di scansione | true problemi di scansione. |
crawlIssueComment | true per scansionare i commenti dei problemi. |
crawlIssueCommentAllegato | true per eseguire la scansione degli allegati dei commenti. |
crawlPullRequest | true per eseguire la scansione delle richieste pull. |
crawlPullRequestCommento | true per scansionare i commenti della richiesta. |
crawlPullRequestCommentAttachment | true per eseguire la scansione degli allegati dei commenti della richiesta di estrazione. |
|
Un elenco di modelli di espressioni regolari per includere determinati contenuti nella fonte di GitHub dati. I contenuti che corrispondono ai modelli sono inclusi nell'indice. I contenuti che non corrispondono ai modelli sono esclusi dall'indice. Se un contenuto corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il contenuto non viene incluso nell'indice. |
|
Un elenco di modelli di espressioni regolari per escludere determinati contenuti nella fonte di GitHub dati. I contenuti che corrispondono ai modelli sono esclusi dall'indice. I contenuti che non corrispondono ai modelli sono inclusi nell'indice. Se un contenuto corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il contenuto non viene incluso nell'indice. |
tipo | Il tipo di origine dati. Specificare GITHUB come tipo di origine dati. |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN |
L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi al tuo. GitHub Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione di questo modello attualmente supportata. |
Di seguito è riportato lo schema 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" ] }
Schema del modello Gmail
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Specificate il tipo di origine datiGMAIL
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Gmail.
La tabella seguente descrive i parametri dello schema JSON di Gmail.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. Questa fonte di dati non specifica un endpoint in. repositoryEndpointMetadata Piuttosto, le informazioni di connessione sono incluse in un AWS Secrets Manager segreto fornito dall'secretArn utente. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
|
Un elenco di oggetti che mappano gli attributi o i nomi dei campi dei messaggi e degli allegati di Gmail ai nomi dei campi Amazon Kendra indicizzati. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
|
Un elenco di modelli di espressioni regolari per includere o escludere messaggi con nomi di oggetto specifici nell'origine dati di Gmail. I file che corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
beforeDateFilter | Specificate i messaggi e gli allegati da includere prima di una certa data. |
afterDateFilter | Specificate i messaggi e gli allegati da includere dopo una certa data. |
isCrawlAttachment | Un valore booleano per scegliere se scansionare gli allegati. I messaggi vengono sottoposti a scansione automatica. |
tipo | Il tipo di fonte di dati. Specificare GMAIL come tipo di origine dati. |
shouldCrawlDraftMessaggi | Un valore booleano per scegliere se scansionare le bozze dei messaggi. |
SyncMode | Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
ImportantePoiché non esiste un'API per aggiornare i messaggi Gmail eliminati definitivamente, qualsiasi contenuto nuovo, modificato o eliminato viene sincronizzato:
Per sincronizzare le modifiche alle etichette delle sorgenti dati di Gmail e i messaggi email eliminati definitivamente con il tuo Amazon Kendra indice, devi eseguire periodicamente ricerche per indicizzazione complete. |
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene le coppie chiave-valore necessarie per connettersi a Gmail. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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" ] }
Schema del modello di Google Drive
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Specificate il tipo di origine datiGOOGLEDRIVE2
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Google Drive.
La tabella seguente descrive i parametri dello schema JSON di Google Drive.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. Questa fonte di dati non specifica un endpoint. Scegli il tipo di autenticazione: serviceAccount eOAuth2 . Le informazioni di connessione sono incluse in un AWS Secrets Manager segreto fornito dall'utentesecretArn . |
authType | Scegli tra serviceAccount e OAuth2 in base al tuo caso d'uso. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi dei campi di Google Drive per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati |
|
Specificate un limite di dimensione del file in MB che Amazon Kendra deve essere sottoposto a scansione. |
|
true per eseguire la scansione dei commenti nella tua fonte di dati Google Drive. |
|
true per scansionare MyDrive e condividere le unità con me nella tua fonte di dati Google Drive. |
|
true per eseguire la scansione dei Drive condivisi nella tua fonte di dati Google Drive. |
isCrawlAcl | true per eseguire la scansione delle informazioni dell'elenco di controllo degli accessi (ACL) per i tuoi documenti, se disponi di un ACL e desideri utilizzarlo per il controllo degli accessi. L'ACL specifica a quali documenti possono accedere e cercare utenti e gruppi. Le informazioni ACL vengono utilizzate per filtrare i risultati della ricerca in base all'accesso dell'utente o del relativo gruppo ai documenti. Per ulteriori informazioni, consulta Filtraggio del contesto utente. |
|
Un elenco di modelli di espressioni regolari per escludere determinati file nella fonte di dati di Google Drive. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di esclusione che a uno di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
|
Un elenco di modelli di espressioni regolari per includere determinati file nella fonte di dati di Google Drive. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
tipo | Il tipo di origine dati. Specificare GOOOGLEDRIVEV2 come tipo di origine dati. |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi a Google Drive. Il segreto deve contenere una struttura JSON con le seguenti chiavi: Se utilizzi l'autenticazione dell'account di servizio Google:
Se si utilizza l'autenticazione OAuth 2.0:
|
version | La versione di questo modello attualmente supportata. |
{ "$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" ] }
Schema del modello IBM DB2
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Specificate il tipo di origine dati comeJDBC
, il tipo di database comedb2
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON IBM DB2.
La tabella seguente descrive i parametri dello schema JSON IBM DB2.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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" ] }
Schema del modello di Microsoft Exchange
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. L'ID del tenant viene fornito come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate anche il tipo di origine datiMSEXCHANGE
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Microsoft Exchange.
La tabella seguente descrive i parametri dello schema JSON di Microsoft Exchange.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
TenantID | L'ID tenant di Microsoft 365. Puoi trovare il tuo ID tenant nelle proprietà del tuo portale di Azure Active Directory o nell'applicazione OAuth. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi di campo dell'origine dati di Microsoft Exchange ai campi Amazon Kendra indicizzati. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per il contenuto dell'origine dati |
Modelli di inclusione | Un elenco di modelli di espressioni regolari per includere determinati file nell'origine dati di Microsoft Exchange. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di esclusione sia a un modello di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
Modelli di esclusione | Un elenco di modelli di espressioni regolari per escludere determinati file nell'origine dati Microsoft Exchange. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di esclusione che a uno di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
|
Un elenco di modelli di espressioni regolari per includere determinati utenti e file utente nell'origine dati di Microsoft Exchange. Gli utenti che corrispondono ai modelli sono inclusi nell'indice. Gli utenti che non corrispondono ai modelli sono esclusi dall'indice. Se un utente soddisfa sia un modello di inclusione che uno di esclusione, il modello di esclusione ha la precedenza e l'utente non viene incluso nell'indice. |
|
Un elenco di modelli di espressioni regolari per escludere determinati utenti e file utente nell'origine dati Microsoft Exchange. Gli utenti che corrispondono ai modelli vengono esclusi dall'indice. Gli utenti che non corrispondono ai modelli vengono inclusi nell'indice. Se un utente corrisponde sia a un modello di esclusione che a uno di inclusione, il modello di esclusione ha la precedenza e l'utente non viene incluso nell'indice. |
Nome del bucket S3 | Il nome del tuo bucket S3, se lo desideri utilizzare. |
|
true per eseguire la scansione di questi tipi di contenuti e accedere alle informazioni di controllo dell'origine dati di Microsoft Exchange. |
startCalendarDateOra | Puoi configurare una data e un'ora di inizio specifiche per il contenuto del tuo calendario. |
endCalendarDateOra | È possibile configurare una data e un'ora di fine specifiche per il contenuto del calendario. |
subject | È possibile configurare una riga dell'oggetto specifica per il contenuto della posta. |
Email da | Puoi configurare un'e-mail specifica per il contenuto del messaggio «Da» o del mittente. |
Invia un'email a | Puoi configurare un'e-mail specifica per il contenuto della posta «A» o del destinatario. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
tipo | Il tipo di fonte di dati. Specificare MSEXCHANGE come tipo di origine dati. |
Segretario ARN | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi a Microsoft Exchange. Ciò include l'ID cliente e il segreto del cliente generati quando crei un'applicazione OAuth nel portale di Azure. |
version | La versione di questo modello attualmente supportata. |
{ "$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" ] }
Schema OneDrive modello Microsoft
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. L'ID del tenant viene fornito come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate inoltre il tipo di origine datiONEDRIVEV2
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema Microsoft OneDrive JSON.
La tabella seguente descrive i parametri dello schema Microsoft OneDrive JSON.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
TenantID | L'ID tenant di Microsoft 365. Puoi trovare il tuo ID tenant nelle proprietà del tuo portale di Azure Active Directory o nell'applicazione OAuth. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
file | Un elenco di oggetti che mappano gli attributi o i nomi di campo dei OneDrive file Microsoft per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati |
|
Puoi scegliere di indicizzare file, OneNote sezioni, OneNote pagine specifici e filtrarli in base al nome utente. |
isUserNameSu S3 | true per fornire un elenco di nomi utente in un file archiviato in un file. Amazon S3 |
tipo | Il tipo di origine dati. Specificare ONEDRIVEV2 come tipo di origine dati. |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
tipo | Il tipo di fonte di dati. Specificare ONEDRIVEV2 come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi a Microsoft. OneDrive Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione di questo modello attualmente supportata. |
{ "$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" ] }
Schema SharePoint modello Microsoft
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Fornisci l'URL/URL del SharePoint sito, il dominio e anche un ID tenant, se necessario, come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate anche il tipo di origine datiSHAREPOINTV2
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Tipo quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta SharePoint Schema JSON.
La tabella seguente descrive i parametri dello schema Microsoft SharePoint JSON.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati |
TenantID | L'ID inquilino del tuo account. SharePoint |
domain | Il dominio del tuo SharePoint account. |
URL del sito | Gli URL host del tuo account. SharePoint |
repositoryAdditionalProperties | Proprietà aggiuntive per la connessione all'endpoint del repository/origine dati. |
S3bucketName | Il nome del Amazon S3 bucket in cui è archiviato il certificato X.509 autofirmato di Azure AD. |
Nome del certificato S3 | Il nome del certificato X.509 autofirmato di Azure AD archiviato nel bucket. Amazon S3 |
authType | Il tipo di autenticazione che utilizzi, seOAuth2 ,OAuth2Certificate ,OAuth2App ,Basic , OAuth2_RefreshToken NTLM , oKerberos . |
version | La SharePoint versione che usi, se Server oOnline . |
onPremVersion | La versione del SharePoint server che usi, se 2013 2016 2019 , oSubscriptionEdition . |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi dei campi dei SharePoint contenuti per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
|
Un elenco di modelli di espressioni regolari per includere/escludere determinati contenuti nella fonte di dati SharePoint . Gli elementi di contenuto che corrispondono ai modelli di inclusione sono inclusi nell'indice. Gli elementi di contenuto che non corrispondono ai modelli di inclusione sono esclusi dall'indice. Se un file corrisponde sia a un modello di inclusione che di esclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
|
true per eseguire la scansione di questi tipi di contenuti. |
Scansiona LACL | true per eseguire la scansione delle informazioni dell'elenco di controllo degli accessi (ACL) per i documenti, se si dispone di un ACL e si desidera utilizzarlo per il controllo degli accessi. L'ACL specifica a quali documenti possono accedere e cercare utenti e gruppi. Le informazioni ACL vengono utilizzate per filtrare i risultati della ricerca in base all'accesso dell'utente o del relativo gruppo ai documenti. Per ulteriori informazioni, consulta Filtraggio del contesto utente. |
fieldForUserId | Specificare email se si desidera utilizzare l'e-mail dell'utente per l'ID utente o userPrincipalName se si desidera utilizzare un nome utente per l'ID utente. Se non si specifica un'opzione, email viene utilizzata per impostazione predefinita. |
Configurazione ACL | Specificare ACLWithLDAPEmailFmt ACLWithManualEmailFmt , o. ACLWithUsernameFmtM |
Dominio di posta elettronica | Il dominio dell'email. Ad esempio, "amazon.com ». |
|
true per eseguire la scansione delle informazioni di mappatura dei gruppi. |
ProxyHost | Il nome host del proxy Web utilizzato, senza il protocollo http://o https://. |
ProxyPort | Il numero di porta utilizzato dal protocollo di trasporto dell'URL dell'host. Deve essere un valore numerico compreso tra 0 e 65535. |
tipo | Specificare SHAREPOINTV2 come tipo di origine dati |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi al tuo. SharePoint Per informazioni su queste coppie chiave-valore, consulta le istruzioni di connessione per Online e Server. SharePoint SharePoint |
version | La versione di questo modello attualmente supportata. |
{ "$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", "2016", "2019", "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" ] }
Schema del modello di Microsoft SQL Server
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Specificate il tipo di origine dati comeJDBC
, il tipo di database comesqlserver
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Microsoft SQL Server.
La tabella seguente descrive i parametri dello schema JSON di Micorosft SQL Server.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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" ] }
Schema del modello Microsoft Teams
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. L'ID del tenant viene fornito come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate anche il tipo di origine datiMSTEAMS
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Microsoft Teams.
La tabella seguente descrive i parametri dello schema JSON di Microsoft Teams.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
TenantID | L'ID tenant di Microsoft 365. Puoi trovare il tuo ID tenant nelle proprietà del tuo portale di Azure Active Directory o nell'applicazione OAuth. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto di Microsoft Teams per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
Modello di pagamento | Speciifica il tipo di modello di pagamento da utilizzare con l'origine dati Microsoft Teams. I modelli di pagamento modello A sono limitati alle licenze e ai modelli di pagamento che richiedono la conformità in materia di sicurezza. I modelli di pagamento modello B sono adatti per licenze e modelli di pagamento che non richiedono la conformità in materia di sicurezza. |
|
Un elenco di modelli di espressioni regolari per includere determinati contenuti nell'origine dati di Microsoft Teams. I contenuti che corrispondono ai modelli sono inclusi nell'indice. I contenuti che non corrispondono ai modelli sono esclusi dall'indice. Se il contenuto corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il contenuto non viene incluso nell'indice. |
|
Un elenco di modelli di espressioni regolari per escludere determinati contenuti nell'origine dati di Microsoft Teams. I contenuti che corrispondono ai modelli sono esclusi dall'indice. I contenuti che non corrispondono ai modelli sono inclusi nell'indice. Se il contenuto corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il contenuto non è incluso nell'indice. |
|
true per eseguire la scansione di questi tipi di contenuti nell'origine dati Microsoft Teams. |
startCalendarDateOra | Puoi configurare una data e un'ora di inizio specifiche per il contenuto del tuo calendario. |
endCalendarDateOra | È possibile configurare una data e un'ora di fine specifiche per il contenuto del calendario. |
tipo | Il tipo di origine dati. Specificare MSTEAMS come tipo di origine dati. |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi ai tuoi Microsoft Teams. Ciò include l'ID cliente e il segreto del client generati quando crei un'applicazione OAuth nel portale di Azure. |
version | La versione di questo modello attualmente supportata. |
{ "$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" ] }
Schema del modello di Microsoft Yammer
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Specificate il tipo di origine datiYAMMER
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Tipo quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori.
Nella tabella seguente vengono descritti i parametri dello schema JSON di Microsoft Yammer.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. Questa fonte di dati non specifica un endpoint in. repositoryEndpointMetadata Piuttosto, le informazioni di connessione sono incluse in un AWS Secrets Manager segreto fornito dall'secretArn utente. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi di campo dei contenuti di Microsoft Yammer ai nomi dei campi indice di Amazon Kendra. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati |
Modelli di inclusione | Un elenco di modelli di espressioni regolari per includere determinati file nell'origine dati Microsoft Yammer. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli vengono esclusi dall'indice. Se un file corrisponde sia a un modello di esclusione sia a un modello di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
Modelli di esclusione | Un elenco di modelli di espressioni regolari per escludere determinati file nell'origine dati Microsoft Yammer. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di esclusione che a uno di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
Dal momento della data | È possibile scegliere di configurare un sinceDate parametro in modo che il connettore Microsoft Yammer esegua la scansione del contenuto in base a uno specifico. sinceDate |
communityNameFilter | Puoi scegliere di indicizzare contenuti specifici della community. |
|
true per eseguire la scansione di messaggi, allegati e messaggi privati. |
tipo | Specificare YAMMER come tipo di origine dati. |
Segretario ARN | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi a Microsoft Yammer. Ciò include il nome utente e la password di Microsoft Yammer, l'ID client e il segreto client generati quando si crea un'applicazione OAuth nel portale di Azure. |
useChangeLog | true per utilizzare il registro delle modifiche di Microsoft Yammer per determinare quali documenti devono essere aggiornati nell'indice. |
modalità di sincronizzazione |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
{ "$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" ] }
Schema del modello MySQL
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Specificate il tipo di origine dati comeJDBC
, il tipo di database comemysql
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON MySQL.
La tabella seguente descrive i parametri dello schema JSON MySQL.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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" ] }
Schema del modello di database Oracle
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Specificate il tipo di origine dati comeJDBC
, il tipo di database comeoracle
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON del database Oracle.
La tabella seguente descrive i parametri dello schema JSON di Oracle Database.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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" ] }
Schema del modello PostgreSQL
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Specificate il tipo di origine dati comeJDBC
, il tipo di database comepostgresql
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON PostgreSQL.
La tabella seguente descrive i parametri dello schema JSON di PostgreSQL.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Informazioni di configurazione necessarie per connettere la fonte di dati.
|
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. Specificare il tipo di origine dati e l'ARN segreto. |
documento |
Un elenco di oggetti che mappano gli attributi o i nomi di campo del contenuto del database per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. Utilizzatelo per includere o escludere contenuti specifici nella fonte di dati del database. |
Chiave primaria | Fornisci la chiave primaria per la tabella del database. Questo identifica una tabella all'interno del database. |
Colonna del titolo | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
Corpo/colonna | Fornisci il nome della colonna del titolo del documento all'interno della tabella del database. |
sqlQuery | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
colonna Timestamp | Inserisci il nome della colonna che contiene i timestamp. Amazon Kendra utilizza le informazioni relative alla marca temporale per rilevare le modifiche ai contenuti e sincronizzare solo i contenuti modificati. |
formato Timestamp | Inserisci il nome della colonna che contiene i formati di timestamp da utilizzare per rilevare le modifiche ai contenuti e risincronizzare i contenuti. |
timezone | Inserisci il nome della colonna che contiene i fusi orari per il contenuto da sottoporre a scansione. |
changeDetectingColumns | Inserisci i nomi delle colonne che Amazon Kendra verranno utilizzate per rilevare le modifiche al contenuto. Amazon Kendra reindicizzerà il contenuto in caso di modifica in una di queste colonne |
allowedUsersColumns | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
allowedGroupsColumn | Inserisci il nome della colonna che contiene gli ID utente a cui consentire l'accesso ai contenuti. |
SourceURIColumn | Inserisci il nome della colonna che contiene gli URL di origine da indicizzare. |
isSslEnabled | Inserisci istruzioni di query SQL come le operazioni SELECT e JOIN. Le query SQL devono pesare meno di 32 KB. Amazon Kendra eseguirà la scansione di tutto il contenuto del database che corrisponde alla tua query. |
tipo | Il tipo di fonte di dati. Specificare JDBC come tipo di origine dati. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un segreto di Secrets Manager che contiene il nome utente e la password necessari per connettersi al database. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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" ] }
Schema del modello Salesforce
Includi un JSON che contiene lo schema dell'origine dati come parte dell'oggetto. TemplateConfiguration Fornisci l'URL dell'host Salesforce come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate inoltre il tipo di origine datiSALESFORCEV2
, come segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Salesforce.
La tabella seguente descrive i parametri dello schema JSON di Salesforce.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
HostUrl | L'URL dell'istanza Salesforce da indicizzare. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi di campo delle entità Salesforce per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Secretarn | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi a Salesforce. Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati |
|
Una raccolta di stringhe che specifica quali entità filtrare. |
Patterns di inclusione
|
Un elenco di modelli di espressioni regolari per includere determinati file nella fonte di dati Salesforce. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di esclusione sia a un modello di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
Modelli di esclusione
|
Un elenco di modelli di espressioni regolari per escludere determinati file nella fonte dati Salesforce. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di esclusione che a uno di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
|
true per eseguire la scansione di questi tipi di file nel tuo account Salesforce. |
tipo | Il tipo di origine dati. Specificare SALESFORCEV2 come tipo di origine dati. |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
SyncMode |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
version | La versione di questo modello attualmente supportata. |
{ "$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": { "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 schema modello
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. Fornisci l'URL dell' ServiceNow host, il tipo di autenticazione e la versione dell'istanza come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate anche il tipo di origine datiSERVICENOWV2
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta ServiceNow Schema JSON.
La tabella seguente descrive i parametri dello schema ServiceNow JSON.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
HostUrl | L'URL dell' ServiceNow host. Ad esempio, your-domain.service-now.com . |
authType | Il tipo di autenticazione che usi, se basicAuth oOAuth2 . |
servicenowInstanceVersion | La ServiceNow versione che usi. Puoi scegliere traTokyo , Sandiego Rome , eOthers . |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi dei campi degli articoli della ServiceNow Knowledge Base, degli allegati, del catalogo dei servizi e degli incidenti per Amazon Kendra indicizzare i nomi dei campi. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. I nomi dei campi dell'origine ServiceNow dati devono esistere nei metadati ServiceNow personalizzati. |
proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
maxFileSizeInMegaBytes | Specificare il limite di dimensione del file in MB che Amazon Kendra eseguirà la scansione. Amazon Kendra eseguirà la scansione solo dei file entro il limite di dimensione definito. La dimensione predefinita del file è 50 MB. La dimensione massima del file deve essere superiore a 0 MB e inferiore o uguale a 50 MB. |
|
Un elenco di modelli di espressioni regolari per includere e/o escludere determinati file nella fonte di ServiceNow dati. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di esclusione sia a un modello di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
|
true per eseguire la scansione di articoli ServiceNow informativi, cataloghi di servizi, incidenti e allegati. |
tipo | Il tipo di origine dati. Specificare SERVICENOWV2 come tipo di origine dati. |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
SyncMode | Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
Segretario ARN | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi al tuo. ServiceNow Il segreto deve contenere una struttura JSON con le seguenti chiavi: Se utilizzi l'autenticazione OAuth2, il tuo segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione del modello attualmente supportata. |
{ "$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" ] }
Schema del modello Slack
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. L'URL dell'host viene fornito come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate anche il tipo di origine datiSLACK
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Slack.
La tabella seguente descrive i parametri dello schema JSON di Slack.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
TeamID | L'ID del team Slack che hai copiato dall'URL della pagina principale di Slack. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
Tutti | Un elenco di oggetti che mappano gli attributi o i nomi di campo dei Slack contenuti per Amazon Kendra indicizzare i nomi dei campi. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati. |
Modelli di inclusione | Un elenco di modelli di espressioni regolari per includere contenuti specifici nella fonte di datiSlack. I contenuti che corrispondono ai modelli sono inclusi nell'indice. I contenuti che non corrispondono ai modelli sono esclusi dall'indice. Se un contenuto corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il contenuto non viene incluso nell'indice. |
Modelli di esclusione | Un elenco di modelli di espressioni regolari per escludere contenuti specifici nella fonte di Slack dati. I contenuti che corrispondono ai modelli sono esclusi dall'indice. I contenuti che non corrispondono ai modelli sono inclusi nell'indice. Se un contenuto corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il contenuto non viene incluso nell'indice. |
crawlBotMessages | true per scansionare i messaggi dei bot. |
Escludi archiviati | true per escludere la scansione dei messaggi archiviati. |
Tipo di conversazione | Il tipo di conversazione che desideri indicizzare sePUBLIC_CHANNEL , PRIVATE_CHANNEL e. GROUP_MESSAGE DIRECT_MESSAGE |
Filtro del canale | Il tipo di canale che desideri indicizzare se oprivate_channel . public_channel |
Dal momento della data | È possibile scegliere di configurare un sinceDate parametro in modo che il Slack connettore esegua la scansione del contenuto in base a uno specifico. sinceDate |
Guarda indietro | Puoi scegliere di configurare un lookBack parametro in modo che il Slack connettore esegua la scansione dei contenuti aggiornati o eliminati fino a un determinato numero di ore prima dell'ultima sincronizzazione del connettore. |
Modalità di sincronizzazione |
Specificate come Amazon Kendra aggiornare l'indice quando il contenuto dell'origine dati cambia. Puoi scegliere tra:
|
tipo | Il tipo di fonte di dati. Specificare SLACK come tipo di origine dati. |
enableIdentityCrawler | true utilizzare il crawler Amazon Kendra di identità per sincronizzare le informazioni sull'identità/principali su utenti e gruppi con accesso a determinati documenti. Se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo degli accessi per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzare l'PutPrincipalMappingAPI per caricare le informazioni di accesso di utenti e gruppi. |
Secretarn |
L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi al tuo. Slack Il segreto deve contenere una struttura JSON con le seguenti chiavi:
|
version | La versione di questo modello attualmente supportata. |
{ "$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" ] }
Schema del modello Zendesk
Includi un JSON che contiene lo schema dell'origine dati come parte dell'TemplateConfigurationoggetto. L'URL dell'host viene fornito come parte della configurazione della connessione o dei dettagli dell'endpoint del repository. Specificate anche il tipo di origine datiZENDESK
, un segreto per le credenziali di autenticazione e altre configurazioni necessarie. È quindi necessario specificare TEMPLATE
come Type
quando si chiama. CreateDataSource
Puoi utilizzare il modello fornito in questa guida per sviluppatori. Per informazioni, consulta Schema JSON di Zendesk.
La tabella seguente descrive i parametri dello schema JSON di Zendesk.
Configurazione | Descrizione |
---|---|
Configurazione della connessione | Informazioni di configurazione per l'endpoint per l'origine dati. |
repositoryEndpointMetadata | Le informazioni sull'endpoint per l'origine dati. |
HostUrl | L'URL dell'host Zendesk. Ad esempio, https://yoursubdomain.zendesk.com. |
Configurazioni del repository | Informazioni di configurazione per il contenuto dell'origine dati. Ad esempio, la configurazione di tipi specifici di contenuti e mappature dei campi. |
|
Un elenco di oggetti che mappano gli attributi o i nomi di campo dei ticket Zendesk ai nomi dei campi indice di Amazon Kendra. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati. |
Secretarn | L'Amazon Resource Name (ARN) di un AWS Secrets Manager segreto che contiene le coppie chiave-valore necessarie per connettersi a Zendesk. Il segreto deve contenere una struttura JSON con le seguenti chiavi: URL host, ID client, client secret, nome utente e password. |
Proprietà aggiuntive | Opzioni di configurazione aggiuntive per i contenuti della fonte di dati |
organizationNameFilter | Puoi scegliere di indicizzare i ticket esistenti all'interno di una specifica organizzazione. |
Dal momento della data | Puoi scegliere di configurare un sinceDate parametro in modo che il connettore Zendesk esegua la scansione dei contenuti in base a uno specifico. sinceDate |
Modelli di inclusione | Un elenco di modelli di espressioni regolari per includere determinati file nella fonte dati Zendesk. I file che corrispondono ai modelli sono inclusi nell'indice. I file che non corrispondono ai modelli sono esclusi dall'indice. Se un file corrisponde sia a un modello di inclusione che a uno di esclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
Modelli di esclusione | Un elenco di modelli di espressioni regolari per escludere determinati file nella fonte dati Zendesk. I file che corrispondono ai modelli sono esclusi dall'indice. I file che non corrispondono ai modelli sono inclusi nell'indice. Se un file corrisponde sia a un modello di esclusione che a uno di inclusione, il modello di esclusione ha la precedenza e il file non viene incluso nell'indice. |
|
Inserisci "true " per eseguire la scansione di questi tipi di contenuti. |
tipo | Specificare ZENDESK come tipo di origine dati. |
useChangeLog | Inserisci "true " per utilizzare il log delle modifiche di Zendesk per determinare quali documenti devono essere aggiornati nell'indice. A seconda delle dimensioni del registro delle modifiche, potrebbe essere più veloce scansionare i documenti in Zendesk. Se sincronizzi la fonte di dati Zendesk con l'indice per la prima volta, tutti i documenti vengono scansionati. |
{ "$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" ] }