Text Analytics API (v3.1).postman_collection.json

{
	"info": {
		"_postman_id": "50fc49c5-b91b-410d-9f9c-863d626da939",
		"name": "Text Analytics API (v3.1)",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
		"_exporter_id": "24041745"
	},
	"item": [
		{
			"name": "Detect Language",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					},
					{
						"key": "Ocp-Apim-Subscription-Key",
						"value": "{{api_key}}",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\r\n  \"documents\": [\r\n    {\r\n      \"countryHint\": \"US\",\r\n      \"id\": \"1\",\r\n      \"text\": \"Hello world\"\r\n    },\r\n    {\r\n      \"id\": \"2\",\r\n      \"text\": \"Bonjour tout le monde\"\r\n    },\r\n    {\r\n      \"id\": \"3\",\r\n      \"text\": \"La carretera estaba atascada. Había mucho tráfico el día de ayer.\"\r\n    }\r\n  ]\r\n}"
				},
				"url": {
					"raw": "https://westeurope.api.cognitive.microsoft.com/text/analytics/v3.1/languages",
					"protocol": "https",
					"host": [
						"westeurope",
						"api",
						"cognitive",
						"microsoft",
						"com"
					],
					"path": [
						"text",
						"analytics",
						"v3.1",
						"languages"
					],
					"query": [
						{
							"key": "model-version",
							"value": "",
							"description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.",
							"disabled": true
						},
						{
							"key": "showStats",
							"value": "",
							"description": "(Optional) if set to true, response will contain request and document level statistics.",
							"disabled": true
						},
						{
							"key": "loggingOptOut",
							"value": "",
							"description": "(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. ",
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "Entities containing personal information",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					},
					{
						"key": "Ocp-Apim-Subscription-Key",
						"value": "{{api_key}}",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\r\n\t\"documents\": [\r\n\t\t{\r\n\t\t\t\"id\": \"1\",\r\n\t\t\t\"language\": \"en\",\r\n\t\t\t\"text\": \"My SSN is 859-98-0987\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"2\",\r\n\t\t\t\"language\": \"en\",\r\n\t\t\t\"text\": \"Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check.\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"3\",\r\n\t\t\t\"language\": \"en\",\r\n\t\t\t\"text\": \"Is 998.214.865-68 your Brazilian CPF number?\"\r\n\t\t}\r\n\t]\r\n}"
				},
				"url": {
					"raw": "https://westeurope.api.cognitive.microsoft.com/text/analytics/v3.1/entities/recognition/pii",
					"protocol": "https",
					"host": [
						"westeurope",
						"api",
						"cognitive",
						"microsoft",
						"com"
					],
					"path": [
						"text",
						"analytics",
						"v3.1",
						"entities",
						"recognition",
						"pii"
					],
					"query": [
						{
							"key": "model-version",
							"value": "",
							"description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.",
							"disabled": true
						},
						{
							"key": "showStats",
							"value": "",
							"description": "(Optional) if set to true, response will contain request and document level statistics.",
							"disabled": true
						},
						{
							"key": "loggingOptOut",
							"value": "",
							"description": "(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. ",
							"disabled": true
						},
						{
							"key": "domain",
							"value": "",
							"description": "(Optional) if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.",
							"disabled": true
						},
						{
							"key": "stringIndexType",
							"value": "",
							"description": "(Optional) Specifies the method used to interpret string offsets. ",
							"disabled": true
						},
						{
							"key": "piiCategories",
							"value": "",
							"description": "(Optional) describes the PII categories to return",
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "Key Phrases",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					},
					{
						"key": "Ocp-Apim-Subscription-Key",
						"value": "{{api_key}}",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\r\n  \"documents\": [\r\n    {\r\n      \"language\": \"en\",\r\n      \"id\": \"1\",\r\n      \"text\": \"Hello world. This is some input text that I love.\"\r\n    },\r\n    {\r\n      \"language\": \"fr\",\r\n      \"id\": \"2\",\r\n      \"text\": \"Bonjour tout le monde\"\r\n    },\r\n    {\r\n      \"language\": \"es\",\r\n      \"id\": \"3\",\r\n      \"text\": \"La carretera estaba atascada. Había mucho tráfico el día de ayer.\"\r\n    }\r\n  ]\r\n}"
				},
				"url": {
					"raw": "https://westeurope.api.cognitive.microsoft.com/text/analytics/v3.1/keyPhrases",
					"protocol": "https",
					"host": [
						"westeurope",
						"api",
						"cognitive",
						"microsoft",
						"com"
					],
					"path": [
						"text",
						"analytics",
						"v3.1",
						"keyPhrases"
					],
					"query": [
						{
							"key": "model-version",
							"value": "",
							"description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.",
							"disabled": true
						},
						{
							"key": "showStats",
							"value": "",
							"description": "(Optional) if set to true, response will contain request and document level statistics.",
							"disabled": true
						},
						{
							"key": "loggingOptOut",
							"value": "",
							"description": "(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. ",
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "Linked entities from a well known knowledge base",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					},
					{
						"key": "Ocp-Apim-Subscription-Key",
						"value": "{{api_key}}",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\r\n  \"documents\": [\r\n    {\r\n      \"language\": \"en\",\r\n      \"id\": \"1\",\r\n      \"text\": \"I had a wonderful trip to Seattle last week.\"\r\n    },\r\n    {\r\n      \"language\": \"en\",\r\n      \"id\": \"2\",\r\n      \"text\": \"I work at Microsoft.\"\r\n    },\r\n    {\r\n      \"language\": \"en\",\r\n      \"id\": \"3\",\r\n      \"text\": \"I visited Space Needle 2 times.\"\r\n    }\r\n  ]\r\n}"
				},
				"url": {
					"raw": "https://westeurope.api.cognitive.microsoft.com/text/analytics/v3.1/entities/linking",
					"protocol": "https",
					"host": [
						"westeurope",
						"api",
						"cognitive",
						"microsoft",
						"com"
					],
					"path": [
						"text",
						"analytics",
						"v3.1",
						"entities",
						"linking"
					],
					"query": [
						{
							"key": "stringIndexType",
							"value": "TextElement_v8",
							"description": "(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0.",
							"disabled": true
						},
						{
							"key": "model-version",
							"value": "",
							"description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.",
							"disabled": true
						},
						{
							"key": "showStats ",
							"value": "",
							"description": "(Optional) if set to true, response will contain request and document level statistics.",
							"disabled": true
						},
						{
							"key": "loggingOptOut",
							"value": "",
							"description": "(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions",
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "Named Entity Recognition",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					},
					{
						"key": "Ocp-Apim-Subscription-Key",
						"value": "{{api_key}}",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\r\n  \"documents\": [\r\n    {\r\n      \"language\": \"en\",\r\n      \"id\": \"1\",\r\n      \"text\": \"I had a wonderful trip to Seattle last week.\"\r\n    },\r\n    {\r\n      \"language\": \"en\",\r\n      \"id\": \"2\",\r\n      \"text\": \"I work at Microsoft.\"\r\n    },\r\n    {\r\n      \"language\": \"en\",\r\n      \"id\": \"3\",\r\n      \"text\": \"I visited Space Needle 2 times.\"\r\n    }\r\n  ]\r\n}"
				},
				"url": {
					"raw": "https://westeurope.api.cognitive.microsoft.com/text/analytics/v3.1/entities/recognition/general",
					"protocol": "https",
					"host": [
						"westeurope",
						"api",
						"cognitive",
						"microsoft",
						"com"
					],
					"path": [
						"text",
						"analytics",
						"v3.1",
						"entities",
						"recognition",
						"general"
					],
					"query": [
						{
							"key": "stringIndexType",
							"value": "TextElement_v8",
							"description": "(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. ",
							"disabled": true
						},
						{
							"key": "model-version",
							"value": "",
							"description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.",
							"disabled": true
						},
						{
							"key": "showStats",
							"value": "",
							"description": "(Optional) if set to true, response will contain request and document level statistics.",
							"disabled": true
						},
						{
							"key": "loggingOptOut",
							"value": "",
							"description": "(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions.",
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "Sentiment",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					},
					{
						"key": "Ocp-Apim-Subscription-Key",
						"value": "{{api_key}}",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\r\n\t\"documents\": [\r\n\t\t{\r\n\t\t\t\"id\": \"1\",\r\n\t\t\t\"language\": \"en\",\r\n\t\t\t\"text\": \"Terrible atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful.\"\r\n\t\t}\r\n\t]\r\n}"
				},
				"url": {
					"raw": "https://westeurope.api.cognitive.microsoft.com/text/analytics/v3.1/sentiment",
					"protocol": "https",
					"host": [
						"westeurope",
						"api",
						"cognitive",
						"microsoft",
						"com"
					],
					"path": [
						"text",
						"analytics",
						"v3.1",
						"sentiment"
					],
					"query": [
						{
							"key": "stringIndexType",
							"value": "TextElement_v8",
							"description": "(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0.",
							"disabled": true
						},
						{
							"key": "model-version",
							"value": "",
							"description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.",
							"disabled": true
						},
						{
							"key": "showStats",
							"value": "",
							"description": "(Optional) if set to true, response will contain request and document level statistics.",
							"disabled": true
						},
						{
							"key": "loggingOptOut",
							"value": "",
							"description": "(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions.",
							"disabled": true
						},
						{
							"key": "opinionMining",
							"value": "",
							"description": "(Optional) if set to true, response will contain not only sentiment prediction but also opinion mining (aspect-based sentiment analysis) results.",
							"disabled": true
						}
					]
				}
			},
			"response": []
		}
	]
}