Dataverse Search suggest

This example is from the SDK for .NET search operations sample on GitHub. The static OutputSearchSuggest method returns the top three suggestions for any search term.

/// <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");
}

Output

When you invoke the OutputSearchSuggest method with an authenticated instance of the ServiceClient class with the searchTerm set to "Cont":

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

The output looks something like the following:

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

Supporting classes

The OutputSearchSuggest method depends on the following supporting classes to send the request and process the result.

searchsuggestRequest and searchsuggestResponse classes

These classes are generated using Power Platform CLI pac modelbuilder build command as described in Generate early-bound classes for the SDK for .NET.

ErrorDetail class

This class is the same ErrorDetail class used for the query example.

SuggestResults class

Used to deserialize the data from the searchsuggestResponse.response property

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; }
}

SuggestResult class

Result object for suggest results.

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; }
}

QueryContext class

This class is the same QueryContext class used for the query example.

Use the searchsuggest action to receive a searchsuggestResponse complex type.

This example is from the Web API search operations sample on GitHub.

Request

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}"
}

The unescaped JSON data in the response property looks like this:

{
  "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
}

The parameters and response value using the search 2.0 endpoint are identical to the Web API, only the URL is different.

Request

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