Skip to content

Commit 3aec68f

Browse files
HeidiSteenHeidiSteen
authored
Merge pull request #16 from HeidiSteen/heidist-master
 Per-sample readme files
2 parents 58778d1 + 82e14a4 commit 3aec68f

File tree

7 files changed

+282
-118
lines changed

7 files changed

+282
-118
lines changed

‎CONTRIBUTING.md renamed to ‎Quickstart/CONTRIBUTING.md

Lines changed: 76 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,76 @@
1-
# Contributing to Azure Search Python Samples
2-
3-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
4-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
5-
the rights to use your contribution. For details, visit https://cla.microsoft.com.
6-
7-
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
8-
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
9-
provided by the bot. You will only need to do this once across all repos using our CLA.
10-
11-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
12-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
13-
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
14-
15-
- [Code of Conduct](#coc)
16-
- [Issues and Bugs](#issue)
17-
- [Feature Requests](#feature)
18-
- [Submission Guidelines](#submit)
19-
20-
## <a name="coc"></a> Code of Conduct
21-
Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
22-
23-
## <a name="issue"></a> Found an Issue?
24-
If you find a bug in the source code or a mistake in the documentation, you can help us by
25-
[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can
26-
[submit a Pull Request](#submit-pr) with a fix.
27-
28-
## <a name="feature"></a> Want a Feature?
29-
You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub
30-
Repository. If you would like to *implement* a new feature, please submit an issue with
31-
a proposal for your work first, to be sure that we can use it.
32-
33-
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
34-
35-
## <a name="submit"></a> Submission Guidelines
36-
37-
### <a name="submit-issue"></a> Submitting an Issue
38-
Before you submit an issue, search the archive, maybe your question was already answered.
39-
40-
If your issue appears to be a bug, and hasn't been reported, open a new issue.
41-
Help us to maximize the effort we can spend fixing issues and adding new
42-
features, by not reporting duplicate issues. Providing the following information will increase the
43-
chances of your issue being dealt with quickly:
44-
45-
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
46-
* **Version** - what version is affected (e.g. 0.1.2)
47-
* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
48-
* **Browsers and Operating System** - is this a problem with all browsers?
49-
* **Reproduce the Error** - provide a live example or a unambiguous set of steps
50-
* **Related Issues** - has a similar issue been reported before?
51-
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
52-
causing the problem (line of code or commit)
53-
54-
You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new].
55-
56-
### <a name="submit-pr"></a> Submitting a Pull Request (PR)
57-
Before you submit your Pull Request (PR) consider the following guidelines:
58-
59-
* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR
60-
that relates to your submission. You don't want to duplicate effort.
61-
62-
* Make your changes in a new git fork:
63-
64-
* Commit your changes using a descriptive commit message
65-
* Push your fork to GitHub:
66-
* In GitHub, create a pull request
67-
* If we suggest changes then:
68-
* Make the required updates.
69-
* Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
70-
71-
```shell
72-
git rebase master -i
73-
git push -f
74-
```
75-
76-
That's it! Thank you for your contribution!
1+
# Contributing to the Python quickstart for Azure Search
2+
3+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
4+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
5+
the rights to use your contribution. For details, visit https://cla.microsoft.com.
6+
7+
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
8+
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
9+
provided by the bot. You will only need to do this once across all repos using our CLA.
10+
11+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
12+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
13+
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
14+
15+
- [Code of Conduct](#coc)
16+
- [Issues and Bugs](#issue)
17+
- [Feature Requests](#feature)
18+
- [Submission Guidelines](#submit)
19+
20+
## <a name="coc"></a> Code of Conduct
21+
Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
22+
23+
## <a name="issue"></a> Found an Issue?
24+
If you find a bug in the source code or a mistake in the documentation, you can help us by
25+
[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can
26+
[submit a Pull Request](#submit-pr) with a fix.
27+
28+
## <a name="feature"></a> Want a Feature?
29+
You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub
30+
Repository. If you would like to *implement* a new feature, please submit an issue with
31+
a proposal for your work first, to be sure that we can use it.
32+
33+
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
34+
35+
## <a name="submit"></a> Submission Guidelines
36+
37+
### <a name="submit-issue"></a> Submitting an Issue
38+
Before you submit an issue, search the archive, maybe your question was already answered.
39+
40+
If your issue appears to be a bug, and hasn't been reported, open a new issue.
41+
Help us to maximize the effort we can spend fixing issues and adding new
42+
features, by not reporting duplicate issues. Providing the following information will increase the
43+
chances of your issue being dealt with quickly:
44+
45+
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
46+
* **Version** - what version is affected (e.g. 0.1.2)
47+
* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
48+
* **Browsers and Operating System** - is this a problem with all browsers?
49+
* **Reproduce the Error** - provide a live example or a unambiguous set of steps
50+
* **Related Issues** - has a similar issue been reported before?
51+
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
52+
causing the problem (line of code or commit)
53+
54+
You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new].
55+
56+
### <a name="submit-pr"></a> Submitting a Pull Request (PR)
57+
Before you submit your Pull Request (PR) consider the following guidelines:
58+
59+
* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR
60+
that relates to your submission. You don't want to duplicate effort.
61+
62+
* Make your changes in a new git fork:
63+
64+
* Commit your changes using a descriptive commit message
65+
* Push your fork to GitHub:
66+
* In GitHub, create a pull request
67+
* If we suggest changes then:
68+
* Make the required updates.
69+
* Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
70+
71+
```shell
72+
git rebase master -i
73+
git push -f
74+
```
75+
76+
That's it! Thank you for your contribution!

‎LICENSE.md renamed to ‎Quickstart/LICENSE.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
MIT License
2-
3-
Copyright (c) Microsoft Corporation. All rights reserved.
4-
5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11-
12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1+
MIT License
2+
3+
Copyright (c) Microsoft Corporation. All rights reserved.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
SOFTWARE

‎Quickstart/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
page_type: sample
3+
topic: sample
4+
languages:
5+
- python
6+
products:
7+
- azure
8+
- azure-search
9+
---
10+
11+
# Python quickstart for Azure Search
12+
13+
This sample is a Jupyter Python3 .ipynb file used in [Quickstart: Create and query an Azure Search index using a Jupyter Python notebook](https://docs.microsoft.com/azure/search/search-get-started-python). It demonstrates a connection to Azure Search, creating and loading an index, and query execution.
14+
15+
## Contents
16+
17+
| File/folder | Description |
18+
|-------------|-------------|
19+
| `azure-search-quickstart.ipynb` | Jupyter Python notebook. |
20+
| `.gitignore` | Define what to ignore at commit time. |
21+
| `CONTRIBUTING.md` | Guidelines for contributing to the sample. |
22+
| `README.md` | This README file. |
23+
| `LICENSE` | The license for the sample. |
24+
25+
## Prerequisites
26+
27+
- [Anaconda 3.x](https://www.anaconda.com/distribution/#download-section), providing Python 3.x and Jupyter Notebooks
28+
- [Azure Search service](https://docs.microsoft.com/en-us/azure/search/search-create-service-portal)
29+
30+
## Setup
31+
32+
1. Clone or download this sample repository.
33+
2. Extract contents if the download is a zip file. Make sure the files are read-write.
34+
35+
## Running the sample
36+
1. Start Jupyter Notebook. On Windows with Anaconda3, you can use Anaconda Navigator to launch a notebook from the Start menu.
37+
1. Open the azure-search-quickstart.ipynb file in Jupyter Notebook
38+
1. Replace <YOUR-SERVICE-NAME> and <YOUR-ADMIN-API-KEY> with the service and api-key details of your Azure Search service
39+
1. Run each step individually

‎README.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,12 @@ products:
1010

1111
# Python sample repository for Azure Search
1212

13-
This repository contains Python sample code used in Azure Search quickstarts, tutorials, and examples. You can use the shared (free) Azure Search service to run any sample in this repository.
13+
This repository contains Python sample code used in Azure Search quickstarts, tutorials, and examples. You can use the shared (free) Azure Search service to run any sample in this repository. Samples are in individual folders in this repository.
1414

15-
## Quickstart
15+
## Python Quickstart - Azure Search
1616

17-
This sample is a Jupyter Python3 .ipynb file used in [Quickstart: Create and query an Azure Search index using a Jupyter Python notebook](https://docs.microsoft.com/azure/search/search-get-started-python).
18-
19-
### Run the quickstart
20-
+ Open the azure-search-quickstart.ipynb file in Jupyter Notebook
21-
+ Replace <YOUR-SERVICE-NAME> and <YOUR-ADMIN-API-KEY> with the service and api-key details of your Azure Search service
22-
+ Run each step individually
17+
This sample is a Jupyter Python3 .ipynb file used in [Quickstart: Create and query an Azure Search index using a Jupyter Python notebook](https://docs.microsoft.com/azure/search/search-get-started-python). Use this sample to learn service connections, index creation, data ingestion, and basic queries.
2318

2419
## Tutorial-AI-Enrichment-Jupyter-Notebook
2520

26-
This sample is a Jupyter Python3 .ipynb file used in [Python Tutorial: Call Cognitive Services APIs in an Azure Search indexing pipeline](https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob-python).
27-
28-
This sample creates an Azure Search indexing pipeline that searches for and extracts text and text representations of images and scanned documents stored as blobs in Azure Blob storage. This sample leverages cognitive skills from the Azure Cognitive Services API, such as entity recognition and language detection.
29-
30-
### Run the tutorial
31-
+ Open the PythonTutorial-AzureSearch-AIEnrichment.ipynb file in Jupyter Notebook
32-
+ Replace <YOUR-SERVICE-NAME> and <YOUR-ADMIN-API-KEY> with the service and api-key details of your Azure Search service
33-
+ Replace <YOUR-BLOB-RESOURCE-CONNECTION-STRING> with a connection string to an Azure Blob storage resource that you created, and to which you uploaded [content files](https://github.com/Azure-Samples/azure-search-sample-data/tree/master/mixedContent) of various file types.
34-
+ Run each step individually
35-
36-
By sequentially executing each step, you can verify the printed response status or response output appears before continuing to the next step. The step that creates the indexer, in particular, may take a few minutes to complete. See the tutorial for more details.
37-
38-
39-
21+
This sample is also a Jupyter Python3 .ipynb file. It's used in the [Python Tutorial: Call Cognitive Services APIs in an Azure Search indexing pipeline](https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob-python). This sample demonstrates cognitive search functionality, adding AI enrichments from Cognitive Services to extract, detect, and analyze information from image files or large unstructured document files.

‎Tutorial-AI-Enrichment-Jupyter-Notebook/CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributing to the Python tutorial for AI enrichment in Azure Searh.
2+
3+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
4+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
5+
the rights to use your contribution. For details, visit https://cla.microsoft.com.
6+
7+
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
8+
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
9+
provided by the bot. You will only need to do this once across all repos using our CLA.
10+
11+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
12+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
13+
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
14+
15+
- [Code of Conduct](#coc)
16+
- [Issues and Bugs](#issue)
17+
- [Feature Requests](#feature)
18+
- [Submission Guidelines](#submit)
19+
20+
## <a name="coc"></a> Code of Conduct
21+
Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
22+
23+
## <a name="issue"></a> Found an Issue?
24+
If you find a bug in the source code or a mistake in the documentation, you can help us by
25+
[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can
26+
[submit a Pull Request](#submit-pr) with a fix.
27+
28+
## <a name="feature"></a> Want a Feature?
29+
You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub
30+
Repository. If you would like to *implement* a new feature, please submit an issue with
31+
a proposal for your work first, to be sure that we can use it.
32+
33+
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
34+
35+
## <a name="submit"></a> Submission Guidelines
36+
37+
### <a name="submit-issue"></a> Submitting an Issue
38+
Before you submit an issue, search the archive, maybe your question was already answered.
39+
40+
If your issue appears to be a bug, and hasn't been reported, open a new issue.
41+
Help us to maximize the effort we can spend fixing issues and adding new
42+
features, by not reporting duplicate issues. Providing the following information will increase the
43+
chances of your issue being dealt with quickly:
44+
45+
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
46+
* **Version** - what version is affected (e.g. 0.1.2)
47+
* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
48+
* **Browsers and Operating System** - is this a problem with all browsers?
49+
* **Reproduce the Error** - provide a live example or a unambiguous set of steps
50+
* **Related Issues** - has a similar issue been reported before?
51+
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
52+
causing the problem (line of code or commit)
53+
54+
You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new].
55+
56+
### <a name="submit-pr"></a> Submitting a Pull Request (PR)
57+
Before you submit your Pull Request (PR) consider the following guidelines:
58+
59+
* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR
60+
that relates to your submission. You don't want to duplicate effort.
61+
62+
* Make your changes in a new git fork:
63+
64+
* Commit your changes using a descriptive commit message
65+
* Push your fork to GitHub:
66+
* In GitHub, create a pull request
67+
* If we suggest changes then:
68+
* Make the required updates.
69+
* Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
70+
71+
```shell
72+
git rebase master -i
73+
git push -f
74+
```
75+
76+
That's it! Thank you for your contribution!

0 commit comments

Comments
 (0)