API-интерфейс обходчика соединителей соединителей и модели соединителей для соединителей microsoft Graph для контрактов

Статья
03/17/2023

ВО время обхода контента вызывается API-интерфейс и модели соединителя соединителя соединителей Microsoft Graph connectors SDK.

API-интерфейс обходчика соединителя

Метод	Параметры	Возвращаемый тип	Описание
GetCrawlStream	GetCrawlStreamRequest	CrawlStreamBit в виде потока	Считывает данные из источника данных. Этот метод будет вызываться во время полного и периодического полного обхода, когда все элементы должны считываться из источника данных и возвращаться на платформу.
GetIncrementalCrawlStream	GetIncrementalCrawlStreamRequest	IncrementalCrawlStreamBit в виде потока	Считывает данные из источника данных. Этот метод является необязательным и будет вызываться во время добавочного обхода контента и возвращает только добавочные изменения в элементах с момента последнего добавочного обхода.

Модели обходчика соединителей

Ниже приведены модели обходчика соединителей.

GetCrawlStreamRequest

Модель запроса для получения элементов во время обхода контента.

Свойство	Тип	Описание
customConfiguration	CustomConfiguration	Предоставляет данные конфигурации для соединителя.
authenticationData	AuthenticationData	Содержит URL-адрес доступа к источнику данных и учетные данные для доступа к нему.
crawlProgressMarker	CrawlCheckpoint	Содержит данные для идентификации элементов, обработанных во время последнего обхода контента. Соединитель возвращает сведения об элементе и использует их при сбое платформы во время обхода.
Схема	DataSourceSchema	Показывает схему подключения. Это свойство также можно использовать для задания значения.

CrawlStreamBit

Модель ответа, содержащая состояние элемента, указывающее на успех или сбой, а также индикатор или контрольную точку для элемента, обход которого выполняется во время полного или периодического обхода.

Свойство	Тип	Описание
status	OperationStatus	Показывает состояние операции и сведения об ошибке.
crawlItem	CrawlItem	Показывает один элемент, обход из источника данных.
crawlProgressMarker	CrawlCheckpoint	Определяет элемент, обход из источника данных.

GetIncrementalCrawlStreamRequest

Модель запроса для получения элементов во время добавочного обхода контента.

Свойство	Тип	Описание
customConfiguration	CustomConfiguration	Предоставляет данные конфигурации для соединителя.
authenticationData	AuthenticationData	Содержит URL-адрес доступа к источнику данных и учетные данные для доступа к нему.
crawlProgressMarker	CrawlCheckpoint	Содержит данные для идентификации элементов, обработанных во время последнего обхода контента. Соединитель возвращает сведения об элементе и использует их при сбое платформы во время обхода.
Схемы	DataSourceSchema	Показывает схему подключения. Это свойство также можно использовать для задания значения.
previousCrawlStartTimeInUtc	Timestamp	Показывает предыдущее время начала обхода контента в формате UTC. Это значение можно использовать при первом добавочном обходе, но последующие вызовы должны использовать значение контрольной точки.

IncrementalCrawlStreamBit

Модель ответа, содержащая элемент, состояние, указывающее на успешное или неудачное завершение, если таковые есть, и индикатор или контрольную точку для элемента, обход которого выполняется во время добавочного обхода.

Свойство	Тип	Описание
status	OperationStatus	Показывает состояние операции и сведения об ошибке.
crawlItem	IncrementalCrawlItem	Показывает один элемент, обход из источника данных во время и добавочного обхода.
crawlProgressMarker	CrawlCheckpoint	Определяет последний элемент, обход из источника данных во время последнего добавочного обхода.

Элементы перечисления ItemType для CrawlItem

Поля перечисления для элементов обхода контента.

Элемент	Значение	Описание
ContentItem	0	Элементы данных с содержимым для приема. Например: содержимое веб-сайта.
LinkItem	1	Ссылка на элемент контента, который будет использоваться при последующих обходах контента. Например: Ссылки на веб-сайт или папку.

CrawlItem

Представляет сущность в источнике данных. Максимальный допустимый размер — 4 МБ. Например: файл, папка или запись в таблице.

