Api et modèles du robot de connecteur de connecteur de contrats de connecteur de contrats de connecteur
L’API et les modèles du robot de connecteur des contrats du KIT de développement logiciel (SDK) Microsoft Graph sont appelés pendant une analyse.
API du robot de connecteur
| Méthode | Paramètres | Type renvoyé | Description |
|---|---|---|---|
| GetCrawlStream | GetCrawlStreamRequest | CrawlStreamBit en tant que flux | Lit les données de la source de données. Cette méthode sera appelée lors d’analyses complètes et périodiques, où tous les éléments doivent être lus à partir de la source de données et retournés à la plateforme. |
| GetIncrementalCrawlStream | GetIncrementalCrawlStreamRequest | IncrementalCrawlStreamBit en tant que flux | Lit les données de la source de données. Cette méthode est facultative et est appelée pendant les analyses incrémentielles et retourne uniquement les modifications incrémentielles dans les éléments depuis la dernière analyse incrémentielle. |
Modèles de robot de connecteur
Voici les modèles de robot de connecteur.
GetCrawlStreamRequest
Modèle de demande pour obtenir des éléments pendant l’analyse.
| Propriété | Type | Description |
|---|---|---|
| customConfiguration | CustomConfiguration | Fournit des données de configuration pour le connecteur. |
| authenticationData | AuthenticationData | Contient l’URL d’accès à la source de données et les informations d’identification pour y accéder. |
| crawlProgressMarker | CrawlCheckpoint | Contient les données pour identifier les éléments qui ont été traités dans la dernière analyse. Le connecteur retourne les informations de l’élément et les utilise si la plateforme se bloque pendant l’analyse. |
| Schéma | DataSourceSchema | Affiche le schéma de la connexion. Cette propriété peut également être utilisée pour définir la valeur. |
CrawlStreamBit
Modèle de réponse qui contient l’élément status indiquant la réussite ou l’échec et l’indicateur/point de contrôle de l’élément analysé pendant l’analyse complète ou périodique.
| Propriété | Type | Description |
|---|---|---|
| status | OperationStatus | Affiche les status de l’opération et les détails de l’erreur. |
| crawlItem | CrawlItem | Affiche un seul élément analysé à partir de la source de données. |
| crawlProgressMarker | CrawlCheckpoint | Identifie l’élément analysé à partir de la source de données. |
GetIncrementalCrawlStreamRequest
Modèle de demande pour obtenir des éléments pendant une analyse incrémentielle.
| Propriété | Type | Description |
|---|---|---|
| customConfiguration | CustomConfiguration | Fournit des données de configuration pour le connecteur. |
| authenticationData | AuthenticationData | Contient l’URL d’accès à la source de données et les informations d’identification pour y accéder. |
| crawlProgressMarker | CrawlCheckpoint | Contient les données pour identifier les éléments qui ont été traités dans la dernière analyse. Le connecteur retourne les informations de l’élément et les utilise si la plateforme se bloque pendant l’analyse. |
| Schéma | DataSourceSchema | Affiche le schéma de la connexion. Cette propriété peut également être utilisée pour définir la valeur. |
| previousCrawlStartTimeInUtc | Timestamp | Affiche l’heure de début de l’analyse précédente au format UTC. Cette valeur peut être utilisée dans la première analyse incrémentielle, mais les appels suivants doivent utiliser la valeur de point de contrôle. |
IncrementalCrawlStreamBit
Modèle de réponse contenant l’élément, status indiquant la réussite/les échecs éventuels et l’indicateur/point de contrôle de l’élément analysé pendant l’analyse incrémentielle.
| Propriété | Type | Description |
|---|---|---|
| status | OperationStatus | Affiche les status de l’opération et les détails de l’erreur. |
| crawlItem | IncrementalCrawlItem | Affiche un seul élément analysé à partir de la source de données pendant et l’analyse incrémentielle. |
| crawlProgressMarker | CrawlCheckpoint | Identifie le dernier élément analysé à partir de la source de données lors de la dernière analyse incrémentielle. |
Membres d’énumération ItemType pour CrawlItem
Champs d’énumération pour les éléments d’analyse.
| Membre | Valeur | Description |
|---|---|---|
| ContentItem | 0 | Éléments de données avec du contenu à ingérer. Par exemple : contenu du site web. |
| LinkItem | 1 | Lien vers un élément de contenu qui sera utilisé dans les analyses suivantes. Par exemple : liens vers un site web ou un dossier. |
CrawlItem
Représente une entité dans la source de données. La taille maximale autorisée est de 4 Mo. Par exemple : un fichier, un dossier ou un enregistrement dans une table.
| Propriété | Type | Description |
|---|---|---|
| Itemid | string | Affiche l’ID unique qui représente l’élément dans la source de données. |
| contentItem | ContentItem | Affiche un élément de données avec du contenu à ingérer. Par exemple : le contenu d’un site web. |
| linkItem | LinkItem | Lien vers un élément de contenu qui sera utilisé dans les analyses suivantes. Par exemple : un lien vers un site web ou un dossier. |
| itemType | ItemType | Affiche le type d’élément envoyé. Ce modèle doit avoir un contentItem ou un linkItem défini et ce champ d’énumération doit correspondre à cet élément. |
Remarque
- Les propriétés linkItem et contentItem s’excluent mutuellement.
Membres d’énumération ItemType pour IncrementalCrawlItem
Champs d’énumération pour les éléments d’analyse incrémentielle.
| Membre | Valeur | Description |
|---|---|---|
| ContentItem | 0 | Éléments de données avec du contenu à ingérer. Par exemple : le contenu d’un site web. |
| LinkItem | 1 | Lien vers un élément de contenu qui sera utilisé dans les analyses suivantes. Par exemple : un lien vers un site web ou un dossier. |
| DeletedItem | 2 | Élément qui a été supprimé de la source de données et qui doit être supprimé de l’index. |
IncrementalCrawlItem
Représente une entité dans la source de données. Par exemple : un fichier, un dossier ou un enregistrement dans une table.
| Propriété | Type | Description |
|---|---|---|
| Itemid | string | Affiche l’ID unique qui représente l’élément dans la source de données. |
| contentItem | ContentItem | Affiche un élément de données avec du contenu à ingérer. Par exemple : le contenu d’un site web. |
| linkItem | LinkItem | Lien vers un élément de contenu qui sera utilisé dans les analyses suivantes. Par exemple : un lien vers un site web ou un dossier. |
| deletedItem | DeletedItem | Élément supprimé de la source de données et devant être supprimé de l’index. Si deletedItem est défini, contentItem ou linkItem ne peut pas être défini. |
| itemType | ItemType | Affiche le type d’élément envoyé. Ce modèle doit avoir un contentItem ou un linkItem défini et ce champ d’énumération doit correspondre à cet élément. |
Remarque
- Les propriétés linkItem, contentItem et deletedItem s’excluent mutuellement.
ContentItem
Élément qui contient le contenu de l’entité de source de données à ingérer. Par exemple : le contenu d’un site web.
| Propriété | Type | Description |
|---|---|---|
| propertyValues | SourcePropertyValueMap | Contient la clé et les valeurs de chaque propriété dans l’élément. |
| accessList | AccessControlList | Limite l’accès à l’élément à des utilisateurs ou des groupes spécifiques. |
| contenu | Content | Affiche la propriété content de l’élément qui peut être utilisée lors de l’affichage des résultats de recherche. |
LinkItem
Élément qui agit comme un lien vers un autre élément. Ces éléments de lien seront à nouveau envoyés au connecteur à des fins de recrawl ; Par exemple, dans un contenu de dossier, les fichiers sont des éléments de contenu et les sous-dossiers sont des éléments de lien.
| Propriété | Type | Description |
|---|---|---|
| Métadonnées | chaîne de mappage<, GenericType> | Contient les métadonnées nécessaires au connecteur pour réécrire l’élément. |
DeletedItem
Représente un élément qui a été supprimé de la source de données et qui doit être supprimé de l’index.
AccessControlList
Limite les utilisateurs qui peuvent voir les résultats de la recherche.
| Propriété | Type | Description |
|---|---|---|
| Entries | répétition d’AccessControlEntry | Affiche le tableau ou la collection d’entrées de liste de contrôle d’accès. |
Membres de l’énumération AclAccessType
Membres d’énumération du type de liste de contrôle d’accès.
| Membre | Valeur | Description |
|---|---|---|
| Aucun | 0 | Indique la valeur par défaut : deny. |
| Accorder | 1 | L’entrée est destinée aux utilisateurs/groupes ayant accès à l’élément. |
| Refuser | 2 | L’entrée est destinée aux utilisateurs/groupes sans accès à l’élément et remplace l’octroi pour n’importe quel utilisateur/groupe. |
AccessControlEntry
Contient des entrées de contrôle d’accès individuelles.
| Propriété | Type | Description |
|---|---|---|
| accessType | AclAccessType | Affiche le type d’accès de l’entité accorder ou refuser. |
| principal | Principal | Représente un groupe ou un utilisateur avec un accès défini. |
Membres de l’énumération PrincipalType
Énumération des membres du type principal.
| Membre | Valeur | Description |
|---|---|---|
| PT_None | 0 | Indique la valeur par défaut : user. |
| Utilisateur | 1 | Type d’utilisateur. |
| Groupe | 2 | Type de groupe. |
| Tout le monde | 3 | Groupe spécial pour accorder l’accès à tout le monde. |
| EveryoneExceptGuests | 4 | Groupe spécial pour accorder l’accès à tout le monde à l’exception des invités. |
Membres de l’énumération IdentitySource
Énumération des membres de la source d’identité.
| Membre | Valeur | Description |
|---|---|---|
| IS_None | 0 | Indique la valeur par défaut : Microsoft Entra ID. |
| AzureActiveDirectory | 1 | La source d’identité est Microsoft Entra ID. |
IdentityType, membres de l’énumération
Énumération des membres de type d’identité.
| Membre | Valeur | Description |
|---|---|---|
| IT_None | 0 | Indique la valeur par défaut : (Azure ADId). |
| ActiveDirectorySId | 1 | SID (Identificateur de sécurité local) fourni par Active Directory (AD). |
| UserPrincipalName | 2 | Nom d’utilisateur principal (UPN). |
| AadId | 3 | Azure ADId. |
Directeur
Structure pour stocker les attributs du principal (utilisateur/groupe).
| Propriété | Type | Description |
|---|---|---|
| type | PrincipalType | Type de principal. |
| valeur | chaîne | Valeur du principal : valeur du SID, de l’UPN, d’Azure ADId, etc. |
| identitySource | IdentitySource | Source de l’identité. |
| identityType | IdentityType | Type de représentation d’identité. |
| identitySourceProperties | chaîne de mappage<, chaîne> | Métadonnées relatives à la source d’identité. |
SourcePropertyValueMap
Mappage de la clé de propriété source et de sa valeur dans la source de données. Il stocke la valeur de propriété de chaque élément.
| Propriété | Type | Description |
|---|---|---|
| values | chaîne de mappage<, GenericType> | Contient la clé et les valeurs des propriétés de l’élément. La clé est le nom de la propriété et la valeur est la valeur de la propriété. Par exemple, le contenu du fichier a des propriétés telles que title, modifiedDate, etc. Les clés de propriétés seront les propriétés elles-mêmes et leurs valeurs seront respectivement le titre du fichier et la date de modification du fichier. |
Membres de l’énumération ContentType
Énumération membres du type de contenu.
| Membre | Valeur | Description |
|---|---|---|
| Aucun | 0 | Valeur par défaut. |
| Texte | 1 | Type de contenu texte. |
| Html | 2 | Type de contenu HTML. |
Contenu
Valeur de la propriété content de l’élément, utilisée pour afficher les résultats de la recherche.
| Propriété | Type | Description |
|---|---|---|
| contentType | ContentType | Type du contenu. |
| contentValue | string | Valeur de la propriété content. |
CrawlCheckpoint
Identifie l’élément analysé en dernier. Il sera enregistré par la plateforme et le point de contrôle du dernier lot d’éléments réussi sera utilisé pour reprendre l’analyse en cas de défaillance ou de blocage. La plateforme envoie le point de contrôle dans l’API GetCrawlStream .
| Propriété | Type | Description |
|---|---|---|
| pagenumber | uint32 | Affiche le numéro de page pour marquer la progression de l’analyse. |
| batchSize | uint32 | Contient le nombre d’éléments retournés dans chaque lot. Il a une valeur constante de 1, car chaque élément est diffusé individuellement. |
| customMarkerData | chaîne | Données personnalisées nécessaires pour identifier le dernier élément analysé à partir de la source de données. |
GenericType
Modélisez pour contenir les types de valeurs pris en charge par la plateforme dans certains champs, comme les valeurs de propriété source. Un seul des champs suivants doit être défini.
| Propriété | Type | Description |
|---|---|---|
| Stringvalue | string | Représente une valeur de chaîne. |
| intValue | int64 | Représente une valeur int64 (long). |
| Doublevalue | double | Représente une valeur double. |
| Datetimevalue | google.protobuf.Timestamp | Représente une valeur dateTime. |
| boolValue | bool | Représente une valeur booléenne |
| stingCollectionValue | StringCollectionType | Représente une collection de chaînes. |
| intCollectionValue | IntCollectionType | Représente une collection de int64 (long). |
| doubleCollectionValue | DoubleCollectionType | Représente une collection de double. |
| dateTimeCollectionValue | TimestampCollectionType | Représente une collection de dateTime. |
StringCollectionType
Collection de chaînes.
| Propriété | Type | Description |
|---|---|---|
| values | chaîne répétée | Collection ou tableau de chaînes. |
IntCollectionType
Collection de valeurs entières.
| Propriété | Type | Description |
|---|---|---|
| values | répétée int64 | Collection ou tableau de valeurs int64 (long). |
DoubleCollectionType
Collection de valeurs doubles.
| Propriété | Type | Description |
|---|---|---|
| values | double répété | Collection ou tableau de valeurs doubles. |
TimestampCollectionType
Collection de valeurs DateTime .
| Propriété | Type | Description |
|---|---|---|
| values | répété google.protobuf.Timestamp | Collection ou tableau de valeurs dateTime . |