a whole bunch of nice clean up work
This commit is contained in:
Scott Beddall
Родитель
ef8be7d518
Коммит
94d2645eb7
|
|
@ -212,14 +212,41 @@
|
|||
- com.microsoft.azure.management.containerservice
|
||||
- com.microsoft.azure.management.containerservice.*
|
||||
- name: Core
|
||||
uid: azure.java.sdk.landingpage.services.sdk
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core
|
||||
landingPageType: Service
|
||||
items:
|
||||
- name: Client
|
||||
uid: azure.java.sdk.landingpage.services.sdk.Client
|
||||
landingPageType: Service
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core.Client
|
||||
href: ~/docs-ref-services/core-readme.md
|
||||
children:
|
||||
- com.azure.core*
|
||||
- com.azure.core.annotation
|
||||
- com.azure.core.credential
|
||||
- com.azure.core.cryptography
|
||||
- com.azure.core.exception
|
||||
- com.azure.core.http
|
||||
- com.azure.core.util.logging
|
||||
- com.azure.core.util.paging
|
||||
- com.azure.core.http.policy
|
||||
- com.azure.core.util.polling
|
||||
- com.azure.core.http.rest
|
||||
- com.azure.core.util.serializer
|
||||
- com.azure.core.util.tracing
|
||||
- com.azure.core.util
|
||||
- name: AMQP
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core.AMQP
|
||||
href: ~/docs-ref-services/core-amqp-readme.md
|
||||
children:
|
||||
- com.azure.core.amqp*
|
||||
- name: OkHttp
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core.OkHttp
|
||||
href: ~/docs-ref-services/core-http-okhttp-readme.md
|
||||
children:
|
||||
- com.azure.core.http.okhttp*
|
||||
- name: Netty
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core.Netty
|
||||
href: ~/docs-ref-services/core-http-netty-readme.md
|
||||
children:
|
||||
- com.azure.core.http.netty*
|
||||
- name: Cosmos DB
|
||||
uid: azure.java.sdk.landingpage.services.cosmosdb
|
||||
href: ~/docs-ref-services/cosmosdb.md
|
||||
|
|
|
|||
|
|
@ -217,14 +217,41 @@
|
|||
- com.microsoft.azure.management.containerservice
|
||||
- com.microsoft.azure.management.containerservice.*
|
||||
- name: Core
|
||||
uid: azure.java.sdk.landingpage.services.sdk
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core
|
||||
landingPageType: Service
|
||||
items:
|
||||
- name: Client
|
||||
uid: azure.java.sdk.landingpage.services.sdk.Client
|
||||
landingPageType: Service
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core.Client
|
||||
href: ~/docs-ref-services/core-readme.md
|
||||
children:
|
||||
- com.azure.core*
|
||||
- com.azure.core.annotation
|
||||
- com.azure.core.credential
|
||||
- com.azure.core.cryptography
|
||||
- com.azure.core.exception
|
||||
- com.azure.core.http
|
||||
- com.azure.core.util.logging
|
||||
- com.azure.core.util.paging
|
||||
- com.azure.core.http.policy
|
||||
- com.azure.core.util.polling
|
||||
- com.azure.core.http.rest
|
||||
- com.azure.core.util.serializer
|
||||
- com.azure.core.util.tracing
|
||||
- com.azure.core.util
|
||||
- name: AMQP
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core.AMQP
|
||||
href: ~/docs-ref-services/core-amqp-readme.md
|
||||
children:
|
||||
- com.azure.core.amqp*
|
||||
- name: OkHttp
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core.OkHttp
|
||||
href: ~/docs-ref-services/core-http-okhttp-readme.md
|
||||
children:
|
||||
- com.azure.core.http.okhttp*
|
||||
- name: Netty
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core.Netty
|
||||
href: ~/docs-ref-services/core-http-netty-readme.md
|
||||
children:
|
||||
- com.azure.core.http.netty*
|
||||
- name: Cosmos DB
|
||||
uid: azure.java.sdk.landingpage.services.cosmosdb
|
||||
href: ~/docs-ref-services/cosmosdb.md
|
||||
|
|
@ -529,7 +556,7 @@
|
|||
items:
|
||||
- name: 4.X.X Client
|
||||
uid: azure.java.sdk.landingpage.services.search.Client
|
||||
landingPageType: Service
|
||||
href: ~/docs-ref-services/search-documents-readme.md
|
||||
children:
|
||||
- com.azure.search.documents*
|
||||
- name: Management
|
||||
|
|
@ -549,7 +576,6 @@
|
|||
- name: 7.X.X Client
|
||||
uid: azure.java.sdk.landingpage.services.servicebus.Client
|
||||
href: ~/docs-ref-services/messaging-servicebus-readme.md
|
||||
landingPageType: Service
|
||||
children:
|
||||
- com.azure.messaging.servicebus*
|
||||
- name: Client
|
||||
|
|
|
|||
|
|
@ -1,230 +0,0 @@
|
|||
---
|
||||
title: Azure Cognitive Search client library for Java
|
||||
keywords: Azure, Java, SDK, API, search, azure-search-documents
|
||||
author: maggiepint
|
||||
ms.author: magpint
|
||||
ms.date: 04/16/2020
|
||||
ms.topic: article
|
||||
ms.prod: azure
|
||||
ms.technology: azure
|
||||
ms.devlang: Java
|
||||
ms.service: search
|
||||
---
|
||||
|
||||
# Azure Cognitive Search client library for Java - Version 1.0.0-beta.2
|
||||
|
||||
|
||||
This is the Java client library for [Azure Cognitive Search](https://docs.microsoft.com/en-us/rest/api/searchservice/).
|
||||
Azure Cognitive Search is a fully managed cloud search service that provides a rich search experience to custom applications.
|
||||
This library provides an easy (native) way for a Java developer to interact with the service to accomplish tasks like:
|
||||
create and manage indexes, load data, implement search features, execute queries, and handle results.
|
||||
|
||||
[Source code][source_code] | [Package (Maven)][package] | [API reference documentation][api_documentation]| [Product documentation][search_docs] | [Samples][samples]
|
||||
|
||||
## Getting started
|
||||
|
||||
### Include the package
|
||||
|
||||
[//]: # ({x-version-update-start;com.azure:azure-search-documents;current})
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>com.azure</groupId>
|
||||
<artifactId>azure-search-documents</artifactId>
|
||||
<version>1.0.0-beta.2</version>
|
||||
</dependency>
|
||||
```
|
||||
[//]: # ({x-version-update-end})
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Java Development Kit (JDK) with version 8 or above
|
||||
- [Azure subscription][azure_subscription]
|
||||
- [Cognitive Search service][search]
|
||||
|
||||
### Authenticate the client
|
||||
|
||||
In order to interact with the Cognitive Search service you'll need to create an instance of the Search Client class.
|
||||
To make this possible you will need an [api-key of the Cognitive Search service](https://docs.microsoft.com/en-us/azure/search/search-security-api-keys).
|
||||
|
||||
The SDK provides two clients.
|
||||
|
||||
1. SearchIndexClient for all document operations.
|
||||
2. SearchServiceClient for all CRUD operations on service resources.
|
||||
|
||||
#### Create a SearchServiceClient
|
||||
|
||||
Once you have the values of the Cognitive Search Service [URL endpoint](https://docs.microsoft.com/en-us/azure/search/search-create-service-portal#get-a-key-and-url-endpoint)
|
||||
and [admin key](https://docs.microsoft.com/en-us/azure/search/search-security-api-keys) you can create the Search Service client:
|
||||
|
||||
<!-- embedme ./src/samples/java/com/azure/search/documents/ReadmeSamples.java#L40-L43 -->
|
||||
```Java
|
||||
SearchServiceClient client = new SearchServiceClientBuilder()
|
||||
.endpoint(endpoint)
|
||||
.credential(new AzureKeyCredential(adminKey))
|
||||
.buildClient();
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
<!-- embedme ./src/samples/java/com/azure/search/documents/ReadmeSamples.java#L47-L50 -->
|
||||
```Java
|
||||
SearchServiceAsyncClient client = new SearchServiceClientBuilder()
|
||||
.endpoint(endpoint)
|
||||
.credential(new AzureKeyCredential(adminKey))
|
||||
.buildAsyncClient();
|
||||
```
|
||||
|
||||
#### Create a SearchIndexClient
|
||||
|
||||
To create a SearchIndexClient, you will need an existing index name as well as the values of the Cognitive Search Service
|
||||
[URL endpoint](https://docs.microsoft.com/en-us/azure/search/search-create-service-portal#get-a-key-and-url-endpoint) and
|
||||
[query key](https://docs.microsoft.com/en-us/azure/search/search-security-api-keys).
|
||||
Note that you will need an admin key to index documents (query keys only work for queries).
|
||||
|
||||
<!-- embedme ./src/samples/java/com/azure/search/documents/ReadmeSamples.java#L54-L58 -->
|
||||
```Java
|
||||
SearchIndexClient client = new SearchIndexClientBuilder()
|
||||
.endpoint(endpoint)
|
||||
.credential(new AzureKeyCredential(apiKey))
|
||||
.indexName(indexName)
|
||||
.buildClient();
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
<!-- embedme ./src/samples/java/com/azure/search/documents/ReadmeSamples.java#L62-L66 -->
|
||||
```Java
|
||||
SearchIndexAsyncClient client = new SearchIndexClientBuilder()
|
||||
.endpoint(endpoint)
|
||||
.credential(new AzureKeyCredential(apiKey))
|
||||
.indexName(indexName)
|
||||
.buildAsyncClient();
|
||||
```
|
||||
|
||||
## Key concepts
|
||||
|
||||
Azure Cognitive Search has the concepts of search services and indexes and documents, where a search service contains
|
||||
one or more indexes that provides persistent storage of searchable data, and data is loaded in the form of JSON documents.
|
||||
Data can be pushed to an index from an external data source, but if you use an indexer, it's possible to crawl a data
|
||||
source to extract and load data into an index.
|
||||
|
||||
There are several types of operations that can be executed against the service:
|
||||
|
||||
- [Index management operations](https://docs.microsoft.com/en-us/rest/api/searchservice/index-operations). Create, delete, update, or configure a search index.
|
||||
- [Document operations](https://docs.microsoft.com/en-us/rest/api/searchservice/document-operations). Add, update, or delete documents in the index, query the index, or look up specific documents by ID.
|
||||
- [Indexer operations](https://docs.microsoft.com/en-us/rest/api/searchservice/indexer-operations). Automate aspects of an indexing operation by configuring a data source and an indexer that you can schedule or run on demand. This feature is supported for a limited number of data source types.
|
||||
- [Skillset operations](https://docs.microsoft.com/en-us/rest/api/searchservice/skillset-operations). Part of AI workload, a skillset defines a series of a series of enrichment processing steps. A skillset is consumed by an indexer.
|
||||
- [Synonym map operations](https://docs.microsoft.com/en-us/rest/api/searchservice/synonym-map-operations). A synonym map is a service-level resource that contains user-defined synonyms. This resource is maintained independently from search indexes. Once uploaded, you can point any searchable field to the synonym map (one per field).
|
||||
|
||||
## Examples
|
||||
|
||||
### Create an index
|
||||
|
||||
Create Index using `SearchIndexClient` create in above [section](Create-a-SearchIndexClient)
|
||||
|
||||
<!-- embedme ./src/samples/java/com/azure/search/documents/ReadmeSamples.java#L96-L107 -->
|
||||
```java
|
||||
Index newIndex = new Index()
|
||||
.setName("index_name")
|
||||
.setFields(
|
||||
Arrays.asList(new Field()
|
||||
.setName("Name")
|
||||
.setType(DataType.EDM_STRING)
|
||||
.setKey(Boolean.TRUE),
|
||||
new Field()
|
||||
.setName("Cuisine")
|
||||
.setType(DataType.EDM_STRING)));
|
||||
// Create index.
|
||||
searchClient.createIndex(newIndex);
|
||||
```
|
||||
### Upload a Document
|
||||
|
||||
Upload hotel document to Search Index.
|
||||
|
||||
<!-- embedme ./src/samples/java/com/azure/search/documents/ReadmeSamples.java#L111-L116 -->
|
||||
```java
|
||||
List<Hotel> hotels = new ArrayList<>();
|
||||
hotels.add(new Hotel().setHotelId("100"));
|
||||
hotels.add(new Hotel().setHotelId("200"));
|
||||
hotels.add(new Hotel().setHotelId("300"));
|
||||
// Upload hotel.
|
||||
indexClient.uploadDocuments(hotels);
|
||||
```
|
||||
|
||||
### Search on hotel name
|
||||
|
||||
Search hotel using keyword.
|
||||
|
||||
<!-- embedme ./src/samples/java/com/azure/search/documents/ReadmeSamples.java#L120-L130 -->
|
||||
```java
|
||||
// Perform a text-based search
|
||||
for (SearchResult result : indexClient.search("luxury hotel",
|
||||
new SearchOptions(), new RequestOptions(), Context.NONE)) {
|
||||
|
||||
// Each result is a dynamic Map
|
||||
SearchDocument doc = result.getDocument();
|
||||
String hotelName = (String) doc.get("HotelName");
|
||||
Double rating = (Double) doc.get("Rating");
|
||||
|
||||
System.out.printf("%s: %s%n", hotelName, rating);
|
||||
}
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### General
|
||||
|
||||
When you interact with Azure Cognitive Search using this Java client library, errors returned by the service correspond
|
||||
to the same HTTP status codes returned for [REST API][rest_api] requests. For example, if you try to retrieve a document
|
||||
that doesn't exist in your index, a `404` error is returned, indicating `Not Found`.
|
||||
|
||||
### Enabling Logging
|
||||
|
||||
Azure SDKs for Java offer a consistent logging story to help aid in troubleshooting application errors and expedite
|
||||
their resolution. The logs produced will capture the flow of an application before reaching the terminal state to help
|
||||
locate the root issue. View the [logging][logging] wiki for guidance about enabling logging.
|
||||
|
||||
### Default HTTP Client
|
||||
|
||||
By default a Netty based HTTP client will be used, for more information on configuring or changing the HTTP client is
|
||||
detailed in the [HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients).
|
||||
|
||||
## Next steps
|
||||
|
||||
- Samples are explained in detail [here][samples_readme].
|
||||
- [Watch a demo or deep dive video](https://azure.microsoft.com/resources/videos/index/?services=search)
|
||||
- [Read more about the Azure Cognitive Search service](https://docs.microsoft.com/azure/search/search-what-is-azure-search)
|
||||
|
||||
## Contributing
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
[Contributor License Agreement (CLA)][cla] declaring that you have the right to, and actually do, grant us the rights
|
||||
to use your contribution.
|
||||
|
||||
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate
|
||||
the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to
|
||||
do this once across all repos using our CLA.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq]
|
||||
or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.
|
||||
|
||||
<!-- LINKS -->
|
||||
|
||||
[api_documentation]: https://aka.ms/java-docs
|
||||
[search]: https://azure.microsoft.com/en-us/services/search/
|
||||
[search_docs]: https://docs.microsoft.com/en-us/azure/search/
|
||||
[azure_subscription]: https://azure.microsoft.com/free
|
||||
[maven]: https://maven.apache.org/
|
||||
[package]: https://search.maven.org/artifact/com.azure/azure-search-documents
|
||||
[samples]: https://github.com/Azure/azure-sdk-for-java/tree/2d2f9b2c1c5f73f0b4bfb2eabe376239998e98d7/../../azure-sdk-for-java/sdk/search/azure-search-documents/src/samples/java/com/azure/search
|
||||
[samples_readme]: https://github.com/Azure/azure-sdk-for-java/tree/2d2f9b2c1c5f73f0b4bfb2eabe376239998e98d7/../../azure-sdk-for-java/sdk/search/azure-search-documents/src/samples/README.md
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-java/tree/2d2f9b2c1c5f73f0b4bfb2eabe376239998e98d7/../../azure-sdk-for-java/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/master/sdk/core/azure-core/src/main/java/com/azure/core/http/policy/AddHeadersFromContextPolicy.java
|
||||
[rest_api]: https://docs.microsoft.com/en-us/rest/api/searchservice/http-status-codes
|
||||
|
||||
|
||||
|
|
@ -107,7 +107,7 @@
|
|||
"packageVersion": "1.2.0",
|
||||
"inputPath": [],
|
||||
"excludePath": [],
|
||||
"excludepackages": "com.azure.core.amqp.implementation"
|
||||
"excludepackages": "com.azure.core.amqp.implementation:com.azure.core.amqp.implementation.handler"
|
||||
},
|
||||
{
|
||||
"packageDownloadUrl": "https://repo1.maven.org/maven2",
|
||||
|
|
|
|||
|
|
@ -4,23 +4,35 @@
|
|||
expanded: false
|
||||
items:
|
||||
- name: Container Instance
|
||||
uid: azure.java.sdk.landingpage.services.containerinstance
|
||||
uid: azure.java.sdk.landingpage.services.containerinstance.pre
|
||||
landingPageType: Service
|
||||
items:
|
||||
- name: Management
|
||||
uid: azure.java.sdk.landingpage.services.containerinstance.Management
|
||||
uid: azure.java.sdk.landingpage.services.containerinstance.Management.pre
|
||||
landingPageType: Service
|
||||
children:
|
||||
- com.microsoft.azure.management.containerinstance*
|
||||
- name: Core
|
||||
uid: azure.java.sdk.landingpage.services.sdk.pre
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core.pre
|
||||
landingPageType: Service
|
||||
items:
|
||||
- name: Client
|
||||
uid: azure.java.sdk.landingpage.services.sdk.Client.pre
|
||||
landingPageType: Service
|
||||
uid: azure.java.sdk.landingpage.services.sdk.core.Client.pre
|
||||
children:
|
||||
- com.azure.core*
|
||||
- com.azure.core.annotation
|
||||
- com.azure.core.credential
|
||||
- com.azure.core.cryptography
|
||||
- com.azure.core.exception
|
||||
- com.azure.core.http
|
||||
- com.azure.core.util.logging
|
||||
- com.azure.core.util.paging
|
||||
- com.azure.core.http.policy
|
||||
- com.azure.core.util.polling
|
||||
- com.azure.core.http.rest
|
||||
- com.azure.core.util.serializer
|
||||
- com.azure.core.util.tracing
|
||||
- com.azure.core.util
|
||||
landingPageType: Service
|
||||
- name: Event Hubs
|
||||
uid: azure.java.sdk.landingpage.services.eventhub.pre
|
||||
items:
|
||||
|
|
@ -84,7 +96,7 @@
|
|||
items:
|
||||
- name: 4.X.X Client
|
||||
uid: azure.java.sdk.landingpage.services.search.Client.pre
|
||||
landingPageType: Service
|
||||
href: ~/docs-ref-services/search-documents-readme-pre.md
|
||||
children:
|
||||
- com.azure.search.documents*
|
||||
- name: Service Bus
|
||||
|
|
@ -93,7 +105,6 @@
|
|||
- name: 7.X.X Client
|
||||
uid: azure.java.sdk.landingpage.services.servicebus.Client.pre
|
||||
href: ~/docs-ref-services/messaging-servicebus-readme-pre.md
|
||||
landingPageType: Service
|
||||
children:
|
||||
- com.azure.messaging.servicebus*
|
||||
landingPageType: Service
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче