Update docs metadata
This commit is contained in:
azure-sdk
Родитель
36c84e8c9d
Коммит
181ae73ea0
|
|
@ -1,12 +1,12 @@
|
|||
---
|
||||
title: Azure AI Search client library for Java
|
||||
keywords: Azure, java, SDK, API, azure-search-documents, cognitive-search
|
||||
ms.date: 03/11/2024
|
||||
ms.date: 05/07/2024
|
||||
ms.topic: reference
|
||||
ms.devlang: java
|
||||
ms.service: cognitive-search
|
||||
---
|
||||
# Azure AI Search client library for Java - version 11.7.0-beta.2
|
||||
# Azure AI Search client library for Java - version 11.7.0-beta.3
|
||||
|
||||
|
||||
This is the Java client library for [Azure AI Search](/azure/search/) (formerly known as "Azure Cognitive Search"). Azure AI Search service 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.
|
||||
|
|
@ -47,7 +47,7 @@ Use the Azure AI Search client library to:
|
|||
#### Include the BOM file
|
||||
|
||||
Please include the azure-sdk-bom to your project to take dependency on the General Availability (GA) version of the library. In the following snippet, replace the {bom_version_to_target} placeholder with the version number.
|
||||
To learn more about the BOM, see the [AZURE SDK BOM README](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.2/sdk/boms/azure-sdk-bom/README.md).
|
||||
To learn more about the BOM, see the [AZURE SDK BOM README](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.3/sdk/boms/azure-sdk-bom/README.md).
|
||||
|
||||
```xml
|
||||
<dependencyManagement>
|
||||
|
|
@ -84,7 +84,7 @@ add the direct dependency to your project as follows.
|
|||
<dependency>
|
||||
<groupId>com.azure</groupId>
|
||||
<artifactId>azure-search-documents</artifactId>
|
||||
<version>11.7.0-beta.2</version>
|
||||
<version>11.7.0-beta.3</version>
|
||||
</dependency>
|
||||
```
|
||||
[//]: # ({x-version-update-end})
|
||||
|
|
@ -208,13 +208,13 @@ SearchAsyncClient searchAsyncClient = new SearchClientBuilder()
|
|||
#### Create a client using Microsoft Entra ID authentication
|
||||
|
||||
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.
|
||||
Using the [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.2/sdk/identity/azure-identity/README.md#defaultazurecredential)
|
||||
Using the [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.3/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).
|
||||
|
||||
Before you can use the `DefaultAzureCredential`, or any credential type from [Azure.Identity](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.2/sdk/identity/azure-identity/README.md),
|
||||
you'll first need to [install the Azure.Identity package](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.2/sdk/identity/azure-identity/README.md#include-the-package).
|
||||
Before you can use the `DefaultAzureCredential`, or any credential type from [Azure.Identity](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.3/sdk/identity/azure-identity/README.md),
|
||||
you'll first need to [install the Azure.Identity package](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.3/sdk/identity/azure-identity/README.md#include-the-package).
|
||||
|
||||
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
|
||||
|
|
@ -288,10 +288,9 @@ Semantic ranking enhances the quality of search results for text-based queries.
|
|||
|
||||
To learn more about semantic ranking, you can refer to the [documentation](https://learn.microsoft.com/azure/search/vector-search-overview).
|
||||
|
||||
|
||||
### Vector Search
|
||||
|
||||
Vector search is an information retrieval technique that overcomes the limitations of traditional keyword-based search. Instead of relying solely on lexical analysis and matching individual query terms, vector search uses algorithms for similarity and concept search. It represents documents and queries as vectors in a high-dimensional space called an embedding. By searching on vector representations of content, a vector query 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.
|
||||
**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.
|
||||
|
||||
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/main/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.
|
||||
|
||||
|
|
@ -521,7 +520,7 @@ SearchClient searchClient = new SearchClientBuilder()
|
|||
|
||||
## Troubleshooting
|
||||
|
||||
See our [troubleshooting guide](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.2/sdk/search/azure-search-documents/TROUBLESHOOTING.md)
|
||||
See our [troubleshooting guide](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.3/sdk/search/azure-search-documents/TROUBLESHOOTING.md)
|
||||
for details on how to diagnose various failure scenarios.
|
||||
|
||||
### General
|
||||
|
|
@ -587,20 +586,20 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
|
|||
[azure_subscription]: https://azure.microsoft.com/free/java
|
||||
[maven]: https://maven.apache.org/
|
||||
[package]: https://central.sonatype.com/artifact/com.azure/azure-search-documents
|
||||
[samples]: https://github.com/Azure/azure-sdk-for-java/tree/azure-search-documents_11.7.0-beta.2/sdk/search/azure-search-documents/src/samples/
|
||||
[samples_readme]: https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.2/sdk/search/azure-search-documents/src/samples/README.md
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-java/tree/azure-search-documents_11.7.0-beta.2/sdk/search/azure-search-documents/src
|
||||
[samples]: https://github.com/Azure/azure-sdk-for-java/tree/azure-search-documents_11.7.0-beta.3/sdk/search/azure-search-documents/src/samples/
|
||||
[samples_readme]: https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.3/sdk/search/azure-search-documents/src/samples/README.md
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-java/tree/azure-search-documents_11.7.0-beta.3/sdk/search/azure-search-documents/src
|
||||
[logging]: https://github.com/Azure/azure-sdk-for-java/wiki/Logging-with-Azure-SDK
|
||||
[cla]: https://cla.microsoft.com
|
||||
[coc]: https://opensource.microsoft.com/codeofconduct/
|
||||
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
|
||||
[coc_contact]: mailto:opencode@microsoft.com
|
||||
[add_headers_from_context_policy]: https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.2/sdk/core/azure-core/src/main/java/com/azure/core/http/policy/AddHeadersFromContextPolicy.java
|
||||
[add_headers_from_context_policy]: https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.3/sdk/core/azure-core/src/main/java/com/azure/core/http/policy/AddHeadersFromContextPolicy.java
|
||||
[rest_api]: /rest/api/searchservice/http-status-codes
|
||||
[create_search_service_docs]: /azure/search/search-create-service-portal
|
||||
[create_search_service_ps]: /azure/search/search-manage-powershell#create-or-delete-a-service
|
||||
[create_search_service_cli]: /cli/azure/search/service?view=azure-cli-latest#az-search-service-create
|
||||
[HttpResponseException]: https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.2/sdk/core/azure-core/src/main/java/com/azure/core/exception/HttpResponseException.java
|
||||
[HttpResponseException]: https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.7.0-beta.3/sdk/core/azure-core/src/main/java/com/azure/core/exception/HttpResponseException.java
|
||||
[status_codes]: /rest/api/searchservice/http-status-codes
|
||||
[search-get-started-portal]: /azure/search/search-get-started-portal
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"Name": "azure-search-documents",
|
||||
"Version": "11.7.0-beta.2",
|
||||
"Version": "11.7.0-beta.3",
|
||||
"DevVersion": null,
|
||||
"DirectoryPath": "sdk/search/azure-search-documents",
|
||||
"ServiceDirectory": "search",
|
||||
|
|
@ -10,7 +10,7 @@
|
|||
"SdkType": "client",
|
||||
"IsNewSdk": true,
|
||||
"ArtifactName": "azure-search-documents",
|
||||
"ReleaseStatus": "2024-03-11",
|
||||
"ReleaseStatus": "2024-05-07",
|
||||
"Namespaces": [
|
||||
"com.azure.search.documents",
|
||||
"com.azure.search.documents.indexes",
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче