dotnet | azure-cognitive-search

Azure Cognitive Search - GeographyPoint to GeoJSON in .NET 5

Microsoft.Spatial GeographyPoint to GeoJSON in .NET5 using System.Text.Json.

Abhith Rajan
Abhith RajanMarch 13, 2021 · 2 min read · Last Updated:

Azure Cognitive Search Service supported data types includes Edm.GeographyPoint.

While creating index definition using attributes in C#, to specify the field type as Edm.GeographyPoint we can use the GeographyPoint as the type.

1using Azure.Search.Documents.Indexes;
2using Microsoft.Spatial;
4public class RestaurantIndexModel
6 ...
8 [SimpleField(IsFilterable = true, IsSortable = true)]
9 public GeographyPoint Location { get; set; }
11 ...

We need to have the NuGet package Microsoft.Spatial to use the GeographyPoint type.

1<PackageReference Include="Microsoft.Spatial" Version="7.8.3" />

And with that, you can create the index definition,

Index definition
Index definition

But when you try to index a document with the same type,

1restaurant.Location = GeographyPoint.Create(restaurantResult.Value.Latitude, restaurantResult.Value.Longitude);

You may encounter the following issue,

{“error”:{“code”:"",“message”:“The request is invalid. Details: parameters : Invalid GeoJSON. The ‘type’ member is required, but was not found.\r\n”}}

The way you can fix this is by,

  1. Add the following NuGet package,
1<PackageReference Include="Microsoft.Azure.Core.Spatial" Version="1.0.0" />

And then annotate your index model to use the MicrosoftSpatialGeoJsonConverter as the JsonConverter by,

1using System.Text.Json.Serialization;
2using Azure.Core.Serialization;
3using Azure.Search.Documents.Indexes;
4using Microsoft.Spatial;
6public class RestaurantIndexModel
8 ...
10 [JsonConverter(typeof(MicrosoftSpatialGeoJsonConverter))]
11 [SimpleField(IsFilterable = true, IsSortable = true)]
12 public GeographyPoint Location { get; set; }
14 ...

That will do.

Indexd document
Indexd document

Additional Resources

This page is open source. Noticed a typo? Or something unclear?
Improve this page on GitHub

Abhith Rajan

Written byAbhith Rajan
Abhith Rajan is a software engineer by day and a full-stack developer by night. He's coding for almost a decade now. He codes 🧑‍💻, write ✍️, learn 📖 and advocate 👍.

Is this page helpful?

Related ArticlesView All

Related VideosView All

How slow is MediatR really?

Stop choosing the “wrong” .NET version

Why .NET's memory cache is kinda flawed

Related Tools & ServicesView All

Try .NET | Runnable .NET code on your site

Try .NET is a service that allows you to embed runnable .NET code snippets into your website, blog, or documentation. Go beyond copy and paste samples to live snippets.