{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:azure-cognitiveservices-text-analytics/analyze":{"post":{"operationId":"cloud_azure_cognitiveservices_text_analytics_analyze","summary":"Submit analysis job","description":"POST /analyze","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","ApiVersion"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"ApiVersion":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-text-analytics/analyze-status":{"get":{"operationId":"cloud_azure_cognitiveservices_text_analytics_analyze_status","summary":"Get analysis status and results","description":"GET /analyze/jobs/{jobId}","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"ApiVersion","in":"query","required":true,"description":"Text Analytics API version (for example, v3.0).","schema":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."}},{"name":"jobId","in":"query","required":true,"description":"Job ID for Analyze","schema":{"type":"string","description":"Job ID for Analyze"}},{"name":"showStats","in":"query","required":false,"description":"(Optional) if set to true, response will contain request and document level statistics.","schema":{"type":"boolean","description":"(Optional) if set to true, response will contain request and document level statistics."}},{"name":"$top","in":"query","required":false,"description":"(Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first.","schema":{"type":"integer","default":20,"description":"(Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first."}},{"name":"$skip","in":"query","required":false,"description":"(Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first.","schema":{"type":"integer","default":0,"description":"(Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-text-analytics/health-status":{"get":{"operationId":"cloud_azure_cognitiveservices_text_analytics_health_status","summary":"Get healthcare analysis job status and results","description":"GET /entities/health/jobs/{jobId}","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"ApiVersion","in":"query","required":true,"description":"Text Analytics API version (for example, v3.0).","schema":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."}},{"name":"jobId","in":"query","required":true,"description":"Job ID","schema":{"type":"string","description":"Job ID"}},{"name":"$top","in":"query","required":false,"description":"(Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first.","schema":{"type":"integer","default":20,"description":"(Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first."}},{"name":"$skip","in":"query","required":false,"description":"(Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first.","schema":{"type":"integer","default":0,"description":"(Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first."}},{"name":"showStats","in":"query","required":false,"description":"(Optional) if set to true, response will contain request and document level statistics.","schema":{"type":"boolean","description":"(Optional) if set to true, response will contain request and document level statistics."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-text-analytics/cancel-health-job":{"post":{"operationId":"cloud_azure_cognitiveservices_text_analytics_cancel_health_job","summary":"Cancel healthcare prediction job","description":"DELETE /entities/health/jobs/{jobId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","ApiVersion","jobId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"ApiVersion":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."},"jobId":{"type":"string","description":"Job ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-text-analytics/health":{"post":{"operationId":"cloud_azure_cognitiveservices_text_analytics_health","summary":"Submit healthcare analysis job","description":"POST /entities/health/jobs","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","ApiVersion","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"ApiVersion":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."},"model-version":{"type":"string","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…"},"stringIndexType":{"type":"string","enum":["TextElement_v8","UnicodeCodePoint","Utf16CodeUnit"],"default":"TextElement_v8","description":"(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For…"},"loggingOptOut":{"type":"boolean","description":"(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-text-analytics/entities-recognition-general":{"post":{"operationId":"cloud_azure_cognitiveservices_text_analytics_entities_recognition_general","summary":"Named Entity Recognition","description":"POST /entities/recognition/general","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","ApiVersion","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"ApiVersion":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."},"model-version":{"type":"string","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…"},"showStats":{"type":"boolean","description":"(Optional) if set to true, response will contain request and document level statistics."},"loggingOptOut":{"type":"boolean","description":"(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input…"},"stringIndexType":{"type":"string","enum":["TextElement_v8","UnicodeCodePoint","Utf16CodeUnit"],"default":"TextElement_v8","description":"(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-text-analytics/entities-recognition-pii":{"post":{"operationId":"cloud_azure_cognitiveservices_text_analytics_entities_recognition_pii","summary":"Entities containing personal information","description":"POST /entities/recognition/pii","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","ApiVersion","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"ApiVersion":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."},"model-version":{"type":"string","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…"},"showStats":{"type":"boolean","description":"(Optional) if set to true, response will contain request and document level statistics."},"loggingOptOut":{"type":"boolean","description":"(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input…"},"domain":{"type":"string","description":"(Optional) if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'."},"stringIndexType":{"type":"string","enum":["TextElement_v8","UnicodeCodePoint","Utf16CodeUnit"],"default":"TextElement_v8","description":"(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For…"},"piiCategories":{"type":"array","description":"(Optional) describes the PII categories to return"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-text-analytics/entities-linking":{"post":{"operationId":"cloud_azure_cognitiveservices_text_analytics_entities_linking","summary":"Linked entities from a well known knowledge base","description":"POST /entities/linking","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","ApiVersion","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"ApiVersion":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."},"model-version":{"type":"string","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…"},"showStats":{"type":"boolean","description":"(Optional) if set to true, response will contain request and document level statistics."},"loggingOptOut":{"type":"boolean","description":"(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input…"},"stringIndexType":{"type":"string","enum":["TextElement_v8","UnicodeCodePoint","Utf16CodeUnit"],"default":"TextElement_v8","description":"(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-text-analytics/key-phrases":{"post":{"operationId":"cloud_azure_cognitiveservices_text_analytics_key_phrases","summary":"Key Phrases","description":"POST /keyPhrases","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","ApiVersion","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"ApiVersion":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."},"model-version":{"type":"string","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…"},"showStats":{"type":"boolean","description":"(Optional) if set to true, response will contain request and document level statistics."},"loggingOptOut":{"type":"boolean","description":"(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-text-analytics/languages":{"post":{"operationId":"cloud_azure_cognitiveservices_text_analytics_languages","summary":"Detect Language","description":"POST /languages","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","ApiVersion","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"ApiVersion":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."},"model-version":{"type":"string","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…"},"showStats":{"type":"boolean","description":"(Optional) if set to true, response will contain request and document level statistics."},"loggingOptOut":{"type":"boolean","description":"(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-cognitiveservices-text-analytics/sentiment":{"post":{"operationId":"cloud_azure_cognitiveservices_text_analytics_sentiment","summary":"Sentiment","description":"POST /sentiment","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","ApiVersion","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"ApiVersion":{"type":"string","enum":["v3.1"],"description":"Text Analytics API version (for example, v3.0)."},"model-version":{"type":"string","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…"},"showStats":{"type":"boolean","description":"(Optional) if set to true, response will contain request and document level statistics."},"loggingOptOut":{"type":"boolean","description":"(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input…"},"opinionMining":{"type":"boolean","description":"(Optional) if set to true, response will contain not only sentiment prediction but also opinion mining (aspect-based sentiment analysis)…"},"stringIndexType":{"type":"string","enum":["TextElement_v8","UnicodeCodePoint","Utf16CodeUnit"],"default":"TextElement_v8","description":"(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}