Conectores Copilot SDK modelos comuns

Este artigo descreve os modelos comuns usados no SDK dos conectores do Microsoft 365 Copilot (anteriormente conectores do Microsoft Graph).

CustomConfiguration

A Administração de Pesquisa fornece as informações de configuração personalizada específicas do conector durante a criação da conexão. A plataforma não gerencia a estrutura e o formato da configuração. Os desenvolvedores de conectores podem usar um formato de sua escolha.

Propriedade Tipo Descrição
configuração string Contém as informações de configuração como uma cadeia de caracteres. O conector deve ter a capacidade de interpretar o conteúdo da cadeia de caracteres.

Membros da enumeração AuthenticationType

A tabela a seguir lista os membros da enumeração AuthenticationType .

Membro Valor Descrição
Anônimo 0 Nenhuma autenticação é necessária para acessar a fonte de dados.
Básica 1 Autenticação Básica na forma de nome de usuário e senha para acessar a fonte de dados.
Windows 2 A autenticação baseada no Windows Active Directory suporta nome de usuário, senha e informações de domínio.
oAuth2ClientCredential 3 Autenticação baseada em OAuth2 com credenciais de cliente. Ele dá suporte à ID do aplicativo e ao segredo do aplicativo.

AuthenticationData

Contém credenciais fornecidas pelo administrador para acessar a fonte de dados, incluindo o tipo de autenticação, a URL da fonte de dados e os dados de credenciais.

Propriedade Tipo Descrição
authType AuthenticationType Tipo de informações de autenticação mantidas neste objeto.
DatasourceUrl string URL ou caminho para acessar a fonte de dados - caminho para o recurso que precisa ser rastreado. Exemplo: cadeia de conexão para um banco de dados.
basicCredential BasicCredential Credenciais na forma de nome de usuário e senha para acessar a fonte de dados. Essa propriedade será definida exclusivamente como windowsCredential e o authType será definido como Básico quando essa propriedade for definida.
windowsCredential WindowsCredential Credenciais na forma de nome de usuário, senha e domínio do Windows AD para acessar a fonte de dados. Essa propriedade será definida exclusivamente como basicCredential e o authType será definido como Windows quando essa propriedade for definida.
oAuth2ClientCredential oAuth2ClientCredential Credenciais na forma de ID do aplicativo e segredo do aplicativo para autenticação baseada em credenciais do cliente OAuth para acessar a fonte de dados. Essa propriedade será definida exclusivamente como oAuth2ClientCredential e o authType será definido como oAuth2ClientCredential quando essa propriedade for definida.

BasicCredential

Representa o modelo de credenciais básicas.

Propriedade Tipo Descrição
username string Nome de usuário para acessar a fonte de dados.
Segredo string Segredo a ser usado com o nome de usuário para acessar a fonte de dados.

WindowsCredential

Representa o modelo de credenciais do Windows.

Propriedade Tipo Descrição
username string Nome de usuário para acessar a fonte de dados.
Segredo string Segredo a ser usado com o nome de usuário para acessar a fonte de dados.
domínio string Active Directory da conta. Se não for fornecida explicitamente pelo administrador, essa propriedade manterá o valor do nome do computador.

oAuth2ClientCredential

Representa o modelo de credencial para credenciais de cliente OAuth2.

Propriedade Tipo Descrição
appId string ID do aplicativo/ID do cliente para o aplicativo OAuth2.
appSecret Cadeia de caracteres Segredo do aplicativo/segredo do cliente do aplicativo OAuth2.
oAuth2ClientCredentialResponse oAuth2ClientCredentialResponse Contém detalhes relacionados ao token OAuth. Essa propriedade será definida como a resposta que o conector envia após a primeira chamada de autenticação de validação ser bem-sucedida.

oAuth2ClientCredentialResponse

Representa o modelo de resposta do servidor de autenticação para a solicitação de token OAuth2. Os campos presentes nesse modelo são os campos de resposta comuns especificados na documentação do OAuth2. Além disso, idToken pode ser definido quando os servidores de autenticação dão suporte a OpenIDConnect.

Propriedade Tipo Descrição
accessToken string O token de acesso do servidor de autenticação.
refreshToken string O token de atualização se o servidor de autenticação o enviar.
tokenType string Tipo do token – geralmente token de portador para OAuth.
expiresIn uint64 O tempo de expiração do token no carimbo de data/hora do Unix.
scope string Escopos com suporte do token se o servidor de autenticação o enviar.
idToken string O token de ID se o servidor de autenticação der suporte à conexão de ID aberta.

