Skip to content

Commit 573896c

Browse files
committed
Update docs metadata
1 parent 463897d commit 573896c

File tree

2 files changed

+17
-15
lines changed

2 files changed

+17
-15
lines changed

docs-ref-services/preview/search-documents-readme.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Azure AI Search client library for Python
33
keywords: Azure, python, SDK, API, azure-search-documents, cognitive-search
4-
ms.date: 09/19/2024
4+
ms.date: 10/08/2024
55
ms.topic: reference
66
ms.devlang: python
77
ms.service: cognitive-search
88
---
9-
# Azure AI Search client library for Python - version 11.6.0b5
9+
# Azure AI Search client library for Python - version 11.6.0b6
1010

1111

1212
[Azure AI Search](/azure/search/) (formerly known as "Azure Cognitive Search") is an AI-powered information retrieval platform that helps developers build rich search experiences and generative AI apps that combine large language models with enterprise data.
@@ -38,12 +38,12 @@ Use the Azure.Search.Documents client library to:
3838
* Create and manage analyzers for advanced text analysis or multi-lingual content.
3939
* Optimize results through semantic ranking and scoring profiles to factor in business logic or freshness.
4040

41-
[Source code](https://github.com/Azure/azure-sdk-for-python/tree/azure-search-documents_11.6.0b5/sdk/search/azure-search-documents)
41+
[Source code](https://github.com/Azure/azure-sdk-for-python/tree/azure-search-documents_11.6.0b6/sdk/search/azure-search-documents)
4242
| [Package (PyPI)](https://pypi.org/project/azure-search-documents/)
4343
| [Package (Conda)](https://anaconda.org/microsoft/azure-search-documents/)
4444
| [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-search-documents/latest/index.html)
4545
| [Product documentation](/azure/search/search-what-is-azure-search)
46-
| [Samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/sdk/search/azure-search-documents/samples)
46+
| [Samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/sdk/search/azure-search-documents/samples)
4747

4848
## Getting started
4949

@@ -117,9 +117,9 @@ search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(ke
117117
#### Create a client using Microsoft Entra ID authentication
118118

119119
You can also create a `SearchClient`, `SearchIndexClient`, or `SearchIndexerClient` using Microsoft Entra ID authentication. Your user or service principal must be assigned the "Search Index Data Reader" role.
120-
Using the [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/sdk/identity/azure-identity/README.md#defaultazurecredential) you can authenticate a service using Managed Identity or a service principal, authenticate as a developer working on an application, and more all without changing code. Please refer the [documentation](https://learn.microsoft.com/azure/search/search-security-rbac?tabs=config-svc-portal%2Croles-portal%2Ctest-portal%2Ccustom-role-portal%2Cdisable-keys-portal) for instructions on how to connect to Azure AI Search using Azure role-based access control (Azure RBAC).
120+
Using the [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/sdk/identity/azure-identity/README.md#defaultazurecredential) you can authenticate a service using Managed Identity or a service principal, authenticate as a developer working on an application, and more all without changing code. Please refer the [documentation](https://learn.microsoft.com/azure/search/search-security-rbac?tabs=config-svc-portal%2Croles-portal%2Ctest-portal%2Ccustom-role-portal%2Cdisable-keys-portal) for instructions on how to connect to Azure AI Search using Azure role-based access control (Azure RBAC).
121121

122-
Before you can use the `DefaultAzureCredential`, or any credential type from [Azure.Identity](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/sdk/identity/azure-identity/README.md), you'll first need to [install the Azure.Identity package](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/sdk/identity/azure-identity/README.md#install-the-package).
122+
Before you can use the `DefaultAzureCredential`, or any credential type from [Azure.Identity](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/sdk/identity/azure-identity/README.md), you'll first need to [install the Azure.Identity package](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/sdk/identity/azure-identity/README.md#install-the-package).
123123

124124
To use `DefaultAzureCredential` with a client ID and secret, you'll need to set the `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, and `AZURE_CLIENT_SECRET` environment variables; alternatively, you can pass those values
125125
to the `ClientSecretCredential` also in Azure.Identity.
@@ -179,7 +179,7 @@ To learn more about semantic ranking, you can refer to the [documentation](https
179179

180180
**Vector search** is an information retrieval technique that uses numeric representations of searchable documents and query strings. By searching for numeric representations of content that are most similar to the numeric query, vector search can find relevant matches, even if the exact terms of the query are not present in the index. Moreover, vector search can be applied to various types of content, including images and videos and translated text, not just same-language text.
181181

182-
To learn how to index vector fields and perform vector search, you can refer to the [sample](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/sdk/search/azure-search-documents/samples/sample_vector_search.py). This sample provides detailed guidance on indexing vector fields and demonstrates how to perform vector search.
182+
To learn how to index vector fields and perform vector search, you can refer to the [sample](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/sdk/search/azure-search-documents/samples/sample_vector_search.py). This sample provides detailed guidance on indexing vector fields and demonstrates how to perform vector search.
183183

184184
Additionally, for more comprehensive information about vector search, including its concepts and usage, you can refer to the [documentation](https://learn.microsoft.com/azure/search/vector-search-overview). The documentation provides in-depth explanations and guidance on leveraging the power of vector search in Azure AI Search.
185185

@@ -191,7 +191,7 @@ previous `Microsoft.Azure.Search` client library (v10) is now retired. It has ma
191191

192192
The following examples all use a simple [Hotel data set](https://github.com/Azure-Samples/azure-search-sample-data/blob/master/README.md)
193193
that you can [import into your own index from the Azure portal.](/azure/search/search-get-started-portal#step-1---start-the-import-data-wizard-and-create-a-data-source)
194-
These are just a few of the basics - please [check out our Samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/sdk/search/azure-search-documents/samples) for
194+
These are just a few of the basics - please [check out our Samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/sdk/search/azure-search-documents/samples) for
195195
much more.
196196

197197
* [Querying](#querying)
@@ -339,7 +339,7 @@ print(" Name: {}".format(result["hotelName"]))
339339
This library includes a complete async API. To use it, you must
340340
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
341341
See
342-
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/sdk/core/azure-core/README.md#transport)
342+
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/sdk/core/azure-core/README.md#transport)
343343
for more information.
344344

345345
<!-- SNIPPET:sample_simple_query_async.simple_query_async -->
@@ -401,7 +401,7 @@ result = client.search(search_text="spa", logging_enable=True)
401401

402402
## Next steps
403403

404-
* Go further with Azure.Search.Documents and our [https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/sdk/search/azure-search-documents/samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/sdk/search/azure-search-documents/samples)
404+
* Go further with Azure.Search.Documents and our [https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/sdk/search/azure-search-documents/samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/sdk/search/azure-search-documents/samples)
405405
* Read more about the [Azure AI Search service](/azure/search/search-what-is-azure-search)
406406

407407
## Contributing
@@ -430,15 +430,15 @@ additional questions or comments.
430430
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fsearch%2Fazure-search-documents%2FREADME.png)
431431

432432
[azure_cli]: /cli/azure
433-
[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/sdk/core/azure-core/README.md
433+
[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/sdk/core/azure-core/README.md
434434
[azure_sub]: https://azure.microsoft.com/free/
435435
[search_resource]: /azure/search/search-create-service-portal
436436
[azure_portal]: https://portal.azure.com
437437

438438
[create_search_service_docs]: /azure/search/search-create-service-portal
439439
[create_search_service_ps]: /azure/search/search-manage-powershell#create-or-delete-a-service
440440
[create_search_service_cli]: /cli/azure/search/service?view=azure-cli-latest#az-search-service-create
441-
[search_contrib]: https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b5/CONTRIBUTING.md
441+
[search_contrib]: https://github.com/Azure/azure-sdk-for-python/blob/azure-search-documents_11.6.0b6/CONTRIBUTING.md
442442
[python_logging]: https://docs.python.org/3.5/library/logging.html
443443

444444
[cla]: https://cla.microsoft.com

metadata/preview/azure-search-documents.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-search-documents",
3-
"Version": "11.6.0b5",
3+
"Version": "11.6.0b6",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/search/azure-search-documents",
66
"ServiceDirectory": "search",
@@ -10,9 +10,11 @@
1010
"SdkType": "client",
1111
"IsNewSdk": true,
1212
"ArtifactName": "azure-search-documents",
13-
"ReleaseStatus": "2024-09-19",
13+
"ReleaseStatus": "2024-10-08",
1414
"IncludedForValidation": false,
15-
"AdditionalValidationPackages": null,
15+
"AdditionalValidationPackages": [
16+
""
17+
],
1618
"Namespaces": [
1719
"azure.search.documents"
1820
]

0 commit comments

Comments
 (0)