Skip to content

Commit

Permalink
Release edits for Search (#11178)
Browse files Browse the repository at this point in the history
* fix README typo

* Getting started section order

* add first search request subsection

* update CHANGELOG
  • Loading branch information
bryevdv authored May 1, 2020
1 parent e8f9637 commit c8ade95
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 11 deletions.
12 changes: 11 additions & 1 deletion sdk/search/azure-search-documents/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# Release History

## 1.0.0b3 (Unreleased)
## 1.0.0b3 (2020-05-04)

**Features**

- Add support for synonym maps operations #10830
- Add support for skillset operations #10832
- Add support of indexers operation #10836
- Add helpers for defining searchindex fields #10833

**Breaking Changes**

- `SearchIndexClient` renamed to `SearchClient`

## 1.0.0b2 (2020-04-07)

Expand Down
30 changes: 20 additions & 10 deletions sdk/search/azure-search-documents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ Azure Cognitive Search is a fully managed cloud search service that provides a r

## Getting started

### Install the package

Install the Azure Cognitive Search client library for Python with [pip](https://pypi.org/project/pip/):

```bash
pip install azure-search-documents --pre
```

### Prerequisites

* Python 2.7, or 3.5 or later is required to use this package.
Expand All @@ -27,15 +35,6 @@ az search service create --resource-group <your-resource-group-name> --name <you

The above creates a resource with the "Standard" pricing tier. See [choosing a pricing tier](https://docs.microsoft.com/en-us/azure/search/search-sku-tier) for more information.


### Install the package

Install the Azure Cognitive Search client library for Python with [pip](https://pypi.org/project/pip/):

```bash
pip install azure-search-documents --pre
```

### Authenticate the client

In order to interact with the Cognitive Search service you'll need to create an instance of the Search Client class.
Expand Down Expand Up @@ -80,6 +79,17 @@ client = SearchServiceClient(endpoint="<service endpoint>"
credential=credential)
```

### Send your first search request

You can use the `SearchClient` you created in the first section above to make a basic search request:
```python
results = client.search(query="spa")

print("Hotels containing 'spa' in the name (or other fields):")
for result in results:
print(" Name: {} (rating {})".format(result["HotelName"], result["Rating"]))
```

## Key concepts

Azure Cognitive Search has the concepts of search services and indexes and documents, where a search service contains
Expand Down Expand Up @@ -209,7 +219,7 @@ This library uses the standard [logging][python_logging] library for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
level.

etailed DEBUG level logging, including request/response bodies and unredacted
Detailed DEBUG level logging, including request/response bodies and unredacted
headers, can be enabled on a client with the `logging_enable` keyword argument:
```python
import sys
Expand Down

0 comments on commit c8ade95

Please sign in to comment.