OperationResult

A enumeração OperationResult contém os valores possíveis para os resultados da operação.

Membro Valor Descrição
Êxito 0 A operação foi bem-sucedida sem nenhum erro.
Sucesso Parcial 1 A operação foi bem-sucedida, mas há uma mensagem de aviso a ser processada.
ValidationFailure 2 Uma ou mais validações falharam.
AuthenticationIssue 3 As credenciais fornecidas não funcionaram.
DatasourceError 4 Erro de leitura da fonte de dados.
Erro de rede 5 Erro de operação de rede.
Cancelado 6 O token de cancelamento cancelou a operação.
TokenExpired 7 A ser usado no fluxo OAuth quando o token enviado ao conector pela plataforma tiver expirado. Durante o rastreamento, ao receber esse status, a plataforma disparará o fluxo de token de atualização e chamará o método RefreshAccessToken no ConnectorOAuthService.
SkipItem 8 Para ser usado no fluxo de rastreamento quando o item deve ser ignorado.

OperationStatus

Representa o status de uma operação, incluindo erros/avisos e detalhes de repetição. Esse modelo faz parte da resposta de todas as APIs no ConnectionManagementService e no ConnectorCrawlerService.

Propriedade Tipo Descrição
resultado OperationResult Resultado da operação.
statusMessage string Mensagem personalizada que pode ser usada para fins de registro em log e monitoramento.
retryInfo RetryDetails Tente novamente as informações a serem usadas pela estrutura para repetir a mesma operação para uma operação com falha. Se a operação for bem-sucedida ou parcialmente bem-sucedida, ela será ignorada.

Membros da enumeração RetryType

Essa enumeração é usada para definir a estratégia para repetir em caso de erros.

Membro Valor Descrição
NoRetry 0 Nenhuma nova tentativa precisa ser feita.
Padrão 1 Standard nova tentativa com tempo de espera linear será feita.
ExponentialBackOff 2 Uma nova tentativa por retirada exponencial será feita.

RetryDetails

Esse modelo é usado para comunicar a política de repetição em que a repetição é necessária.

Propriedade Tipo Descrição
type RetryType O tipo de repetição define o tipo de estratégia de repetição necessária para o erro.
numberOfRetries uint32 Número de tentativas a serem feitas para a exceção.
pauseBetweenRetriesInMilliseconds uint64 Obtém uma pausa entre as tentativas no caso de novas tentativas padrão.
coeficiente de retirada flutuação Obtém o coeficiente usado no cálculo da Retirada Exponencial.
Taxa de retorno flutuação Obtém o backoffRate usado no cálculo do Recuo Exponencial.

DataSourceSchema

Representa o esquema das propriedades que representam uma entidade de dados na fonte de dados. Para obter detalhes, consulte tipo de recurso de esquema.

Propriedade Tipo Descrição
PropertyList repetido SourcePropertyDefinition Representa a lista de propriedades que definem um item na fonte de dados.

Membros da enumeração SourcePropertyType

Membro Valor Descrição
Cadeia de caracteres 0 Propriedade do tipo string.
Int64 1 Propriedade do tipo int64 (long).
Duplo 2 Propriedade do tipo double.
DateTime 3 Propriedade do tipo DateTime.
Booliano 4 Propriedade do tipo Boolean.
StringCollection 5 Propriedade do tipo de matriz ou coleção do tipo string.
Int64Collection 6 Propriedade do tipo de matriz ou coleção de tipo longo.
DoubleCollection 7 Propriedade do tipo de matriz ou coleção do tipo duplo.
DateTimeCollection 8 Propriedade do tipo de matriz ou coleção do tipo DateTime.

Membros da enumeração SearchAnnotations

