{"__v":0,"_id":"55abd36763a6b60d00661700","category":{"__v":21,"_id":"55a7aee94a33f92b00b7a154","pages":["55a7aee94a33f92b00b7a156","55a7ea403efe0c2f0074cb75","55a80eb23ec2ec0d00bd66ea","55a811fc6e61e619004f703e","55a8c513cf45e1390093f18c","55a8d9fa27a17d210052516d","55a8f048cf45e1390093f248","55aba4ba63a6b60d006616e1","55abab0a0685ce0d0049fb8d","55abb04da36ccd0d00fdebc1","55abc1cc63a6b60d006616f4","55abcdbd63a6b60d006616fa","55abd36763a6b60d00661700","55abd50ea36ccd0d00fdebdb","55abd8c3a36ccd0d00fdebdf","55abd9cc0685ce0d0049fbb5","55abdb6b63a6b60d00661706","55abdc9b0685ce0d0049fbb8","55c1f5fca131980d005be95b","55fac407bc972f0d0005f644","569f68e766a5640d00efa52d"],"project":"55a7aee84a33f92b00b7a150","version":"55a7aee84a33f92b00b7a153","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-16T13:17:29.102Z","from_sync":false,"order":2,"slug":"endpoints","title":"Endpoints"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"55a7aee84a33f92b00b7a150","user":"55a7ae50bf1be93100d89df1","version":{"__v":6,"_id":"55a7aee84a33f92b00b7a153","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-19T16:42:15.361Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl https://api.aylien.com/api/v1/entities \\\n   -H \"X-AYLIEN-TextAPI-Application-Key: [[app:key]]\" \\\n   -H \"X-AYLIEN-TextAPI-Application-ID: [[app:id]]\" \\\n   -d text=\"ACME+corp+was+founded+by+John+Smith+in+Chicago.\" "},{"code":"textapi.entities({\n  text: 'ACME corp was founded by John Smith in Chicago.'\n}, function(error, response) {\n  if (error === null) {\n    Object.keys(response.entities).forEach(function(e) {\n      console.log(e + \": \" + response.entities[e].join(\",\"));\n    });\n  }\n});","language":"javascript"},{"code":"text = \"ACME corp was founded by John Smith in Chicago.\"\nentities = client.Entities({\"text\": text})\nfor type, values in entities['entities'].iteritems():\n  print type,', '.join(values)","language":"python"},{"code":"<?php\n$text = 'ACME corp was founded by John Smith in Chicago.';\n$entities = $textapi->Entities(array('text' => $text));\nforeach ($entities->entities as $type => $values) {\n  printf($type . \": \" . implode(', ', $values) . \"\\n\");\n}\n?>","language":"php"},{"code":"EntitiesParams.Builder builder = EntitiesParams.newBuilder();\nString text = \"ACME corp was founded by John Smith in Chicago.\";\nbuilder.setText(text);\nEntities entities = client.entities(builder.build());\nfor (Entity entity: entities.getEntities()) {\n\t\tSystem.out.print(entity.getType() + \": \");\n\t\tfor (String sf: entity.getSurfaceForms()) {\n\t\t\t\tSystem.out.print(\"\\\"\" + sf + \"\\\" \");\n\t\t}\n\t\tSystem.out.println();\n}","language":"java"},{"code":"text = \"ACME corp was founded by John Smith in Chicago.\"\n\nresponse = client.entities(text: text)\n\nresponse[:entities].each do |type, values|\n  puts \"#{type}, #{values}\"\nend","language":"ruby"},{"code":"text := \"ACME corp was founded by John Smith in Chicago.\"\nentitiesParams := &textapi.EntitiesParams{Text: text}\nentities, err := client.Entities(entitiesParams)\nif err != nil {\n\t\tpanic(err)\n}\nfor k, v := range entities.Entities {\n\t\tfmt.Printf(\"%s\\t%v\\n\", k, v)\n}","language":"go"},{"code":"string text = \"ACME corp was founded by John Smith in Chicago.\";\n\nvar entities = client.Entities(text: text).EntitiesMember;\n\nConsole.WriteLine(string.Join(\", \", entities.Location));\nConsole.WriteLine(string.Join(\", \", entities.Keyword));\nConsole.WriteLine(string.Join(\", \", entities.Organization));\nConsole.WriteLine(string.Join(\", \", entities.Person));","language":"csharp"}]},"results":{"codes":[{"name":"","code":"{\n  \"text\":\"ACME corp was founded by John Smith in Chicago.\",\n  \"language\":\"en\",\n  \"entities\":{\n    \"location\":[\n      \"Chicago\"\n    ],\n    \"keyword\":[\n      \"John\",\n      \"corp\",\n      \"Smith\",\n      \"Chicago\",\n      \"ACME\"\n    ],\n    \"organization\":[\n      \"ACME\"\n    ],\n    \"person\":[\n      \"John Smith\"\n    ]\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55aba608a36ccd0d00fdebbb","ref":"","in":"query","required":false,"desc":"Text to analyze","default":"","type":"string","name":"text"},{"_id":"55a8f048cf45e1390093f249","ref":"","in":"query","required":false,"desc":"Article or webpage to analyze","default":"","type":"string","name":"url"},{"_id":"55a8f18bc8bd450d000dd113","ref":"","in":"query","required":false,"desc":"Language (refer to [Language Support](/docs/language-support))","default":"auto","type":"string","name":"language"}],"url":"/entities"},"isReference":false,"order":4,"body":"Documents often contain mentions of entities such as **people**, **places**, **products** and **organizations**, which we collectively call Named Entities. Additionally they may also contain specific values or items such as **links**, **telephone numbers**, **email addresses**, **currency amounts** and **percentages**. To extract these entities and values from a piece of text, as well as the **keywords**, you can use the **Entity Extraction** endpoint.\n\nEntity Extraction looks at the structural patterns in a document to find and extract entities, and therefore can be error-prone. \n\n**N.B.** We recommend using both Concept and Entity Extraction together if you're looking to extract well-known entities with higher precision. See [Concept Extraction](doc:concepts).","excerpt":"/entities","slug":"entities","type":"get","title":"Entity Extraction"}

getEntity Extraction

/entities

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

text:
string
Text to analyze
url:
string
Article or webpage to analyze
language:
stringauto
Language (refer to [Language Support](/docs/language-support))

Examples


Result Format


Documentation

Documents often contain mentions of entities such as **people**, **places**, **products** and **organizations**, which we collectively call Named Entities. Additionally they may also contain specific values or items such as **links**, **telephone numbers**, **email addresses**, **currency amounts** and **percentages**. To extract these entities and values from a piece of text, as well as the **keywords**, you can use the **Entity Extraction** endpoint. Entity Extraction looks at the structural patterns in a document to find and extract entities, and therefore can be error-prone. **N.B.** We recommend using both Concept and Entity Extraction together if you're looking to extract well-known entities with higher precision. See [Concept Extraction](doc:concepts).

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 }}