Utiliser l’API Microsoft Search pour rechercher des types personnalisés importés à l’aide de connecteurs Microsoft GraphUse the Microsoft Search API to search custom types imported using Microsoft Graph connectors

Utiliser l’API Microsoft Search pour effectuer une recherche dans le contenu ingéré et indexé par les connecteurs Microsoft Graph.Use the Microsoft Search API to search accross content ingested and indexed by Microsoft Graph connectors. Le contenu est importé soit via des connecteurs intégrés fournis par Microsoft, soit via des connecteurs personnalisés implémentés à l’aide de l’API d’ingestion des connecteurs Microsoft Graph.The content is imported either via built-in connectors provided by Microsoft, or via custom connectors implemented using the Microsoft Graph connectors ingestion API.

Important

Les connecteurs Microsoft Graph sont actuellement à l’état de préversion publique.Microsoft Graph connectors are currently in public preview status. Pour accéder à la fonctionnalité de connecteurs, vous devez activer l’option Publication ciblée dans votre client.To gain access to connectors functionality, you must turn on the Targeted release option in your tenant. Pour plus d’informations, voir le programme de la préversion des connecteurs.See more details on the connectors preview program.

Attention

Le schéma de l’API de recherche a été modifié avec certaines propriétés dans une demande de recherche et une réponse renommée ou supprimée.The search API schema has changed with some properties in a search request and response renamed or removed. Voir plus de détails sur la désapprobation.See more details about the deprecation. Les exemples de cette rubrique montrent le schéma à utiliser pour l’avenir.Examples in this topic show the schema to use going forward.

Une fois que le contenu a été importé et indexé, vous pouvez utiliser l’API de recherche pour interroger le contenu.Once the content has been imported and indexed, you can use the search API to query the content.

Pour rechercher des types personnalisés, spécifiez les propriétés suivantes dans le corps de la requête de la méthode query :To search for custom types, specify the following properties in the request body of the query method:

  • La propriété contentSources pour inclure l’ID de connexion qui est affecté lors de l’installation du connecteur.The contentSources property to include the connection ID that is assigned during the connector setup. Vous pouvez transmettre plusieurs ID de connexion pour effectuer une recherche sur plusieurs connexions.You can pass multiple connection IDs to search across multiple connections. Les résultats sont renvoyés dans une seule liste, classés sur les différentes connexions.Results are returned in a single list, ranked accross the multiple connections.
  • La propriété EntityTypes en tant que externalItem .The entityTypes property as externalItem.

  • La propriété Fields pour inclure les champs dans l’élément externe à récupérer.The fields property to include the fields in the external item to retrieve.

ExempleExample

Dans cet exemple, le contenu de la base de données AdventureWorks a été ingéré à l’aide du connecteur intégré SQL Azure.In this example, the content of the AdventureWorks database has been ingested using the Azure SQL built-in connector.

DemandeRequest

POST https://graph.microsoft.com/beta/search/query
Content-Type: application/json

{
  "requests": [
    {
      "entityTypes": [
        "externalItem"
      ],
      "contentSources": [
          "/external/connections/azuresqlconnector",
          "/external/connections/azuresqlconnector2"
      ],
      "query": {
        "queryString": "yang"
      },
      "from": 0,
      "size": 25,
      "fields": [
        "BusinessEntityID",
        "firstName",
        "lastName"
      ]
    }
  ]
}

RéponseResponse

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.searchResponse)",
  "value": [
    {
      "searchTerms": ["ya"],
      "hitsContainers": [
        {
          "total": 2,
          "moreResultsAvailable": false,
          "hits": [
            {
              "hitId": "AAMkADc0NDNlNTE0",
              "rank": 1,
              "summary": "<ddd/>",
              "contentSource": "/external/connections/azuresqlconnector",
              "resource": {
                "@odata.type": "#microsoft.graph.externalItem",
                "properties": {
                  "businessEntityID": 20704,
                  "firstName": "Amy",
                  "lastName": "Yang"
                }
              }
            },
           {
              "hitId": "AQMkADg3M2I3YWMyLTEwZ",
              "rank": 2,
              "summary": "<ddd/>",
              "contentSource": "/external/connections/azuresqlconnector2",
              "resource": {
                "@odata.type": "#microsoft.graph.externalItem",
                "properties": {
                  "businessEntityID": 20704,
                  "shortdescription": "Contoso maintenance guidelines",
                  "firstName": "Amy",
                  "lastName": "Yang"
                }
              }
            },
          ]
        }
      ]
    }
  ]
}

Limitations connuesKnown limitations

  • Vous devez spécifier la propriété Fields pour obtenir les champs récupérables dans le schéma de recherche.You must specify the fields property to get retrievable fields in the search schema.

Étapes suivantesNext steps