Membro Valor Descrição
Nenhum 0 Nenhum
É pesquisável 1 Se uma propriedade for pesquisável, seu valor será adicionado ao índice de texto completo. Quando um usuário realiza uma pesquisa, os resultados são retornados se houver uma ocorrência de pesquisa em um dos campos pesquisáveis ou em seu conteúdo. Por exemplo, se a propriedade for "Autor", pesquisar "Smith" retornará itens cuja propriedade Author contém "Smith".
IsQueryable 2 Se uma propriedade for consultável, você poderá consultá-la usando a KQL (Linguagem de Consulta de Conhecimento). KQL consiste em uma ou mais palavras-chave de texto livre (palavras ou frases) ou restrições de propriedade. O nome da propriedade deve ser incluído na consulta, sendo especificado diretamente na consulta ou incluído de maneira programática. Você pode usar a correspondência de prefixo com o operador de caractere curinga(*). Por exemplo, se a propriedade for "Autor", a consulta de pesquisa poderá ser "Autor: Smith"
IsRetrievable 4 Se uma propriedade for recuperável, ela poderá retornar seu valor nos resultados da pesquisa. Qualquer propriedade que você queira adicionar ao modelo de exibição ou retornar da consulta e ser relevante nos resultados da pesquisa deve ser recuperável. Marcar propriedades grandes ou demais como recuperáveis aumentará a latência de pesquisa. Seja seletivo e escolha propriedades relevantes.
IsContent 8 A propriedade Content serve para identificar uma propriedade que pode ser indexada em texto completo. Os administradores escolherão entre as propriedades disponíveis, qual delas deve ser a propriedade a ser tratada como conteúdo para essa conexão específica. Para obter detalhes, consulte Propriedade Content.
IsRefinable 16 Se uma propriedade for refinável, um administrador poderá configurá-la como um filtro personalizado na página de resultados da Pesquisa da Microsoft. Uma propriedade refinável não pode ser pesquisável.

Observação

Se uma conexão tiver os rótulos semânticos Title e Url e qualquer propriedade de esquema na conexão estiver marcada como IsContent, o conteúdo do item será vetorizado no índice semântico.

SearchPropertyLabel

Os rótulos de propriedade de pesquisa são marcas conhecidas publicadas pela Microsoft que você pode adicionar a uma propriedade em seu esquema. Adicionar um rótulo semântico ajuda vários produtos da Microsoft a entender a propriedade e fornecer uma experiência melhor. Para obter detalhes, consulte Rótulos semânticos.

Membros da enumeração SearchPropertyLabel

Membro Valor Descrição
Título 0 O título do item que você deseja mostrar na pesquisa e em outras experiências.
Url 1 A URL de destino do item na fonte de dados.
CreatedBy 2 Nome da pessoa que criou o item na fonte de dados.
LastModifiedBy 3 Nome da pessoa que editou o item mais recentemente na fonte de dados.
Autores 4 Nome de todas as pessoas que participaram/colaboraram no item na fonte de dados.
DataeHoraDaCriação 5 Data e hora em que o item foi criado na fonte de dados.
DataeHoraDaÚltimaModificação 6 Data e hora em que o item foi modificado pela última vez na fonte de dados.
FileName 7 No caso de um arquivo, o nome do arquivo está na fonte de dados.
FileExtension 8 No caso de um arquivo, a extensão do arquivo está na fonte de dados.
LastModifiedByUpn 9 UPN da pessoa que editou mais recentemente o item na fonte de dados.
CreatedByUpn 10 UPN da pessoa que criou o item na fonte de dados.
AuthorsUpn 11 UPNs de todas as pessoas que participaram/colaboraram no item na fonte de dados.
UnknownFutureValue 12 Para se preparar para o futuro, seguindo as enumerações evolutivas do Microsoft Graph. Adicione todas as novas enumerações abaixo desta até que a versão da API principal seja alterada.
ContainerName 13 Nome do contêiner.
ContainerUrl 14 A URL do contêiner.
IconUrl 15 A URL de um ícone.

SourcePropertyDefinition

Define uma propriedade de fonte única para um item na fonte de dados. Para obter detalhes sobre definições de propriedade de esquema, consulte tipo de recurso de propriedade.

Propriedade Tipo Descrição
name string Nome da propriedade.
type SourcePropertyType Tipo de dados da propriedade.
defaultSearchAnnotations uint32 Anotações de pesquisa padrão para a propriedade.
requiredSearchAnnotations uint32 Anotações de pesquisa necessárias. Determinadas propriedades, como ID , são sempre definidas como isQueryabletrue e isRetrievabletrue.
defaultSemanticLabels SearchPropertyLabel repetido Lista de rótulos semânticos para a propriedade de origem.
Ordem int32 Ordem desta propriedade de origem. Usado pela interface do usuário para classificar os resultados da pesquisa. Opcional.
rótulo string Rótulo desta propriedade de origem. Usado pela interface do usuário de resultados de pesquisa para exibir o rótulo (nome legível). Opcional.
Aliases cadeia de caracteres repetida Lista de aliases desta propriedade de origem. Opcional.
  • Last updated on