Búsqueda con autocompletado de Dataverse

Este ejemplo es de la muestra de SDK para operaciones de búsqueda de .NET en GitHub. El método estático OutputAutoComplete acepta un valor para el parámetro de búsqueda.

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

    searchautocompleteRequest request = new()
    {
        search = searchTerm,
        filter = null,
        fuzzy = true,
        entities = JsonConvert.SerializeObject(new List<SearchEntity>()
            {
                new SearchEntity()
                {
                    Name = "account",
                    SelectColumns = new List<string>() { "name", "createdon" },
                    SearchColumns = new List<string>() { "name" },
                }
            }
        )
    };

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

    SearchAutoCompleteResults results = JsonConvert.DeserializeObject<SearchAutoCompleteResults>(searchautocompleteResponse.response);

    Console.WriteLine($"\tSearch: {request.search}");
    Console.WriteLine($"\tValue: {results.Value}");

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

Salida

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

OutputAutoComplete(service: serviceClient, searchTerm: "Con");

El resultado deberá ser ahora similar a esto:

OutputAutoComplete START

        Search: Con
        Value: {crmhit}contoso{/crmhit}

OutputAutoComplete END

Clases de apoyo

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

Clases searchautocompleteRequest y searchautocompleteResponse

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 SearchEntity

Esta clase es la misma clase SearchEntity utilizada para el ejemplo de consulta. En este caso, la usa para establecer la propiedad searchautocompleteRequest.entities.

Clase SearchAutoCompleteResults

Úsela para deserializar datos JSON de la propiedad de cadena searchautocompleteResponse.response.

class SearchAutoCompleteResults
{
   /// <summary>
   /// The Azure Cognitive error detail returned as part of response.
   /// </summary>
   public ErrorDetail? Error {  get; set; }

   /// <summary>
   /// The text
   /// </summary>
   public string? Value { get; set; }

   /// <summary>
   /// This request is used for backend search, this is included for future feature releases, it is not currently used.
   /// </summary>
   public QueryContext? QueryContext { get; set; }
}

Clase ErrorDetail

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

Clase QueryContext

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

Utilice la acción de búsqueda automática para recibir un tipo complejo de respuesta de búsqueda automática.

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

El JSON formateado y sin escape pasado al parámetro string entities se ve así:

[
  {
    "Name": "account",
    "SelectColumns": ["name", "createdon"],
    "SearchColumns": ["name"],
    "Filter": null
  }
]

Solicitar

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

{
  "entities": "[{\"Name\":\"account\",\"SelectColumns\":[\"name\",\"createdon\"],\"SearchColumns\":[\"name\"],\"Filter\":null}]",
  "search": "Con",
  "fuzzy": true,
  "filter": null
}

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.searchautocompleteResponse",
  "response": "{\"Error\":null,\"Value\":\"{crmhit}contoso{/crmhit}\",\"QueryContext\":null}"
}

El valor de propiedad JSON response formateado y sin escape tiene este aspecto:

{
  "Error": null,
  "Value": "{crmhit}contoso{/crmhit}",
  "QueryContext": null
}

Los parámetros de solicitud y la respuesta del punto de conexión de search/v2.0/autocomplete son los mismos que los de la API web. Solo la URL es diferente.

Solicitar URL

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