Свойство	Тип	Описание
Itemid	string	Показывает уникальный идентификатор, представляющий элемент в источнике данных.
contentItem	ContentItem	Показывает элемент данных с содержимым для приема. Например: содержимое веб-сайта.
linkItem	LinkItem	Ссылка на элемент контента, который будет использоваться при последующих обходах контента. Например: ссылка на веб-сайт или папку.
Itemtype	ItemType	Показывает тип отправляемого элемента. Эта модель должна иметь набор contentItem или linkItem , и это поле перечисления должно соответствовать этому элементу.

Примечание.

Свойства linkItem и contentItem являются взаимоисключающими.

Элементы перечисления ItemType для IncrementalCrawlItem

Поля перечисления для элементов добавочного обхода контента.

Элемент	Значение	Описание
ContentItem	0	Элементы данных с содержимым для приема. Например: содержимое веб-сайта.
LinkItem	1	Ссылка на элемент контента, который будет использоваться при последующих обходах контента. Например: ссылка на веб-сайт или папку.
DeletedItem	2	Элемент, который был удален из источника данных и должен быть удален из индекса.

IncrementalCrawlItem

Представляет сущность в источнике данных. Например: файл, папка или запись в таблице.

Свойство	Тип	Описание
Itemid	string	Показывает уникальный идентификатор, представляющий элемент в источнике данных.
contentItem	ContentItem	Показывает элемент данных с содержимым для приема. Например: содержимое веб-сайта.
linkItem	LinkItem	Ссылка на элемент контента, который будет использоваться при последующих обходах контента. Например: ссылка на веб-сайт или папку.
deletedItem	DeletedItem	Элемент, который удаляется из источника данных и должен быть удален из индекса. Если параметр deletedItem задан, невозможно задать contentItem или linkItem .
Itemtype	ItemType	Показывает тип отправляемого элемента. Эта модель должна иметь набор contentItem или linkItem , и это поле перечисления должно соответствовать этому элементу.

Примечание.

Свойства linkItem, contentItem и deletedItem являются взаимоисключающими.

ContentItem

Элемент, содержащий содержимое сущности источника данных для приема. Например: содержимое веб-сайта.

Свойство	Тип	Описание
propertyValues	SourcePropertyValueMap	Содержит ключ и значения каждого свойства в элементе.
accessList	Acl	Ограничивает доступ к элементу определенным пользователям или группам.
содержимое	Контент	Показывает свойство содержимого элемента, которое можно использовать при отображении результатов поиска.

LinkItem

Элемент, который выступает в качестве ссылки на другой элемент. Эти элементы ссылки будут снова отправлены в соединитель для повторного раскроя; Например, в содержимом папки файлы будут элементами содержимого, а вложенные папки — элементами ссылки.

Свойство	Тип	Описание
Метаданных	строка сопоставления<, GenericType>	Содержит метаданные, необходимые соединителю для повторного раскраски элемента.

DeletedItem

Представляет элемент, который был удален из источника данных и должен быть удален из индекса.

Acl

Ограничивает пользователей, которые могут просматривать результаты поиска.

Свойство	Тип	Описание
Entries	повторение AccessControlEntry	Показывает массив или коллекцию записей списка управления доступом.

Члены перечисления AclAccessType

Элементы перечисления типа списка управления доступом.

Элемент	Значение	Описание
Нет	0	Указывает значение по умолчанию: deny.
Предоставить	1	Запись предназначена для пользователей или групп с доступом к элементу.
Запретить	2	Запись предназначена для пользователей или групп без доступа к элементу, а переопределения предоставляются для любого пользователя или группы.

AccessControlEntry

Содержит отдельные записи управления доступом.

Свойство	Тип	Описание
accessType	AclAccessType	Показывает тип доступа сущности, предоставляемой или запрещенной.
Основной	Principal	Представляет группу или пользователя с определенным доступом.

Элементы перечисления PrincipalType

Элементы перечисления типа субъекта.

Элемент	Значение	Описание
PT_None	0	Указывает значение по умолчанию: user.
Пользователь	1	Тип пользователя.
Группа	2	Тип группы.
Все пользователи	3	Специальная группа для предоставления доступа всем пользователям.
ВсеExceptGuests	4	Специальная группа для предоставления доступа всем, кроме гостей.

