{"_id":"55c1f5fca131980d005be95b","project":"55a7aee84a33f92b00b7a150","version":{"_id":"55a7aee84a33f92b00b7a153","__v":6,"project":"55a7aee84a33f92b00b7a150","createdAt":"2015-07-16T13:17:28.411Z","releaseDate":"2015-07-16T13:17:28.411Z","categories":["55a7aee94a33f92b00b7a154","55a7fefa3efe0c2f0074cbdf","55a8fb10c8bd450d000dd130","55a936b1cf45e1390093f362","55abddeaa36ccd0d00fdebe1","5624db675a86b423009462e1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"user":"55a7c77b4a33f92b00b7a1a9","__v":7,"editedParams":true,"editedParams2":true,"parentDoc":null,"category":{"_id":"55a7aee94a33f92b00b7a154","__v":21,"project":"55a7aee84a33f92b00b7a150","version":"55a7aee84a33f92b00b7a153","pages":["55a7aee94a33f92b00b7a156","55a7ea403efe0c2f0074cb75","55a80eb23ec2ec0d00bd66ea","55a811fc6e61e619004f703e","55a8c513cf45e1390093f18c","55a8d9fa27a17d210052516d","55a8f048cf45e1390093f248","55aba4ba63a6b60d006616e1","55abab0a0685ce0d0049fb8d","55abb04da36ccd0d00fdebc1","55abc1cc63a6b60d006616f4","55abcdbd63a6b60d006616fa","55abd36763a6b60d00661700","55abd50ea36ccd0d00fdebdb","55abd8c3a36ccd0d00fdebdf","55abd9cc0685ce0d0049fbb5","55abdb6b63a6b60d00661706","55abdc9b0685ce0d0049fbb8","55c1f5fca131980d005be95b","55fac407bc972f0d0005f644","569f68e766a5640d00efa52d"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-16T13:17:29.102Z","from_sync":false,"order":2,"slug":"endpoints","title":"Endpoints"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-05T11:39:40.017Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl https://api.aylien.com/api/v1/combined \\\n   -H \"X-AYLIEN-TextAPI-Application-Key: [[app:key]]\" \\\n   -H \"X-AYLIEN-TextAPI-Application-ID: [[app:id]]\" \\\n   --data-urlencode \"url=http://www.bbc.com/news/technology-33764155\" \\\n   --data-urlencode \"endpoint=entities\" \\\n   --data-urlencode \"endpoint=concepts\" \\\n   --data-urlencode \"endpoint=classify\"","language":"curl","name":""},{"code":"textapi.combined({\n  \"url\": \"http://www.bbc.com/news/technology-33764155\",\n  \"endpoint\": [\"entities\", \"concepts\", \"classify\"]\n}, function(err, result) {\n  if (err === null) {\n    result.results.forEach(function(r) {\n      console.log(r.endpoint + ':');\n      console.log(r.result);\n    });\n  } else {\n    console.log(err)\n  }\n});","language":"javascript"},{"code":"combined = c.Combined({\n  'url': \"http://www.bbc.com/news/technology-33764155\",\n  'endpoint': [\"entities\", \"concepts\", \"classify\"]\n})\n\nfor result in combined[\"results\"]:\n  print(result[\"endpoint\"])\n  print(result[\"result\"])","language":"python"},{"code":"<?php\n$combined = $textapi->Combined(array(\n  'url' => 'http://www.bbc.com/news/technology-33764155',\n  'endpoint' => array(\"entities\", \"concepts\", \"classify\")\n));\nforeach($combined->results as $result) {\n  echo $result->endpoint,\"\\n\";\n  var_dump($result->result);\n}\n?>","language":"php"},{"code":"CombinedParams.Builder builder = CombinedParams.newBuilder();\nString[] endpoints = {\"entities\", \"concepts\", \"classify\"};\nURL url = new URL(\"http://www.bbc.com/news/technology-33764155\");\nbuilder.setUrl(url);\nbuilder.setEndpoints(endpoints);\nCombined combined = client.combined(builder.build());\nfor (Entity entity: combined.getEntities().getEntities()) {\n  System.out.println(entity.getType() + \": \");\n  for (String sf: entity.getSurfaceForms()) {\n    System.out.println(\"\\\"\" + sf + \"\\\" \");\n  }\n}\nfor (Category category: combined.getClassifications().getCategories()) {\n  System.out.println(category);\n}","language":"java"},{"code":"url = \"http://www.bbc.com/news/technology-33764155\"\nendpoints = [\"entities\", \"concepts\", \"classify\"]\n\ncombined = client.combined(url: url, endpoint: endpoints)\n\ncombined[:results].each do |result|\n  puts result[:endpoint]\n  puts result[:result]\nend","language":"ruby"},{"code":"endpoints := []string{\"entities\", \"concepts\", \"classify\"}\ncombinedParams := &textapi.CombinedParams{\n  URL: \"http://www.bbc.com/news/technology-33764155\",\n  Endpoints: endpoints,\n}\nresult, err := client.Combined(combinedParams)\nif err != nil {\n  panic(err)\n}\nfmt.Printf(\"%v\\n\", result.Entities)\nfmt.Printf(\"%v\\n\", result.Concepts)\nfmt.Printf(\"%v\\n\", result.Classifications)","language":"go"},{"language":"csharp","code":"var endpoints = new string[] { \"entities\", \"concepts\", \"classify\" };\nvar url = \"http://www.bbc.com/news/technology-33764155\";\n\nvar combined = client.Combined(url: url, endpoints: endpoints);\n\nConsole.WriteLine(string.Join(\", \", combined.Entities.EntitiesMember.Keyword));\n\nforeach (var item in combined.Results)\n{\n  Console.WriteLine(item.Endpoint);\n}"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"results\":[\n    {\n      \"endpoint\":\"entities\",\n      \"result\":{\n        \"entities\":{\n          \"keyword\":[\n            \"internet servers\",\n            \"flaw in the internet\",\n            \"internet users\",\n            \"server software\",\n            \"exploits of the flaw\",\n            \"internet\",\n            \"System (DNS) software\",\n            \"servers\",\n            \"flaw\",\n            \"expert\",\n            \"vulnerability\",\n            \"systems\",\n            \"software\",\n            \"exploits\",\n            \"users\",\n            \"websites\",\n            \"addresses\",\n            \"offline\",\n            \"URLs\",\n            \"services\"\n          ],\n          \"organization\":[\n            \"DNS\",\n            \"BBC\"\n          ],\n          \"person\":[\n            \"Daniel Cid\",\n            \"Brian Honan\"\n          ]\n        },\n        \"language\":\"en\"\n      }\n    },\n    {\n      \"endpoint\":\"concepts\",\n      \"result\":{\n        \"concepts\":{\n          \"http://dbpedia.org/resource/Apache_HTTP_Server\":{\n            \"support\":503,\n            \"surfaceForms\":[\n              {\n                \"offset\":1314,\n                \"score\":1.0,\n                \"string\":\"Apache\"\n              }\n            ],\n            \"types\":[\n              \"http://dbpedia.org/ontology/Software\"\n            ]\n          },\n          \"http://dbpedia.org/resource/BBC_News\":{\n            \"support\":2062,\n            \"surfaceForms\":[\n              {\n                \"offset\":1161,\n                \"score\":0.8707235306716345,\n                \"string\":\"BBC\"\n              }\n            ],\n            \"types\":[\n              \"http://dbpedia.org/ontology/Company\"\n            ]\n          },\n          \"http://dbpedia.org/resource/Denial-of-service_attack\":{\n            \"support\":620,\n            \"surfaceForms\":[\n              {\n                \"offset\":317,\n                \"score\":1.0,\n                \"string\":\"denial-of-service attacks\"\n              }\n            ],\n            \"types\":[\n              \"\"\n            ]\n          },\n          \"http://dbpedia.org/resource/Domain_Name_System\":{\n            \"support\":1437,\n            \"surfaceForms\":[\n              {\n                \"offset\":495,\n                \"score\":1.0,\n                \"string\":\"Domain Name System\"\n              },\n              {\n                \"offset\":515,\n                \"score\":0.9999999999599822,\n                \"string\":\"DNS\"\n              }\n            ],\n            \"types\":[\n              \"\"\n            ]\n          },\n          \"http://dbpedia.org/resource/Internet_Systems_Consortium\":{\n            \"support\":45,\n            \"surfaceForms\":[\n              {\n                \"offset\":818,\n                \"score\":1.0,\n                \"string\":\"Internet Systems Consortium\"\n              }\n            ],\n            \"types\":[\n              \"http://dbpedia.org/ontology/Non-ProfitOrganisation\"\n            ]\n          },\n          \"http://dbpedia.org/resource/OpenSSL\":{\n            \"support\":247,\n            \"surfaceForms\":[\n              {\n                \"offset\":1322,\n                \"score\":1.0,\n                \"string\":\"OpenSSL\"\n              }\n            ],\n            \"types\":[\n              \"http://dbpedia.org/ontology/Software\"\n            ]\n          }\n        },\n        \"language\":\"en\"\n      }\n    },\n    {\n      \"endpoint\":\"classify\",\n      \"result\":{\n        \"categories\":[\n          {\n            \"code\":\"04003005\",\n            \"confidence\":1.0,\n            \"label\":\"computing and information technology - software\"\n          }\n        ],\n        \"language\":\"en\"\n      }\n    }\n  ],\n  \"text\":\"Hackers target internet address bug to disrupt sites\\nHackers are exploiting a serious flaw in the internet's architecture, according to a security firm.\\n\\nThe bug targets systems which convert URLs into IP addresses.\\n\\nExploiting it could threaten the smooth running of internet services as it allows hackers to launch denial-of-service attacks on websites, potentially forcing them offline.\\n\\nRegular internet users are unlikely to be severely affected, however.\\n\\nBind is the name of a variety of Domain Name System (DNS) software used on the majority of internet servers.\\n\\nThe recently identified bug allows attackers to crash the software, therefore taking the DNS service offline and preventing URLs, for example, from working.\\n\\nA patch for the flaw is already available, but many systems are yet to be updated.\\n\\nThe Internet Systems Consortium (ISC), which develops Bind, said in a tweet that the vulnerability was \\\"particularly critical\\\" and \\\"easily exploited\\\".\\n\\nDaniel Cid, a networking expert at Sucuri has published a blog post on the vulnerability in which he explained that real exploits taking advantage of the flaw have already happened.\\n\\nHe told the BBC: \\\"A few of our clients, in different industries, had their DNS servers crashed because of it.\\n\\n\\\"Based on our experience, server software, like Bind, Apache, OpenSSL and others, do not get patched as often as they should.\\\"\\n\\nCybersecurity expert Brian Honan commented that a spike in exploits of the flaw was expected over the next few days.\\n\\nHowever, he added that websites would often still be accessible via other routes and cached addresses on DNS servers around the world, even when certain key DNS servers have been made to crash.\\n\\n\\\"It's not a doomsday scenario, it's a question of making sure the DNS structure can continue to work while patches are rolled out,\\\" he said.\\n\\nThe impact on general internet users is likely to be minimal, according to Mr Cid.\\n\\n\\\"Average internet users won't feel much pain, besides a few sites and email servers down,\\\" he said.\"\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55c1f77116607635007dcdf4","ref":"","in":"query","required":false,"desc":"Text to analyze","default":"","type":"string","name":"url"},{"_id":"55c1f77116607635007dcdf3","ref":"","in":"query","required":false,"desc":"Article or webpage to analyze","default":"","type":"string","name":"text"},{"_id":"55c1f77116607635007dcdf2","ref":"","in":"query","required":false,"desc":"Analysis to perform","default":"","type":"array_string","name":"endpoint"},{"_id":"55c1f77116607635007dcdf1","ref":"","in":"query","required":false,"desc":"Language (refer to [Language Support](/docs/language-support))","default":"en","type":"string","name":"language"}],"url":"/combined"},"isReference":false,"order":14,"body":"The Combined Calls endpoint allows you to perform multiple analysis operations on the same input (text or URL) with a single API call. This is a helper method with the benefit of saving your application from having to make multiple API calls, and can reduce the number of network round trips between your application and our servers, resulting in a lower overall analysis time.\n\nTo use the Combined Calls endpoint you must supply the list of endpoints that you wish to be applied to your input. Currently the following endpoints are available:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Endpoint name\",\n    \"h-1\": \"Combined Call name\",\n    \"0-0\": \"Aspect-Based Sentiment Analysis\",\n    \"0-1\": \"`absa/DOMAIN_NAME` e.g. \\\"absa/hotels\\\"\",\n    \"1-0\": \"Sentiment Analysis\",\n    \"1-1\": \"`sentiment`\",\n    \"2-0\": \"Classification by Taxonomy\",\n    \"2-1\": \"`classify/TAXONOMY_NAME` e.g. \\\"classify/iptc-subjectcode\\\"\",\n    \"3-0\": \"Article Extraction\",\n    \"3-1\": \"`extract`\",\n    \"4-0\": \"Summarization\",\n    \"4-1\": \"`summarize`\",\n    \"5-0\": \"Concept Extraction\",\n    \"5-1\": \"`concepts`\",\n    \"6-0\": \"Entity Extraction\",\n    \"6-1\": \"`entities`\",\n    \"7-0\": \"Language Detection\",\n    \"7-1\": \"`language`\",\n    \"8-0\": \"Hashtag Suggestion\",\n    \"8-1\": \"`hashtags`\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"API calls count\",\n  \"body\": \"Please note that while Combined Calls endpoint provides convenience and reduces the analysis time, it doesn't impact the total number of API calls compared to calling each endpoint individually.\"\n}\n[/block]","excerpt":"/combined","slug":"combined","type":"endpoint","title":"Combined Calls"}

getCombined Calls

/combined

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

url:
string
Text to analyze
text:
string
Article or webpage to analyze
endpoint:
array of strings
Analysis to perform
language:
stringen
Language (refer to [Language Support](/docs/language-support))

Examples


Result Format


Documentation

The Combined Calls endpoint allows you to perform multiple analysis operations on the same input (text or URL) with a single API call. This is a helper method with the benefit of saving your application from having to make multiple API calls, and can reduce the number of network round trips between your application and our servers, resulting in a lower overall analysis time. To use the Combined Calls endpoint you must supply the list of endpoints that you wish to be applied to your input. Currently the following endpoints are available: [block:parameters] { "data": { "h-0": "Endpoint name", "h-1": "Combined Call name", "0-0": "Aspect-Based Sentiment Analysis", "0-1": "`absa/DOMAIN_NAME` e.g. \"absa/hotels\"", "1-0": "Sentiment Analysis", "1-1": "`sentiment`", "2-0": "Classification by Taxonomy", "2-1": "`classify/TAXONOMY_NAME` e.g. \"classify/iptc-subjectcode\"", "3-0": "Article Extraction", "3-1": "`extract`", "4-0": "Summarization", "4-1": "`summarize`", "5-0": "Concept Extraction", "5-1": "`concepts`", "6-0": "Entity Extraction", "6-1": "`entities`", "7-0": "Language Detection", "7-1": "`language`", "8-0": "Hashtag Suggestion", "8-1": "`hashtags`" }, "cols": 2, "rows": 9 } [/block] [block:callout] { "type": "info", "title": "API calls count", "body": "Please note that while Combined Calls endpoint provides convenience and reduces the analysis time, it doesn't impact the total number of API calls compared to calling each endpoint individually." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}