-
Notifications
You must be signed in to change notification settings - Fork 100
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Postman collection for the cognitive search tutorial
- Loading branch information
1 parent
184297a
commit d37a794
Showing
6 changed files
with
501 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # Contributing to the cognitive search tutorial | ||
|
|
||
| This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
| Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
| the rights to use your contribution. For details, visit https://cla.microsoft.com. | ||
|
|
||
| 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](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
| contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| - [Code of Conduct](#coc) | ||
| - [Issues and Bugs](#issue) | ||
| - [Feature Requests](#feature) | ||
| - [Submission Guidelines](#submit) | ||
|
|
||
| ## <a name="coc"></a> Code of Conduct | ||
| Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
|
|
||
| ## <a name="issue"></a> Found an Issue? | ||
| If you find a bug in the source code or a mistake in the documentation, you can help us by | ||
| [submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can | ||
| [submit a Pull Request](#submit-pr) with a fix. | ||
|
|
||
| ## <a name="feature"></a> Want a Feature? | ||
| You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub | ||
| Repository. If you would like to *implement* a new feature, please submit an issue with | ||
| a proposal for your work first, to be sure that we can use it. | ||
|
|
||
| * **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). | ||
|
|
||
| ## <a name="submit"></a> Submission Guidelines | ||
|
|
||
| ### <a name="submit-issue"></a> Submitting an Issue | ||
| Before you submit an issue, search the archive, maybe your question was already answered. | ||
|
|
||
| If your issue appears to be a bug, and hasn't been reported, open a new issue. | ||
| Help us to maximize the effort we can spend fixing issues and adding new | ||
| features, by not reporting duplicate issues. Providing the following information will increase the | ||
| chances of your issue being dealt with quickly: | ||
|
|
||
| * **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps | ||
| * **Version** - what version is affected (e.g. 0.1.2) | ||
| * **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you | ||
| * **Browsers and Operating System** - is this a problem with all browsers? | ||
| * **Reproduce the Error** - provide a live example or a unambiguous set of steps | ||
| * **Related Issues** - has a similar issue been reported before? | ||
| * **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be | ||
| causing the problem (line of code or commit) | ||
|
|
||
| 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]. | ||
|
|
||
| ### <a name="submit-pr"></a> Submitting a Pull Request (PR) | ||
| Before you submit your Pull Request (PR) consider the following guidelines: | ||
|
|
||
| * Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR | ||
| that relates to your submission. You don't want to duplicate effort. | ||
|
|
||
| * Make your changes in a new git fork: | ||
|
|
||
| * Commit your changes using a descriptive commit message | ||
| * Push your fork to GitHub: | ||
| * In GitHub, create a pull request | ||
| * If we suggest changes then: | ||
| * Make the required updates. | ||
| * Rebase your fork and force push to your GitHub repository (this will update your Pull Request): | ||
|
|
||
| ```shell | ||
| git rebase master -i | ||
| git push -f | ||
| ``` | ||
|
|
||
| That's it! Thank you for your contribution! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) Microsoft Corporation. All rights reserved. | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| page_type: sample | ||
| languages: | ||
| - rest | ||
| name: Cognitive Search Tutorial in REST - Postman | ||
| description: | | ||
| Learn how to create a cognitive search pipeline to extract information and structure from unstructured blobs.. | ||
| products: | ||
| - azure | ||
| - azure-search | ||
| urlFragment: rest-api-tutorial | ||
| --- | ||
|
|
||
| # Cognitive search sample for Azure Search using REST APIs and Postman | ||
|
|
||
|  | ||
|
|
||
| Demonstrates using Postman and the Azure Search REST APIs to send requests to Azure Search: create a data source, a skillset, index, and indexer. Requests are provided in the V2 collection format, which you can import and then modify for connections to your Azure Search service. | ||
|
|
||
| This collection is featured in the [REST Tutorial: Add structure to "unstructured content" with cognitive search](https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob). When you import the collection, modify the headers and URL to use your service name and API key. The purpose of this sample is to demonstrate how creating a cognitive search pipeline adds new information and structure to unstructured files. | ||
|
|
||
| ## Contents | ||
|
|
||
| | File/folder | Description | | ||
| |-------------|-------------| | ||
| | `cog-search-demo REST tutorial.postman_collection.json` | Import into Postman | | ||
| | `.gitignore` | Define what to ignore at commit time. | | ||
| | `CONTRIBUTING.md` | Guidelines for contributing to the sample. | | ||
| | `README.md` | This README file. | | ||
| | `LICENSE` | The license for the sample. | | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [Postman Desktop app](https://www.getpostman.com/) | ||
| - [Azure Search service](https://docs.microsoft.com/azure/search/search-create-service-portal) | ||
|
|
||
| ## Setup | ||
|
|
||
| 1. Clone or download this sample repository. | ||
| 1. Extract contents if the download is a zip file. Make sure the files are read-write. | ||
|
|
||
| ### Running quickstart | ||
| 1. Start Postman and import cog-search-demo REST tutorial.postman_collection.json | ||
| 1. For each request, update the Header to use the admin api-key of your service, which you can obtain from the portal. | ||
| 1. Next, update the URL of each request to use the name of your search service. | ||
| 1. Send each request to the service. | ||
|
|
||
| ## Next steps | ||
|
|
||
| You can learn more about Azure Search on the [official documentation site](https://docs.microsoft.com/azure/search). |
Oops, something went wrong.