The Azure.Search.Documents package provides APIs for operations on the Azure Cognitive Search cloud service.
See Azure SDK diagnostics for help diagnosing various problems across all our Azure SDKs for .NET.
- Identifying and Troubleshooting Issues by Response Code
- Unexpected search query results
- Limits imposed by the Search service
See this page for the common response status codes sent by the Azure Cognitive Search service.
This response status indicates a partial success for an indexing operation. Some documents were successfully processed, but at least one failed. Details of the failed documents are present in the individual IndexingResult objects within the IndexDocumentsResult of the Azure.Response. If you want the IndexDocumentsAsync() method call to throw an exception on any failure, set IndexDocumentsOptions.ThrowOnAnyError to true. Each failure is then recorded in a separate RequestFailedException and a single AggregateException is thrown by the method.
Returned when you pass an invalid api-key. Search service uses two types of keys to control access: admin (read-write) and query (read-only). The admin key grants full rights to all operations, including the ability to manage the service, create and delete indexes, indexers, and data sources. The query key grants read-only access to indexes and documents. Ensure that the key used for an API call provides sufficient privileges for the operation. See here for details about managing API keys.
Returned when a resource does not exist on the server. If you are managing or querying an index, check the syntax and verify the index name is specified correctly.
If this error occurs while you are trying to create an index, it means you already have the maximum number of indexes allowed for your pricing tier. A count of the indexes stored in Azure Cognitive Search is visible in the search service dashboard on the Azure portal. To view the indexes by name, click the Index tile. Alternatively, you can also get a list of the indexes by name using the GetIndexNames() method.
If this error occurs during document upload, it indicates that you've exceeded your quota on the number of documents per index. You must either create a new index or upgrade for higher capacity limits.
A common class of issues when using the Search SDK is that the result set of a search query is different than expected. For such cases, you should start by running the search query in the portal to rule out any service-side issues with the search query or any parameter(s). Review the OData syntax, if any, used in the query.
Once the result looks good in the portal, use that as the template to populate the objects and parameters in the search request APIs. You should also verify that the correct set of documents have been indexed and are being searched on the service side. One tip would be to start with a 'broad' query (one that returns a superset of desired results, possibly by giving a large value for or entirely removing, some query parameters) and then progressively refining the query till it expresses the desired intent.
The service imposes limits on storage, workloads, and quantities of indexes and other objects depending on whether you provision Azure Cognitive Search at Free, Basic, Standard, or Storage Optimized pricing tiers. See this page for details.