Sugerencia de búsqueda de Dataverse

Este ejemplo es de la muestra de SDK para operaciones de búsqueda de .NET en GitHub. El método estático OutputSearchSuggest devuelve las tres sugerencias principales para cualquier término de búsqueda.

/// <summary>
/// Demonstrate suggest API
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance to use.</param>
/// <param name="searchTerm">The term to use</param>
/// <returns></returns>
static void OutputSearchSuggest(IOrganizationService service, string searchTerm)
{
    Console.WriteLine("OutputSearchSuggest START\n");

    searchsuggestRequest request = new()
    {
        search = searchTerm,
        top = 3
    };

    var searchsuggestResponse = (searchsuggestResponse)service.Execute(request);

    SearchSuggestResults results = JsonConvert.DeserializeObject<SearchSuggestResults>(searchsuggestResponse.response);

    results.Value?.ForEach(suggestion =>
    {
        Console.WriteLine($"\tText:{suggestion.Text}");
        Console.WriteLine("\tDocument: ");
        foreach (string key in suggestion.Document.Keys)
        {
            Console.WriteLine($"\t\t{key}: {suggestion.Document[key]}");
        }
        Console.WriteLine();
    });

    Console.WriteLine("OutputSearchSuggest END\n");
}

Salida

Cuando invoca el método OutputSearchSuggest con una instancia autenticada de la clase ServiceClient con searchTerm establecido en "Cont":

OutputSearchSuggest(service: serviceClient, searchTerm: "Cont");

El resultado deberá ser ahora similar a esto:

OutputSearchSuggest START

        Text:{crmhit}cont{/crmhit}act
        Document:
                @search.objectid: 9335eda1-ef69-ee11-9ae7-000d3a88a4a2
                @search.entityname: contact
                @search.objecttypecode: 2
                fullname: Yvonne McKay (sample)

        Text:{crmhit}cont{/crmhit}act
        Document:
                @search.objectid: 9535eda1-ef69-ee11-9ae7-000d3a88a4a2
                @search.entityname: contact
                @search.objecttypecode: 2
                fullname: Susanna Stubberod (sample)

        Text:{crmhit}cont{/crmhit}act
        Document:
                @search.objectid: 9735eda1-ef69-ee11-9ae7-000d3a88a4a2
                @search.entityname: contact
                @search.objecttypecode: 2
                fullname: Nancy Anderson (sample)

OutputSearchSuggest END

Clases de apoyo

El método OutputSearchSuggest depende de las siguientes clases de soporte para enviar la solicitud y procesar el resultado.

Clases searchsuggestRequest y searchsuggestResponse

Estas clases se generan usando el comando Power Platform CLI pac modelbuilder build como se describe en Generar clases enlazadas anticipadamente para el SDK para .NET.

Clase ErrorDetail

Esta clase es la misma clase ErrorDetail utilizada para el ejemplo de consulta.

Clase SuggestResults

Se usa para deserializar los datos de la propiedad searchsuggestResponse.response.

class SearchSuggestResults
{
   /// <summary>
   /// Provides error information from Azure Cognitive search.
   /// </summary>
   [JsonProperty(PropertyName = "Error")]
   public ErrorDetail? Error { get; set; }

   /// <summary>
   /// A collection of matching records.
   /// </summary>
   public List<SuggestResult>? Value { get; set; }

   /// <summary>
   /// The query context returned as part of response. This property is used for backend search, this is included for future feature releases, it is not currently used.
   /// </summary>
   public QueryContext? QueryContext { get; set; }
}

Clase SuggestResult

Objeto de resultado para sugerir resultados.

public sealed class SuggestResult
{
   /// <summary>
   /// Gets or sets the text.
   /// </summary>
   [JsonProperty(PropertyName = "text")]
   public string Text { get; set; }

   /// <summary>
   /// Gets or sets document.
   /// </summary>
   [JsonProperty(PropertyName = "document")]
   public Dictionary<string, object> Document { get; set; }
}

Clase QueryContext

Esta clase es la misma clase QueryContext utilizada para el ejemplo de consulta.

Utilice la acción searchsuggest para recibir un tipo complejo searchsuggestResponse.

Este ejemplo es de la muestra de API web para operaciones de búsqueda en GitHub.

Solicitar

POST [Organization Uri]/api/data/v9.2/searchsuggest
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json
Content-Type: application/json; charset=utf-8
Content-Length: 142

{
  "orderby": "null",
  "options": "null",
  "fuzzy": false,
  "search": "Cont",
  "filter": null,
  "entities": "null",
  "top": 3
}

Response

HTTP/1.1 200 OK
CRM.ServiceId: framework
OData-Version: 4.0

{
  "@odata.context": "[Organization Uri]/api/data/v9.2/$metadata#Microsoft.Dynamics.CRM.searchsuggestResponse",
  "response": "{\"Error\":null,\"Value\":[{\"Text\":\"{crmhit}cont{/crmhit}act\",\"Document\":{\"@search.objectid\":\"9335eda1-ef69-ee11-9ae7-000d3a88a4a2\",\"@search.entityname\":\"contact\",\"@search.objecttypecode\":2,\"fullname\":\"Yvonne McKay (sample)\"}},{\"Text\":\"{crmhit}cont{/crmhit}act\",\"Document\":{\"@search.objectid\":\"9535eda1-ef69-ee11-9ae7-000d3a88a4a2\",\"@search.entityname\":\"contact\",\"@search.objecttypecode\":2,\"fullname\":\"Susanna Stubberod (sample)\"}},{\"Text\":\"{crmhit}cont{/crmhit}act\",\"Document\":{\"@search.objectid\":\"9735eda1-ef69-ee11-9ae7-000d3a88a4a2\",\"@search.entityname\":\"contact\",\"@search.objecttypecode\":2,\"fullname\":\"Nancy Anderson (sample)\"}}],\"QueryContext\":null}"
}

Los datos JSON sin escape en la propiedad de respuesta se ven así:

{
  "Error": null,
  "Value": [
    {
      "Text": "{crmhit}cont{/crmhit}act",
      "Document": {
        "@search.objectid": "9335eda1-ef69-ee11-9ae7-000d3a88a4a2",
        "@search.entityname": "contact",
        "@search.objecttypecode": 2,
        "fullname": "Yvonne McKay (sample)"
      }
    },
    {
      "Text": "{crmhit}cont{/crmhit}act",
      "Document": {
        "@search.objectid": "9535eda1-ef69-ee11-9ae7-000d3a88a4a2",
        "@search.entityname": "contact",
        "@search.objecttypecode": 2,
        "fullname": "Susanna Stubberod (sample)"
      }
    },
    {
      "Text": "{crmhit}cont{/crmhit}act",
      "Document": {
        "@search.objectid": "9735eda1-ef69-ee11-9ae7-000d3a88a4a2",
        "@search.entityname": "contact",
        "@search.objecttypecode": 2,
        "fullname": "Nancy Anderson (sample)"
      }
    }
  ],
  "QueryContext": null
}

Los parámetros y el valor de respuesta usando el punto de conexión de búsqueda 2.0 son idénticos a los de la API web, solo la URL es diferente.

Solicitar

POST [Organization Uri]/api/search/v2.0/suggest