Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Os conectores Microsoft 365 Copilot (anteriormente conectores do Microsoft Graph) SDK contratam a API e os modelos do conector são chamados durante uma pesquisa.
API do crawler do conector
| Método | Parâmetros | Tipo de retorno | Descrição |
|---|---|---|---|
| GetCrawlStream | GetCrawlStreamRequest | CrawlStreamBit como um fluxo | Lê dados da origem de dados. Este método será chamado durante pesquisas completas e periódicas completas em que todos os itens devem ser lidos a partir da origem de dados e devolvidos à plataforma. |
| GetIncrementalCrawlStream | GetIncrementalCrawlStreamRequest | IncrementalCrawlStreamBit como um fluxo | Lê dados da origem de dados. Este método é opcional e será chamado durante pesquisas incrementais e devolve apenas as alterações incrementais nos itens desde a última pesquisa incremental. |
Modelos de crawler de conectores
Seguem-se os modelos de crawler de conectores.
GetCrawlStreamRequest
Modelo de pedido para obter itens durante a pesquisa.
| Propriedade | Tipo | Descrição |
|---|---|---|
| customConfiguration | CustomConfiguration | Fornece dados de configuração para o conector. |
| authenticationData | AuthenticationData | Contém o URL de acesso à origem de dados e as credenciais para aceder ao mesmo. |
| crawlProgressMarker | CrawlCheckpoint | Contém dados para identificar itens que foram processados na última pesquisa. O conector devolve as informações do item e utiliza-as se a plataforma falhar durante a pesquisa. |
| Esquema | DataSourceSchema | Mostra o esquema da ligação. Esta propriedade também pode ser utilizada para definir o valor. |
CrawlStreamBit
Modelo de resposta que contém o item status que indica êxito ou falha e o indicador/ponto de verificação do item que está a ser pesquisado durante a pesquisa completa ou periódica.
| Propriedade | Tipo | Descrição |
|---|---|---|
| status | OperationStatus | Mostra a status da operação e os detalhes do erro. |
| crawlItem | CrawlItem | Mostra um único item pesquisado a partir da origem de dados. |
| crawlProgressMarker | CrawlCheckpoint | Identifica o item pesquisado a partir da origem de dados. |
GetIncrementalCrawlStreamRequest
Modelo de pedido para obter itens durante uma pesquisa incremental.
| Propriedade | Tipo | Descrição |
|---|---|---|
| customConfiguration | CustomConfiguration | Fornece dados de configuração para o conector. |
| authenticationData | AuthenticationData | Contém o URL de acesso à origem de dados e as credenciais para aceder ao mesmo. |
| crawlProgressMarker | CrawlCheckpoint | Contém dados para identificar itens que foram processados na última pesquisa. O conector devolve as informações do item e utiliza-as se a plataforma falhar durante a pesquisa. |
| esquema | DataSourceSchema | Mostra o esquema da ligação. Esta propriedade também pode ser utilizada para definir o valor. |
| previousCrawlStartTimeInUtc | Carimbo de data/hora | Mostra a hora de início da pesquisa anterior em UTC. Este valor pode ser utilizado na primeira pesquisa incremental, mas as chamadas subsequentes devem utilizar o valor do ponto de verificação. |
IncrementalCrawlStreamBit
Modelo de resposta que contém o item, status a indicar êxito/falhas, se existir, e o indicador/ponto de verificação do item que está a ser pesquisado durante a pesquisa incremental.
| Propriedade | Tipo | Descrição |
|---|---|---|
| status | OperationStatus | Mostra a status da operação e os detalhes do erro. |
| crawlItem | IncrementalCrawlItem | Mostra um único item pesquisado a partir da origem de dados durante a pesquisa incremental. |
| crawlProgressMarker | CrawlCheckpoint | Identifica o último item pesquisado a partir da origem de dados durante a última pesquisa incremental. |
Membros de enumeração ItemType para CrawlItem
Campos de enumeração para itens de pesquisa.
| Membro | Valor | Descrição |
|---|---|---|
| ContentItem | 0 | Itens de dados com conteúdo para ingerir. Por exemplo: conteúdo do site. |
| LinkItem | 1 | Ligar a um item de conteúdo que será utilizado em pesquisas subsequentes. Por exemplo: Ligações para um site ou pasta. |
CrawlItem
Representa uma entidade na origem de dados. O tamanho máximo permitido é de 4 MB. Por exemplo: um ficheiro, uma pasta ou um registo numa tabela.
| Propriedade | Tipo | Descrição |
|---|---|---|
| itemId | string | Mostra o ID exclusivo que representa o item na origem de dados. |
| contentItem | ContentItem | Mostra um item de dados com conteúdo para ingerir. Por exemplo: o conteúdo de um site. |
| linkItem | LinkItem | Ligar a um item de conteúdo que será utilizado em pesquisas subsequentes. Por exemplo: uma ligação para um site ou uma pasta. |
| itemType | ItemType | Mostra o tipo de item que está a ser enviado. Este modelo deve ter um contentItem ou um conjunto linkItem e este campo de enumeração deve corresponder a esse item. |
Observação
- As propriedades linkItem e contentItem são mutuamente exclusivas.
Membros de enumeração ItemType para IncrementalCrawlItem
Campos de enumeração para itens de pesquisa incremental.
| Membro | Valor | Descrição |
|---|---|---|
| ContentItem | 0 | Itens de dados com conteúdo para ingerir. Por exemplo: o conteúdo de um site. |
| LinkItem | 1 | Ligar a um item de conteúdo que será utilizado em pesquisas subsequentes. Por exemplo: uma ligação para um site ou uma pasta. |
| DeletedItem | 2 | Item que foi eliminado da origem de dados e que deve ser eliminado do índice. |
IncrementalCrawlItem
Representa uma entidade na origem de dados. Por exemplo: um ficheiro, uma pasta ou um registo numa tabela.
| Propriedade | Tipo | Descrição |
|---|---|---|
| itemId | string | Mostra o ID exclusivo que representa o item na origem de dados. |
| contentItem | ContentItem | Mostra um item de dados com conteúdo para ingerir. Por exemplo: o conteúdo de um site. |
| linkItem | LinkItem | Ligar a um item de conteúdo que será utilizado em pesquisas subsequentes. Por exemplo: uma ligação para um site ou uma pasta. |
| deletedItem | DeletedItem | Item eliminado da origem de dados e que deve ser removido do índice. Se deletedItem estiver definido, contentItem ou linkItem não pode ser definido. |
| itemType | ItemType | Mostra o tipo de item que está a ser enviado. Este modelo deve ter um contentItem ou um conjunto linkItem e este campo de enumeração deve corresponder a esse item. |
Observação
- As propriedades linkItem, contentItem e deletedItem são mutuamente exclusivas.
ContentItem
Item que contém o conteúdo da entidade de origem de dados a ingerir. Por exemplo: o conteúdo de um site.
| Propriedade | Tipo | Descrição |
|---|---|---|
| propertyValues | SourcePropertyValueMap | Contém a chave e os valores de cada propriedade no item. |
| accessList | AccessControlList | Restringe o acesso ao item a utilizadores ou grupos específicos. |
| conteúdo | Conteúdo | Mostra a propriedade de conteúdo do item que pode ser utilizado ao apresentar os resultados da pesquisa. |
LinkItem
Item que funciona como uma ligação para outro item. Estes itens de ligação serão enviados novamente para o conector para recrawl; por exemplo, num conteúdo de pasta, os ficheiros serão itens de conteúdo e as subpastas serão itens de ligação.
| Propriedade | Tipo | Descrição |
|---|---|---|
| metadados | cadeia de mapa<, GenericType> | Contém os metadados necessários para o conector voltar a rabiscar o item. |
DeletedItem
Representa um item que foi eliminado da origem de dados e que tem de ser removido do índice.
AccessControlList
Restringe os utilizadores que podem ver os resultados da pesquisa.
| Propriedade | Tipo | Descrição |
|---|---|---|
| Entradas | AccessControlEntry repetido | Mostra a matriz ou coleção de entradas de lista de controlo de acesso. |
Membros de enumeração AclAccessType
Enumerar membros do tipo de lista de controlo de acesso.
| Membro | Valor | Descrição |
|---|---|---|
| Nenhum | 0 | Indica o valor predefinido: negar. |
| Conceder | 1 | A entrada destina-se a utilizadores/grupos com acesso ao item. |
| Negar | 2 | A entrada destina-se a utilizadores/grupos sem acesso ao item e substitui a concessão para qualquer utilizador/grupo. |
AccessControlEntry
Contém entradas de controlo de acesso individuais.
| Propriedade | Tipo | Descrição |
|---|---|---|
| accessType | AclAccessType | Mostra o tipo de acesso da entidade conceder ou negar. |
| principal | Principal | Representa um grupo ou utilizador com acesso definido. |
Membros da enumeração PrincipalType
Enumeração de membros do tipo principal.
| Membro | Valor | Descrição |
|---|---|---|
| PT_None | 0 | Indica o valor predefinido: utilizador. |
| Usuário | 1 | Tipo de utilizador. |
| Group | 2 | Tipo de grupo. |
| Todos | 3 | Grupo especial para conceder acesso a todos. |
| TodosExceptGuests | 4 | Grupo especial para conceder acesso a todos, exceto convidados. |
Membros de enumeração do IdentitySource
Enumeração de membros da origem de identidade.
| Membro | Valor | Descrição |
|---|---|---|
| IS_None | 0 | Indica o valor predefinido: Microsoft Entra ID. |
| AzureActiveDirectory | 1 | A origem da identidade é Microsoft Entra ID. |
Membros de enumeração IdentityType
Enumeração de membros do tipo de identidade.
| Membro | Valor | Descrição |
|---|---|---|
| IT_None | 0 | Indica o valor predefinido: (Azure ADId). |
| ActiveDirectorySId | 1 | SID (Identificador de segurança no local) fornecido pelo Active Directory (AD). |
| UserPrincipalName | 2 | Nome principal de utilizador (UPN). |
| AadId | 3 | Azure ADId. |
Principal
Estrutura para armazenar atributos do principal (utilizador/grupo).
| Propriedade | Tipo | Descrição |
|---|---|---|
| type | PrincipalType | Tipo de principal. |
| valor | string | Valor principal: o valor do SID, UPN, Azure ADId, etc. |
| identitySource | IdentitySource | A origem da identidade. |
| identityType | IdentityType | Tipo de representação de identidade. |
| identitySourceProperties | cadeia de mapa<, cadeia> | Metadados sobre a origem da identidade. |
SourcePropertyValueMap
Mapa da chave de propriedade de origem e do respetivo valor na origem de dados. Armazena o valor da propriedade de cada item.
| Propriedade | Tipo | Descrição |
|---|---|---|
| values | cadeia de mapa<, GenericType> | Contém a chave e os valores das propriedades do item. A chave é o nome da propriedade e o valor é o valor da propriedade. Por exemplo, o conteúdo do ficheiro tem propriedades como título, modifiedDate, etc. As chaves de propriedades serão as próprias propriedades e os respetivos valores serão o título do ficheiro e da data de modificação do ficheiro, respetivamente. |
Membros de enumeração ContentType
Enumerar membros do tipo de conteúdo.
| Membro | Valor | Descrição |
|---|---|---|
| Nenhum | 0 | Valor predefinido. |
| Texto | 1 | Tipo de conteúdo de texto. |
| Html | 2 | Tipo de conteúdo HTML. |
Conteúdo
Valor da propriedade de conteúdo do item, utilizado para compor os resultados da pesquisa.
| Propriedade | Tipo | Descrição |
|---|---|---|
| contentType | ContentType | Tipo de conteúdo. |
| contentValue | string | Valor da propriedade content. |
CrawlCheckpoint
Identifica o item que foi pesquisado pela última vez. Será guardado pela plataforma e o ponto de verificação do último lote de itens com êxito será utilizado para retomar a pesquisa se ocorrer uma falha ou falha. A plataforma enviará o ponto de verificação na API GetCrawlStream .
| Propriedade | Tipo | Descrição |
|---|---|---|
| número de página | int32 | Mostra o número de página para marcar o progresso da pesquisa. |
| batchSize | int32 | Contém o número de itens devolvidos em cada lote. Tem um valor constante de 1 porque cada item é transmitido individualmente. |
| customMarkerData | string | Dados personalizados necessários para identificar o último item pesquisado a partir da origem de dados. |
GenericType
Modelo para conter os tipos de valores suportados pela plataforma em determinados campos, como valores de propriedade de origem. Apenas um dos seguintes campos tem de ser definido.
| Propriedade | Tipo | Descrição |
|---|---|---|
| stringValue | string | Representa um valor de cadeia. |
| intValue | int64 | Representa um valor int64 (longo). |
| valor duplo | double | Representa um valor duplo. |
| dateTimeValue | google.protobuf.Timestamp | Representa um valor dateTime. |
| valor bool | bool | Representa um valor booleano. |
| stingCollectionValue | StringCollectionType | Representa uma coleção de cadeias. |
| intCollectionValue | IntCollectionType | Representa uma coleção de int64 (longo). |
| doubleCollectionValue | DoubleCollectionType | Representa uma coleção de duplos. |
| dateTimeCollectionValue | TimestampCollectionType | Representa uma coleção de dateTime. |
StringCollectionType
Coleção de cadeias.
| Propriedade | Tipo | Descrição |
|---|---|---|
| values | cadeia repetida | Coleção ou matriz de cadeias. |
IntCollectionType
Coleção de valores inteiros.
| Propriedade | Tipo | Descrição |
|---|---|---|
| values | int64 repetido | Coleção ou matriz de valores int64 (longos). |
DoubleCollectionType
Coleção de valores duplos.
| Propriedade | Tipo | Descrição |
|---|---|---|
| values | duplo repetido | Coleção ou matriz de valores duplos. |
TimestampCollectionType
Coleção de valores DateTime .
| Propriedade | Tipo | Descrição |
|---|---|---|
| values | repetida google.protobuf.Timestamp | Coleção ou matriz de valores dateTime . |