Algolia.Search 7.5.0

dotnet add package Algolia.Search --version 7.5.0                
NuGet\Install-Package Algolia.Search -Version 7.5.0                
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.5.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Algolia.Search --version 7.5.0                
#r "nuget: Algolia.Search, 7.5.0"                
#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.5.0

// Install Algolia.Search as a Cake Tool
#tool nuget:?package=Algolia.Search&version=7.5.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 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.

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.5.0 284 10/1/2024
7.4.3 655 9/25/2024
7.4.2 254 9/24/2024
7.4.1 434 9/19/2024
7.4.0 203 9/18/2024
7.3.2 162 9/17/2024
7.3.1 368 9/12/2024
7.3.0 640 9/6/2024
7.2.4 387 9/3/2024
7.2.3 182 9/2/2024
7.2.2 310 8/29/2024
7.2.1 297 8/28/2024
7.2.0 182 8/27/2024
7.1.1 664 8/21/2024
7.1.0 354 8/20/2024
7.0.2 320 8/19/2024
7.0.0 657 8/14/2024
7.0.0-beta.16 66 8/9/2024
7.0.0-beta.15 106 8/8/2024
7.0.0-beta.14 73 8/8/2024
7.0.0-beta.13 36 8/6/2024
7.0.0-beta.12 86 8/1/2024
7.0.0-beta.11 64 7/26/2024
7.0.0-beta.10 62 7/19/2024
7.0.0-beta.9 219 7/12/2024
7.0.0-beta.8 219 7/1/2024
7.0.0-beta.7 59 6/27/2024
7.0.0-beta.6 65 6/26/2024
7.0.0-beta.5 60 6/21/2024
7.0.0-beta.4 59 6/13/2024
7.0.0-beta.3 49 6/11/2024
7.0.0-beta.2 97 5/17/2024
7.0.0-beta.1 104 4/23/2024
7.0.0-alpha.9 100 4/16/2024
7.0.0-alpha.8 58 4/9/2024
7.0.0-alpha.7 60 4/3/2024
7.0.0-alpha.6 3,413 3/25/2024
7.0.0-alpha.5 61 3/19/2024
7.0.0-alpha.4 67 3/13/2024
7.0.0-alpha.3 53 3/5/2024
7.0.0-alpha.2 57 2/29/2024
7.0.0-alpha.1 52 2/27/2024
7.0.0-alpha.0 72 2/20/2024
6.17.0 141,358 2/26/2024
6.16.0 92,899 11/20/2023
6.15.0 90,093 8/8/2023
6.14.0 285,889 11/8/2022
6.13.0 225,996 8/31/2022
6.12.1 415,423 2/14/2022
6.12.0 227,778 11/5/2021
6.11.0 22,946 10/19/2021
6.10.2 11,654 9/23/2021
6.10.1 100,910 6/2/2021
6.10.0 61,033 5/7/2021
6.9.1 139,228 1/28/2021
6.9.0 30,343 12/7/2020
6.8.0 75,305 8/17/2020
6.7.0 24,310 7/21/2020
6.6.0 71,916 4/1/2020
6.5.1 156,991 11/26/2019
6.5.0 2,577 11/6/2019
6.4.1 15,943 10/3/2019
6.4.0 9,758 8/30/2019
6.3.0 1,732 8/22/2019
6.2.0 19,285 6/25/2019
6.1.3 36,784 4/3/2019
6.1.2 7,045 3/14/2019
6.1.1 5,217 2/27/2019
6.1.0 1,311 2/26/2019
6.0.2 3,810 2/13/2019
6.0.1 1,304 2/11/2019
6.0.0 2,043 2/7/2019
5.3.1 29,013 12/18/2018
5.3.0 1,222 12/17/2018
5.2.1 25,902 12/3/2018
5.2.0 41,444 10/10/2018
5.1.0 58,812 6/26/2018
5.0.0 30,756 4/23/2018
4.2.2 42,962 1/31/2018
4.2.1 12,868 12/7/2017
4.2.0 20,724 10/23/2017
4.1.2 17,295 10/2/2017
4.1.1 2,997 9/15/2017
4.0.0 29,021 5/24/2017
3.7.5 22,320 4/24/2017
3.7.4 23,760 3/21/2017
3.7.3 3,043 2/7/2017
3.7.2 1,467 1/30/2017
3.7.1 1,924 1/3/2017
3.7.0 3,850 12/12/2016
3.6.10 8,887 11/17/2016
3.6.9 1,609 10/28/2016
3.6.8 1,277 10/20/2016
3.6.7 1,294 10/19/2016
3.6.6 4,278 9/1/2016
3.6.5 16,142 7/7/2016
3.6.4 1,678 6/23/2016
3.6.3 1,689 6/2/2016
3.6.2 3,789 5/19/2016
3.6.1 2,662 4/14/2016
3.6.0 1,367 4/12/2016
3.5.0 1,344 3/25/2016
3.4.4 1,700 2/11/2016
3.4.3 1,347 2/5/2016
3.4.2 4,876 11/11/2015
3.4.0 1,696 10/16/2015
3.3.3 3,382 10/13/2015
3.3.2 1,319 10/12/2015
3.3.1 1,414 10/9/2015
3.3.0 2,026 9/8/2015
3.2.0 1,503 9/8/2015
3.1.7 1,414 8/31/2015
3.1.6 1,342 8/30/2015
3.1.5 1,380 8/28/2015
3.1.4 2,640 6/30/2015
3.1.3 89,620 6/4/2015
3.1.2 1,349 6/3/2015
3.1.1 1,768 5/4/2015
3.1.0 1,574 4/10/2015
3.0.5 2,252 2/18/2015
3.0.4 3,077 1/21/2015
3.0.3 1,465 1/9/2015
3.0.2 2,222 1/4/2015
3.0.1 1,896 1/3/2015
3.0.0 1,862 1/2/2015
2.4.1 1,619 12/4/2014
2.4.0 1,541 11/30/2014
2.3.3 1,525 11/25/2014
2.3.2 1,541 11/24/2014
2.3.1 1,514 10/23/2014
2.3.0 1,489 10/16/2014
2.2.0 1,754 9/14/2014
2.1.0 1,641 8/21/2014
2.0.0 1,579 8/13/2014
1.16.0 1,641 8/4/2014
1.15.0 1,514 7/24/2014
1.14.0 1,475 7/24/2014
1.13.0 1,512 7/17/2014
1.12.0 1,670 6/10/2014
1.11.0 1,566 5/2/2014
1.10.0 1,789 3/27/2014
1.9.0 1,635 3/3/2014
1.8.0 1,617 1/21/2014
1.7.0 1,500 1/2/2014
1.6.0 1,567 12/6/2013
1.5.0 1,547 11/8/2013
1.4.0 1,515 11/8/2013
1.3.0 1,524 10/19/2013
1.2.0 1,526 9/17/2013
1.1.0 1,600 8/4/2013
1.0.0 2,002 7/11/2013