Algolia.Search
7.1.0
See the version list below for details.
dotnet add package Algolia.Search --version 7.1.0
NuGet\Install-Package Algolia.Search -Version 7.1.0
<PackageReference Include="Algolia.Search" Version="7.1.0" />
paket add Algolia.Search --version 7.1.0
#r "nuget: Algolia.Search, 7.1.0"
// Install Algolia.Search as a Cake Addin #addin nuget:?package=Algolia.Search&version=7.1.0 // Install Algolia.Search as a Cake Tool #tool nuget:?package=Algolia.Search&version=7.1.0
<p align="center"> <a href="https://www.algolia.com"> <img alt="Algolia for C#" src="https://user-images.githubusercontent.com/22633119/59595424-10d10880-90f6-11e9-9303-823f70b39d6c.png" > </a>
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your .NET project</h4>
<p align="center"> <a href="https://www.nuget.org/packages/Algolia.Search/"><img src="https://img.shields.io/nuget/v/Algolia.Search.svg?style=flat-square" alt="Nuget"></img></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="Licence"></img></a> </p>
<p align="center"> <a href="https://www.algolia.com/doc/libraries/csharp/v7/" target="_blank">Documentation</a> • <a href="https://discourse.algolia.com" target="_blank">Community Forum</a> • <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> • <a href="https://github.com/algolia/algoliasearch-client-csharp/issues" target="_blank">Report a bug</a> • <a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/csharp/" target="_blank">FAQ</a> • <a href="https://alg.li/support" target="_blank">Support</a> </p>
✨ Features
- Targets .NET Standard:
.NET Standard 2.0
or.NET Standard 2.1
. - For more details about supported .NET implementations, please see .NET Standard official page.
- Asynchronous and synchronous methods to interact with Algolia's API.
- Thread-safe clients.
- No external dependencies.
- Typed requests and responses.
- Injectable HTTP client.
- Retry strategy & Helpers.
Migration note from v5.x to v6.x
In January 2019, we released v6 of our .NET client. If you are using version 5.x of the client, read the migration guide to version 6.x. Version 5.x will no longer be under active development.
💡 Getting Started
To get started, first install the Algolia.Search client.
You can get the last version of the client from NuGet.
If you are using the .NET CLI, you can install the package using the following command:
dotnet add package Algolia.Search --version <The version you want to install>
Or directly in your .csproj file:
<PackageReference Include="Algolia.Search" Version=${versions.csharp} />
You can now import the Algolia API client in your project and play with it.
using Algolia.Search.Clients;
using Algolia.Search.Http;
var client = new SearchClient(new SearchConfig("YOUR_APP_ID", "YOUR_API_KEY"));
// Add a new record to your Algolia index
var response = await client.SaveObjectAsync(
"<YOUR_INDEX_NAME>",
new Dictionary<string, string> { { "objectID", "id" }, { "test", "val" } }
);
// Poll the task status to know when it has been indexed
await client.WaitForTaskAsync("<YOUR_INDEX_NAME>", response.TaskID);
// Fetch search results, with typo tolerance
var response = await client.SearchAsync<Object>(
new SearchMethodParams
{
Requests = new List<SearchQuery>
{
new SearchQuery(
new SearchForHits
{
IndexName = "<YOUR_INDEX_NAME>",
Query = "<YOUR_QUERY>",
HitsPerPage = 50,
}
)
},
}
);
For full documentation, visit the Algolia CSharp API Client.
❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client. You can also open a GitHub issue
Contributing
This repository hosts the code of the generated Algolia API client for CSharp, if you'd like to contribute, head over to the main repository. You can also find contributing guides on our documentation website.
📄 License
The Algolia .NET API Client is an open-sourced software licensed under the MIT license.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.0)
- System.Text.Json (>= 8.0.2)
-
.NETStandard 2.1
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.0)
- System.Text.Json (>= 8.0.2)
NuGet packages (12)
Showing the top 5 NuGet packages that depend on Algolia.Search:
Package | Downloads |
---|---|
N3O.Umbraco.Search.Algolia
TODO |
|
ProjectToAlgoliaIndexManager
Package Description |
|
Kentico.Xperience.Algolia.KX13
Enables the creation of Algolia search indexes and the indexing of Xperience content tree pages using a code-first approach. |
|
uSync.Community.StaticSiteWithSearch.Algolia
An implementation of uSync.Community.StaticSiteWithSearch for the Algolia search appliance |
|
Umbraco.Cms.Integrations.Search.Algolia
An extension for Umbraco CMS providing a custom search engine integration with Algolia. |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on Algolia.Search:
Repository | Stars |
---|---|
Squidex/squidex
Headless CMS and Content Managment Hub
|
|
masastack/MASA.Blazor
Blazor UI component library based on Material Design. Support Blazor Server, Blazor WebAssembly and MAUI Blazor.
|
Version | Downloads | Last updated |
---|---|---|
7.3.1 | 0 | 9/12/2024 |
7.3.0 | 216 | 9/6/2024 |
7.2.4 | 268 | 9/3/2024 |
7.2.3 | 127 | 9/2/2024 |
7.2.2 | 198 | 8/29/2024 |
7.2.1 | 234 | 8/28/2024 |
7.2.0 | 147 | 8/27/2024 |
7.1.1 | 413 | 8/21/2024 |
7.1.0 | 277 | 8/20/2024 |
7.0.2 | 250 | 8/19/2024 |
7.0.0 | 413 | 8/14/2024 |
7.0.0-beta.16 | 61 | 8/9/2024 |
7.0.0-beta.15 | 103 | 8/8/2024 |
7.0.0-beta.14 | 61 | 8/8/2024 |
7.0.0-beta.13 | 31 | 8/6/2024 |
7.0.0-beta.12 | 83 | 8/1/2024 |
7.0.0-beta.11 | 61 | 7/26/2024 |
7.0.0-beta.10 | 57 | 7/19/2024 |
7.0.0-beta.9 | 148 | 7/12/2024 |
7.0.0-beta.8 | 216 | 7/1/2024 |
7.0.0-beta.7 | 56 | 6/27/2024 |
7.0.0-beta.6 | 62 | 6/26/2024 |
7.0.0-beta.5 | 57 | 6/21/2024 |
7.0.0-beta.4 | 56 | 6/13/2024 |
7.0.0-beta.3 | 46 | 6/11/2024 |
7.0.0-beta.2 | 93 | 5/17/2024 |
7.0.0-beta.1 | 101 | 4/23/2024 |
7.0.0-alpha.9 | 95 | 4/16/2024 |
7.0.0-alpha.8 | 54 | 4/9/2024 |
7.0.0-alpha.7 | 55 | 4/3/2024 |
7.0.0-alpha.6 | 3,132 | 3/25/2024 |
7.0.0-alpha.5 | 58 | 3/19/2024 |
7.0.0-alpha.4 | 66 | 3/13/2024 |
7.0.0-alpha.3 | 50 | 3/5/2024 |
7.0.0-alpha.2 | 54 | 2/29/2024 |
7.0.0-alpha.1 | 49 | 2/27/2024 |
7.0.0-alpha.0 | 69 | 2/20/2024 |
6.17.0 | 119,103 | 2/26/2024 |
6.16.0 | 88,790 | 11/20/2023 |
6.15.0 | 87,050 | 8/8/2023 |
6.14.0 | 278,282 | 11/8/2022 |
6.13.0 | 217,997 | 8/31/2022 |
6.12.1 | 409,534 | 2/14/2022 |
6.12.0 | 225,935 | 11/5/2021 |
6.11.0 | 21,970 | 10/19/2021 |
6.10.2 | 11,627 | 9/23/2021 |
6.10.1 | 100,262 | 6/2/2021 |
6.10.0 | 60,978 | 5/7/2021 |
6.9.1 | 136,255 | 1/28/2021 |
6.9.0 | 30,311 | 12/7/2020 |
6.8.0 | 75,089 | 8/17/2020 |
6.7.0 | 24,288 | 7/21/2020 |
6.6.0 | 71,729 | 4/1/2020 |
6.5.1 | 155,887 | 11/26/2019 |
6.5.0 | 2,558 | 11/6/2019 |
6.4.1 | 15,904 | 10/3/2019 |
6.4.0 | 9,734 | 8/30/2019 |
6.3.0 | 1,715 | 8/22/2019 |
6.2.0 | 19,262 | 6/25/2019 |
6.1.3 | 35,429 | 4/3/2019 |
6.1.2 | 7,030 | 3/14/2019 |
6.1.1 | 5,183 | 2/27/2019 |
6.1.0 | 1,292 | 2/26/2019 |
6.0.2 | 3,787 | 2/13/2019 |
6.0.1 | 1,285 | 2/11/2019 |
6.0.0 | 2,018 | 2/7/2019 |
5.3.1 | 28,925 | 12/18/2018 |
5.3.0 | 1,203 | 12/17/2018 |
5.2.1 | 25,534 | 12/3/2018 |
5.2.0 | 41,236 | 10/10/2018 |
5.1.0 | 58,535 | 6/26/2018 |
5.0.0 | 30,670 | 4/23/2018 |
4.2.2 | 42,649 | 1/31/2018 |
4.2.1 | 12,837 | 12/7/2017 |
4.2.0 | 20,627 | 10/23/2017 |
4.1.2 | 17,265 | 10/2/2017 |
4.1.1 | 2,966 | 9/15/2017 |
4.0.0 | 28,939 | 5/24/2017 |
3.7.5 | 22,278 | 4/24/2017 |
3.7.4 | 23,683 | 3/21/2017 |
3.7.3 | 3,029 | 2/7/2017 |
3.7.2 | 1,451 | 1/30/2017 |
3.7.1 | 1,909 | 1/3/2017 |
3.7.0 | 3,836 | 12/12/2016 |
3.6.10 | 8,821 | 11/17/2016 |
3.6.9 | 1,594 | 10/28/2016 |
3.6.8 | 1,262 | 10/20/2016 |
3.6.7 | 1,280 | 10/19/2016 |
3.6.6 | 4,260 | 9/1/2016 |
3.6.5 | 16,058 | 7/7/2016 |
3.6.4 | 1,662 | 6/23/2016 |
3.6.3 | 1,670 | 6/2/2016 |
3.6.2 | 3,767 | 5/19/2016 |
3.6.1 | 2,649 | 4/14/2016 |
3.6.0 | 1,352 | 4/12/2016 |
3.5.0 | 1,330 | 3/25/2016 |
3.4.4 | 1,684 | 2/11/2016 |
3.4.3 | 1,333 | 2/5/2016 |
3.4.2 | 4,860 | 11/11/2015 |
3.4.0 | 1,680 | 10/16/2015 |
3.3.3 | 3,364 | 10/13/2015 |
3.3.2 | 1,299 | 10/12/2015 |
3.3.1 | 1,395 | 10/9/2015 |
3.3.0 | 2,001 | 9/8/2015 |
3.2.0 | 1,484 | 9/8/2015 |
3.1.7 | 1,395 | 8/31/2015 |
3.1.6 | 1,329 | 8/30/2015 |
3.1.5 | 1,364 | 8/28/2015 |
3.1.4 | 2,625 | 6/30/2015 |
3.1.3 | 89,240 | 6/4/2015 |
3.1.2 | 1,334 | 6/3/2015 |
3.1.1 | 1,751 | 5/4/2015 |
3.1.0 | 1,557 | 4/10/2015 |
3.0.5 | 2,237 | 2/18/2015 |
3.0.4 | 3,063 | 1/21/2015 |
3.0.3 | 1,448 | 1/9/2015 |
3.0.2 | 2,204 | 1/4/2015 |
3.0.1 | 1,883 | 1/3/2015 |
3.0.0 | 1,848 | 1/2/2015 |
2.4.1 | 1,605 | 12/4/2014 |
2.4.0 | 1,528 | 11/30/2014 |
2.3.3 | 1,511 | 11/25/2014 |
2.3.2 | 1,520 | 11/24/2014 |
2.3.1 | 1,500 | 10/23/2014 |
2.3.0 | 1,475 | 10/16/2014 |
2.2.0 | 1,737 | 9/14/2014 |
2.1.0 | 1,622 | 8/21/2014 |
2.0.0 | 1,563 | 8/13/2014 |
1.16.0 | 1,623 | 8/4/2014 |
1.15.0 | 1,492 | 7/24/2014 |
1.14.0 | 1,459 | 7/24/2014 |
1.13.0 | 1,496 | 7/17/2014 |
1.12.0 | 1,653 | 6/10/2014 |
1.11.0 | 1,552 | 5/2/2014 |
1.10.0 | 1,774 | 3/27/2014 |
1.9.0 | 1,622 | 3/3/2014 |
1.8.0 | 1,596 | 1/21/2014 |
1.7.0 | 1,483 | 1/2/2014 |
1.6.0 | 1,551 | 12/6/2013 |
1.5.0 | 1,531 | 11/8/2013 |
1.4.0 | 1,498 | 11/8/2013 |
1.3.0 | 1,510 | 10/19/2013 |
1.2.0 | 1,511 | 9/17/2013 |
1.1.0 | 1,581 | 8/4/2013 |
1.0.0 | 1,980 | 7/11/2013 |