Элементы перечисления IdentitySource

Элементы перечисления источника удостоверений.

Элемент	Значение	Описание
IS_None	0	Указывает значение по умолчанию: Microsoft Entra ID.
AzureActiveDirectory	1	Источником удостоверения является Microsoft Entra ID.

Элементы перечисления IdentityType

Элементы перечисления типа удостоверения.

Элемент	Значение	Описание
IT_None	0	Указывает значение по умолчанию: (Azure ADId).
ActiveDirectorySId	1	SID (локальный идентификатор безопасности), предоставляемый Active Directory (AD).
UserPrincipalName	2	Имя участника-пользователя (UPN).
AadId	3	Azure ADId.

Principal

Структура для хранения атрибутов субъекта (пользователя или группы).

Свойство	Тип	Описание
type	PrincipalType	Тип субъекта.
значение	string	Основное значение: значение идентификатора безопасности, имени участника-пользователя, Azure ADId и т. д.
identitySource	IdentitySource	Источник удостоверения.
IdentityType	IdentityType	Тип представления удостоверения.
identitySourceProperties	строка сопоставления<, строка>	Метаданные об источнике удостоверений.

SourcePropertyValueMap

Сопоставление ключа свойства источника и его значения в источнике данных. В нем хранится значение свойства каждого элемента.

Свойство	Тип	Описание
values	строка сопоставления<, GenericType>	Содержит ключ и значения свойств элемента. Ключ — это имя свойства, а значение — значение свойства. Например, содержимое файла имеет такие свойства, как title, modifiedDate и т. д. Ключами свойств будут сами свойства, а их значениями будут название файла и дата изменения файла соответственно.

Элементы перечисления ContentType

Элементы перечисления типа контента.

Элемент	Значение	Описание
Нет	0	Значение по умолчанию.
Текст	1	Текстовый тип контента.
HTML	2	Тип контента HTML.

Содержимое

Значение свойства содержимого элемента, используемого для отображения результатов поиска.

Свойство	Тип	Описание
contentType	ContentType	Тип содержимого.
contentValue	string	Значение свойства содержимого.

CrawlCheckpoint

Определяет элемент, который был обходен последним. Она будет сохранена платформой, а контрольная точка из последнего успешного пакета элементов будет использоваться для возобновления обхода в случае сбоя или сбоя. Платформа отправит контрольную точку в API GetCrawlStream .

Свойство	Тип	Описание
pagenumber	Uint32	Показывает номер страницы для обозначения хода обхода контента.
Batchsize	Uint32	Содержит количество элементов, возвращаемых в каждом пакете. Он имеет постоянное значение 1, так как каждый элемент передается по отдельности.
customMarkerData	string	Пользовательские данные, необходимые для идентификации последнего элемента, обхода из источника данных.

GenericType

Модель для хранения поддерживаемых платформой типов значений в определенных полях, таких как значения исходных свойств. Необходимо задать только одно из следующих полей.

Свойство	Тип	Описание
stringValue	string	Представляет строковое значение.
intValue	int64	Представляет значение int64 (long).
doubleValue	double	Представляет двойное значение.
dateTimeValue	google.protobuf.Timestamp	Представляет значение dateTime.
boolValue	логический	Представляет логическое значение.
stingCollectionValue	StringCollectionType	Представляет коллекцию строк.
intCollectionValue	IntCollectionType	Представляет коллекцию int64 (long).
doubleCollectionValue	DoubleCollectionType	Представляет коллекцию double.
dateTimeCollectionValue	TimestampCollectionType	Представляет коллекцию dateTime.

StringCollectionType

Коллекция строк.

Свойство	Тип	Описание
values	повторяющаяся строка	Коллекция или массив строк.

IntCollectionType

Коллекция целочисленных значений.

Свойство	Тип	Описание
values	повторяющееся int64	Коллекция или массив значений int64 (long).

DoubleCollectionType

Коллекция двойных значений.

Свойство	Тип	Описание
values	повторяющееся двойное	Коллекция или массив двойных значений.

TimestampCollectionType

Коллекция значений DateTime .

Свойство	Тип	Описание
values	повторная google.protobuf.Timestamp	Коллекция или массив значений dateTime .