Algolia.Search 7.11.1

dotnet add package Algolia.Search --version 7.11.1                
NuGet\Install-Package Algolia.Search -Version 7.11.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Algolia.Search" Version="7.11.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Algolia.Search --version 7.11.1                
#r "nuget: Algolia.Search, 7.11.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Algolia.Search as a Cake Addin
#addin nuget:?package=Algolia.Search&version=7.11.1

// Install Algolia.Search as a Cake Tool
#tool nuget:?package=Algolia.Search&version=7.11.1                

<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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.

Umbraco.Cms.Integrations.Search.Algolia

An extension for Umbraco CMS providing a custom search engine integration with Algolia.

uSync.Community.StaticSiteWithSearch.Algolia

An implementation of uSync.Community.StaticSiteWithSearch for the Algolia search appliance

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.11.1 43 12/12/2024
7.11.0 153 12/11/2024
7.10.0 328 12/9/2024
7.9.2 2,791 11/19/2024
7.9.1 771 11/15/2024
7.9.0 487 11/14/2024
7.8.1 1,518 11/6/2024
7.8.0 3,123 10/30/2024
7.7.0 322 10/29/2024
7.6.4 1,288 10/23/2024
7.6.3 2,519 10/21/2024
7.6.2 762 10/17/2024
7.6.1 3,473 10/10/2024
7.6.0 562 10/8/2024
7.5.0 1,541 10/1/2024
7.4.3 2,111 9/25/2024
7.4.2 398 9/24/2024
7.4.1 801 9/19/2024
7.4.0 519 9/18/2024
7.3.2 191 9/17/2024
7.3.1 542 9/12/2024
7.3.0 1,809 9/6/2024
7.2.4 486 9/3/2024
7.2.3 208 9/2/2024
7.2.2 529 8/29/2024
7.2.1 323 8/28/2024
7.2.0 207 8/27/2024
7.1.1 1,142 8/21/2024
7.1.0 391 8/20/2024
7.0.2 387 8/19/2024
7.0.0 1,236 8/14/2024
7.0.0-beta.16 74 8/9/2024
7.0.0-beta.15 115 8/8/2024
7.0.0-beta.14 79 8/8/2024
7.0.0-beta.13 48 8/6/2024
7.0.0-beta.12 103 8/1/2024
7.0.0-beta.11 76 7/26/2024
7.0.0-beta.10 71 7/19/2024
7.0.0-beta.9 257 7/12/2024
7.0.0-beta.8 230 7/1/2024
7.0.0-beta.7 69 6/27/2024
7.0.0-beta.6 73 6/26/2024
7.0.0-beta.5 68 6/21/2024
7.0.0-beta.4 69 6/13/2024
7.0.0-beta.3 59 6/11/2024
7.0.0-beta.2 105 5/17/2024
7.0.0-beta.1 112 4/23/2024
7.0.0-alpha.9 106 4/16/2024
7.0.0-alpha.8 66 4/9/2024
7.0.0-alpha.7 66 4/3/2024
7.0.0-alpha.6 4,445 3/25/2024
7.0.0-alpha.5 69 3/19/2024
7.0.0-alpha.4 75 3/13/2024
7.0.0-alpha.3 61 3/5/2024
7.0.0-alpha.2 65 2/29/2024
7.0.0-alpha.1 58 2/27/2024
7.0.0-alpha.0 78 2/20/2024
6.17.0 198,402 2/26/2024
6.16.0 104,623 11/20/2023
6.15.0 97,258 8/8/2023
6.14.0 304,403 11/8/2022
6.13.0 243,639 8/31/2022
6.12.1 432,751 2/14/2022
6.12.0 232,774 11/5/2021
6.11.0 26,536 10/19/2021
6.10.2 11,783 9/23/2021
6.10.1 102,568 6/2/2021
6.10.0 61,610 5/7/2021
6.9.1 147,490 1/28/2021
6.9.0 30,463 12/7/2020
6.8.0 75,732 8/17/2020
6.7.0 24,364 7/21/2020
6.6.0 72,190 4/1/2020
6.5.1 161,017 11/26/2019
6.5.0 2,589 11/6/2019
6.4.1 16,044 10/3/2019
6.4.0 9,766 8/30/2019
6.3.0 1,742 8/22/2019
6.2.0 19,382 6/25/2019
6.1.3 38,122 4/3/2019
6.1.2 7,053 3/14/2019
6.1.1 5,285 2/27/2019
6.1.0 1,321 2/26/2019
6.0.2 3,855 2/13/2019
6.0.1 1,313 2/11/2019
6.0.0 2,057 2/7/2019
5.3.1 29,185 12/18/2018
5.3.0 1,230 12/17/2018
5.2.1 26,830 12/3/2018
5.2.0 41,852 10/10/2018
5.1.0 59,604 6/26/2018
5.0.0 30,884 4/23/2018
4.2.2 43,757 1/31/2018
4.2.1 12,887 12/7/2017
4.2.0 20,957 10/23/2017
4.1.2 17,345 10/2/2017
4.1.1 3,021 9/15/2017
4.0.0 29,108 5/24/2017
3.7.5 22,449 4/24/2017
3.7.4 23,926 3/21/2017
3.7.3 3,061 2/7/2017
3.7.2 1,487 1/30/2017
3.7.1 1,947 1/3/2017
3.7.0 3,868 12/12/2016
3.6.10 9,038 11/17/2016
3.6.9 1,626 10/28/2016
3.6.8 1,295 10/20/2016
3.6.7 1,311 10/19/2016
3.6.6 4,295 9/1/2016
3.6.5 16,355 7/7/2016
3.6.4 1,699 6/23/2016
3.6.3 1,707 6/2/2016
3.6.2 3,817 5/19/2016
3.6.1 2,680 4/14/2016
3.6.0 1,384 4/12/2016
3.5.0 1,363 3/25/2016
3.4.4 1,720 2/11/2016
3.4.3 1,366 2/5/2016
3.4.2 4,897 11/11/2015
3.4.0 1,715 10/16/2015
3.3.3 3,400 10/13/2015
3.3.2 1,341 10/12/2015
3.3.1 1,434 10/9/2015
3.3.0 2,044 9/8/2015
3.2.0 1,522 9/8/2015
3.1.7 1,432 8/31/2015
3.1.6 1,364 8/30/2015
3.1.5 1,400 8/28/2015
3.1.4 2,657 6/30/2015
3.1.3 90,566 6/4/2015
3.1.2 1,368 6/3/2015
3.1.1 1,791 5/4/2015
3.1.0 1,593 4/10/2015
3.0.5 2,274 2/18/2015
3.0.4 3,096 1/21/2015
3.0.3 1,484 1/9/2015
3.0.2 2,243 1/4/2015
3.0.1 1,919 1/3/2015
3.0.0 1,881 1/2/2015
2.4.1 1,637 12/4/2014
2.4.0 1,563 11/30/2014
2.3.3 1,544 11/25/2014
2.3.2 1,561 11/24/2014
2.3.1 1,536 10/23/2014
2.3.0 1,509 10/16/2014
2.2.0 1,775 9/14/2014
2.1.0 1,662 8/21/2014
2.0.0 1,598 8/13/2014
1.16.0 1,661 8/4/2014
1.15.0 1,538 7/24/2014
1.14.0 1,493 7/24/2014
1.13.0 1,534 7/17/2014
1.12.0 1,691 6/10/2014
1.11.0 1,583 5/2/2014
1.10.0 1,807 3/27/2014
1.9.0 1,655 3/3/2014
1.8.0 1,637 1/21/2014
1.7.0 1,518 1/2/2014
1.6.0 1,589 12/6/2013
1.5.0 1,565 11/8/2013
1.4.0 1,538 11/8/2013
1.3.0 1,543 10/19/2013
1.2.0 1,546 9/17/2013
1.1.0 1,620 8/4/2013
1.0.0 2,053 7/11/2013