Dataverse 検索のオートコンプリート

これは、GitHub の SDK for .NET 検索操作のサンプルからの例です。 OutputAutoComplete 静的メソッドは、search パラメーターの値を受け入れます。

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

出力

searchTerm を「Con」に設定して ServiceClient クラスの認証されたインスタンスで OutputAutoComplete メソッドを呼び出す場合。

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

出力は次のようになります。

OutputAutoComplete START

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

OutputAutoComplete END

サポートするクラス

OutputAutoComplete メソッドは、次のサポートするクラスに基づいて要求を送信し、結果を処理します。

searchautocompleteRequest と searchautocompleteResponse クラス

これらのクラスは、.NET 用 SDK の事前バインド クラスを生成するで説明されているように、Power Platform CLI pac modelbuilder build コマンドを使用して生成されます。

SearchEntity クラス

このクラスは、クエリの例 で使用されたのと同じ SearchEntity クラスです。 この場合、searchautocompleteRequest.entities プロパティを設定することができます。

SearchAutoCompleteResults クラス

searchautocompleteResponse.response 文字列プロパティから JSON データを逆シリアル化するために使用します。

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

ErrorDetail クラス

このクラスは、クエリの例 で使用されたのと同じ ErrorDetail クラスです。

QueryContext クラス

このクラスは、クエリの例 で使用されたのと同じ QueryContext クラスです。

searchautocomplete アクションを使用して、searchautocompleteResponse 複合型を受け取ります。

これは、GitHub の Web API 検索操作のサンプルからの例です。

文字列の entities パラメーターに渡される、エスケープされずに書式設定された JSON は、次のようになります。

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

Request

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
}

回答

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

エスケープされずに書式設定された JSON の response プロパティの値は、次のようになります。

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

search/v2.0/autocomplete エンドポイントからの要求パラメーターと応答は Web API と同じです。 URL が違うだけです。

要求 URL

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