openapi-snippet
Version:
Generates code snippets from Open API (previously Swagger) documents.
1,655 lines • 281 kB
JSON
{
"$loki": 492,
"basePath": "/calls",
"consumes": ["application/x-www-form-urlencoded", "application/json"],
"definitions": {
"Authors Response": {
"properties": {
"authors": {
"items": {
"description": "author name",
"type": "string"
},
"type": "array"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"url": {
"description": "http url information was requested for",
"type": "string"
}
}
},
"Combined Call Response": {
"properties": {
"author": {
"description": "author name",
"type": "string"
},
"concepts": {
"items": {
"$ref": "#/definitions/concept"
},
"type": "array"
},
"dates": {
"items": {
"$ref": "#/definitions/extracted_date"
},
"type": "array"
},
"docEmotions": {
"$ref": "#/definitions/docEmotions"
},
"docSentiment": {
"$ref": "#/definitions/docSentiment"
},
"entities": {
"items": {
"$ref": "#/definitions/entity"
},
"type": "array"
},
"feeds": {
"items": {
"$ref": "#/definitions/feed"
},
"type": "array"
},
"keywords": {
"items": {
"$ref": "#/definitions/keyword"
},
"type": "array"
},
"language": {
"description": "the detected language of the processed text",
"type": "string"
},
"publicationDate": {
"$ref": "#/definitions/publicationDate"
},
"relations": {
"items": {
"$ref": "#/definitions/relation"
},
"type": "array"
},
"status": {
"description": "success / failure status indicating whether the request was processed",
"type": "string"
},
"taxonomy": {
"items": {
"$ref": "#/definitions/category"
},
"type": "array"
},
"text": {
"description": "document text, returned if showSourceText is set to 1",
"type": "string"
},
"title": {
"description": "document title",
"type": "string"
},
"totalTransactions": {
"description": "number of API transactions used in the combined call",
"type": "string"
},
"typedRelations": {
"items": {
"$ref": "#/definitions/typedRelation"
},
"type": "array"
},
"url": {
"description": "the URL passed in the 'url' input parameter",
"type": "string"
}
}
},
"Concepts Response": {
"properties": {
"concepts": {
"items": {
"$ref": "#/definitions/concept"
},
"type": "array"
},
"language": {
"description": "detected language of the source text",
"type": "string"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"text": {
"description": "document text",
"type": "string"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"Date Extraction Response": {
"properties": {
"dates": {
"items": {
"$ref": "#/definitions/extracted_date"
},
"type": "array"
},
"language": {
"description": "the detected language of the source text",
"type": "string"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"text": {
"description": "Source text of the document. Appears if showSourceText=1",
"type": "string"
},
"url": {
"description": "http url information was requested for",
"type": "string"
}
}
},
"Document Sentiment Response": {
"properties": {
"docSentiment": {
"$ref": "#/definitions/docSentiment"
},
"language": {
"description": "detected language of the source text",
"type": "string"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"text": {
"description": "document text",
"type": "string"
},
"url": {
"description": "http url information was requested for",
"type": "string"
}
}
},
"Emotion Analysis Response": {
"properties": {
"docEmotions": {
"$ref": "#/definitions/docEmotions"
},
"language": {
"description": "detected language of the source text",
"type": "string"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"Entities Response": {
"properties": {
"entities": {
"items": {
"$ref": "#/definitions/entity"
},
"type": "array"
},
"language": {
"description": "detected language of the source text",
"type": "string"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"text": {
"description": "document text",
"type": "string"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"FaceTags": {
"properties": {
"imageFaces": {
"items": {
"properties": {
"age": {
"properties": {
"ageRange": {
"description": "approximate age range for a detected face",
"type": "string"
},
"score": {
"type": "number"
}
},
"type": "object"
},
"disambiguated": {
"$ref": "#/definitions/disambiguated"
},
"gender": {
"properties": {
"gender": {
"description": "gender for a detected face",
"type": "string"
},
"score": {
"type": "number"
}
},
"type": "object"
},
"height": {
"description": "height, in pixels, of a detected face",
"type": "number"
},
"identity": {
"properties": {
"knowledgeGraph": {
"$ref": "#/definitions/knowledgeGraph"
},
"name": {
"description": "if the detected face is identified as a known celebrity, this field will provide the person's name",
"type": "string"
},
"score": {
"type": "number"
}
},
"type": "object"
},
"positionX": {
"description": "coordinate of the left-most pixel for a detected face",
"type": "number"
},
"positionY": {
"description": "coordinate of the top-most pixel for a detected face",
"type": "number"
},
"width": {
"description": "width, in pixels, of a detected face",
"type": "number"
}
}
},
"type": "array"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"totalTransactions": {
"description": "number of transactions charged",
"type": "string"
},
"url": {
"description": "http url information was requested for",
"type": "string"
}
}
},
"Feed Detection Response": {
"properties": {
"feeds": {
"items": {
"$ref": "#/definitions/feed"
},
"type": "array"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"ImageKeywords": {
"properties": {
"imageKeywords": {
"items": {
"$ref": "#/definitions/imageKeyword"
},
"type": "array"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"totalTransactions": {
"description": "number of transactions charged",
"type": "string"
},
"url": {
"description": "http url information was requested for",
"type": "string"
}
}
},
"ImageLink": {
"properties": {
"image": {
"description": "URL of the detected image",
"type": "string"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"totalTransactions": {
"description": "transactions charged",
"type": "string"
},
"url": {
"description": "http url information was requested for",
"type": "string"
}
}
},
"Keywords Response": {
"properties": {
"keywords": {
"items": {
"$ref": "#/definitions/keyword"
},
"type": "array"
},
"language": {
"description": "detected language of the source text",
"type": "string"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"text": {
"description": "document text",
"type": "string"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"Language Response": {
"properties": {
"ethnologue": {
"description": "link to Ethnologue containing information on the detected language",
"type": "string"
},
"iso-639-1": {
"description": "ISO-639-1 code for the detected language",
"type": "string"
},
"iso-639-2": {
"description": "ISO-639-2 code for the detected language",
"type": "string"
},
"iso-639-3": {
"description": "ISO-639-3 code for the detected language",
"type": "string"
},
"language": {
"description": "detected language",
"type": "string"
},
"native-speakers": {
"description": "number of persons who natively speak the detected language",
"type": "string"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"url": {
"description": "http url information was requested for",
"type": "string"
},
"wikipedia": {
"description": "link to the Wikipedia page for the detected language",
"type": "string"
}
}
},
"Microformats Response": {
"properties": {
"microformats": {
"items": {
"$ref": "#/definitions/microformat"
},
"type": "array"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"url": {
"description": "http url information was requested for",
"type": "string"
}
}
},
"Publication Date Response": {
"properties": {
"publicationDate": {
"$ref": "#/definitions/publicationDate"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"url": {
"description": "http url information was requested for",
"type": "string"
}
}
},
"Relations Response": {
"properties": {
"language": {
"description": "detected language of the source text",
"type": "string"
},
"relations": {
"items": {
"$ref": "#/definitions/relation"
},
"type": "array"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"text": {
"description": "document text",
"type": "string"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"Targeted Emotion Response": {
"properties": {
"language": {
"description": "detected language of the source text",
"type": "string"
},
"results": {
"items": {
"$ref": "#/definitions/targetedEmotionResult"
},
"type": "array"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"text": {
"description": "document text",
"type": "string"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"Targeted Sentiment Response": {
"properties": {
"language": {
"description": "detected language of the source text",
"type": "string"
},
"results": {
"items": {
"$ref": "#/definitions/result"
},
"type": "array"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"text": {
"description": "document text",
"type": "string"
},
"url": {
"description": "http url information was requested for",
"type": "string"
}
}
},
"Taxonomy Results": {
"properties": {
"language": {
"description": "detected language of the source text",
"type": "string"
},
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"taxonomy": {
"items": {
"$ref": "#/definitions/category"
},
"type": "array"
},
"text": {
"description": "document text",
"type": "string"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"Text": {
"properties": {
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"text": {
"description": "document text",
"type": "string"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"Title": {
"properties": {
"status": {
"description": "success / failure status indicating whether the request was processed.",
"type": "string"
},
"title": {
"description": "document title",
"type": "string"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"Typed Relations Response": {
"properties": {
"language": {
"description": "Language of the source text",
"type": "string"
},
"model": {
"description": "ID of the model that was used to identify entities and relations",
"type": "string"
},
"status": {
"description": "success / failure status indicating whether the request was processed",
"type": "string"
},
"typedRelations": {
"items": {
"$ref": "#/definitions/typedRelation"
},
"type": "array"
},
"url": {
"description": "HTTP URL passed in the request",
"type": "string"
}
}
},
"action": {
"properties": {
"lemmatized": {
"description": "lemmatized text of the detected relation action",
"type": "string"
},
"text": {
"description": "the detected action text",
"type": "string"
},
"verb": {
"$ref": "#/definitions/verb"
}
}
},
"category": {
"properties": {
"confident": {
"description": "will return \"no\" if categorization doesn't meet confidence standards",
"type": "string"
},
"label": {
"description": "detected category",
"type": "string"
},
"score": {
"description": "confidence score for the detected category 0.0 .. 1.0 (higher is better)",
"type": "string"
}
}
},
"concept": {
"properties": {
"census": {
"description": "sameAs link to the US Census",
"type": "string"
},
"ciaFactbook": {
"description": "sameAs link to the CIA World Factbook",
"type": "string"
},
"crunchbase": {
"description": "sameAs link to CrunchBase",
"type": "string"
},
"dbpedia": {
"description": "sameAs link to DBpedia",
"type": "string"
},
"freebase": {
"description": "sameAs link to Freebase",
"type": "string"
},
"geo": {
"description": "latitude longitude - geographic coordinates associated with this result.",
"type": "string"
},
"geonames": {
"description": "sameAs link to Geonames",
"type": "string"
},
"knowledgeGraph": {
"$ref": "#/definitions/knowledgeGraph"
},
"musicBrainz": {
"description": "sameAs link to MusicBrainz",
"type": "string"
},
"opencyc": {
"description": "sameAs link to OpenCyc",
"type": "string"
},
"relevance": {
"description": "relevance score for a detected concept tag. 0.0 .. 1.0 (higher is better)",
"type": "string"
},
"text": {
"description": "the detected concept tag",
"type": "string"
},
"website": {
"description": "the website associated with the result",
"type": "string"
},
"yago": {
"description": "sameAs link to YAGO",
"type": "string"
}
}
},
"disambiguated": {
"properties": {
"census": {
"description": "sameAs link to the US Census",
"type": "string"
},
"ciaFactbook": {
"description": "sameAs link to the CIA World Factbook",
"type": "string"
},
"crunchbase": {
"description": "sameAs link to CrunchBase",
"type": "string"
},
"dbpedia": {
"description": "sameAs link to DBPedia",
"type": "string"
},
"freebase": {
"description": "sameAs link to Freebase",
"type": "string"
},
"geo": {
"description": "latitude longitude - geographic coordinates associated with this result",
"type": "string"
},
"geonames": {
"description": "sameAs link to Geonames",
"type": "string"
},
"musicBrainz": {
"description": "sameAs link to MusicBrainz",
"type": "string"
},
"name": {
"description": "name of the disambiguated entity",
"type": "string"
},
"opencyc": {
"description": "sameAs link to OpenCyc",
"type": "string"
},
"subType": {
"items": {
"description": "subType of the disambiguated entity",
"type": "string"
},
"type": "array"
},
"umbel": {
"description": "sameAs link to UMBEL",
"type": "string"
},
"website": {
"description": "the website associated with the result",
"type": "string"
},
"yago": {
"description": "sameAs link to YAGO",
"type": "string"
}
}
},
"docEmotions": {
"properties": {
"anger": {
"description": "probability that the text implies anger",
"type": "string"
},
"disgust": {
"description": "probability that the text implies disgust",
"type": "string"
},
"fear": {
"description": "probability that the text implies fear",
"type": "string"
},
"joy": {
"description": "probability that the text implies joy",
"type": "string"
},
"sadness": {
"description": "probability that the text implies sadness",
"type": "string"
}
}
},
"docSentiment": {
"properties": {
"mixed": {
"description": "whether sentiment is mixed (both positive and negative) (1 == mixed)",
"type": "string"
},
"score": {
"description": "sentiment strength (0.0 == neutral)",
"type": "string"
},
"type": {
"description": "sentiment polarity - \"positive\", \"negative\", or \"neutral\"",
"type": "string"
}
}
},
"entity": {
"properties": {
"count": {
"description": "number of times an entity was seen within the source text",
"type": "string"
},
"disambiguated": {
"$ref": "#/definitions/disambiguated"
},
"knowledgeGraph": {
"$ref": "#/definitions/knowledgeGraph"
},
"quotations": {
"$ref": "#/definitions/quotation"
},
"relevance": {
"description": "relevance score for a detected entity. 0.0 .. 1.0 (higher is better)",
"type": "string"
},
"sentiment": {
"$ref": "#/definitions/sentiment"
},
"text": {
"description": "the detected entity text",
"type": "string"
},
"type": {
"description": "the detected entity type",
"type": "string"
}
}
},
"extracted_date": {
"properties": {
"date": {
"description": "The extracted date in yyyymmddThhmmss format",
"type": "string"
},
"text": {
"description": "The text of the date as it appears in the source text",
"type": "string"
}
}
},
"feed": {
"properties": {
"feed": {
"description": "RSS/ATOM feed link",
"type": "string"
}
}
},
"imageKeyword": {
"properties": {
"knowledgeGraph": {
"$ref": "#/definitions/knowledgeGraph"
},
"score": {
"description": "confidence score for the detected image keyword 0.0 .. 1.0 (higher is better)",
"type": "string"
},
"text": {
"description": "detected keyword",
"type": "string"
}
}
},
"keyword": {
"properties": {
"knowledgeGraph": {
"$ref": "#/definitions/knowledgeGraph"
},
"relevance": {
"description": "relevance score for a detected keyword. 0.0 .. 1.0 (higher is better)",
"type": "string"
},
"sentiment": {
"$ref": "#/definitions/sentiment"
},
"text": {
"description": "the detected keyword text",
"type": "string"
}
}
},
"knowledgeGraph": {
"properties": {
"typeHierarchy": {
"description": "path through the knowledge graph to the appropriate keyword",
"type": "string"
}
}
},
"microformat": {
"properties": {
"fieldData": {
"description": "microformat field data",
"type": "string"
},
"fieldName": {
"description": "microformat field name",
"type": "string"
}
}
},
"object": {
"properties": {
"entity": {
"$ref": "#/definitions/entity"
},
"sentiment": {
"$ref": "#/definitions/sentiment"
},
"sentimentFromSubject": {
"$ref": "#/definitions/sentimentFromSubject"
},
"text": {
"description": "detected object text",
"type": "string"
}
}
},
"publicationDate": {
"properties": {
"confident": {
"description": "will return \"no\" if not confident",
"type": "string"
},
"date": {
"description": "will be in the form of YYYYMMDDTHHMMSS",
"type": "string"
}
}
},
"quotation": {
"properties": {
"quotation": {
"description": "quotation extracted for a particular named entity",
"type": "string"
}
}
},
"relation": {
"properties": {
"action": {
"$ref": "#/definitions/action"
},
"object": {
"$ref": "#/definitions/object"
},
"subject": {
"$ref": "#/definitions/subject"
}
}
},
"result": {
"properties": {
"sentiment": {
"$ref": "#/definitions/sentiment"
},
"text": {
"description": "Excerpt from the source text that corresponds with this result",
"type": "string"
}
}
},
"sentiment": {
"properties": {
"mixed": {
"description": "whether sentiment is mixed (both positive and negative) (1 == mixed)",
"type": "string"
},
"score": {
"description": "sentiment strength (0.0 == neutral)",
"type": "string"
},
"type": {
"description": "sentiment polarity - \"positive\", \"negative\", or \"neutral\"",
"type": "string"
}
}
},
"sentimentFromSubject": {
"properties": {
"mixed": {
"description": "whether sentiment is mixed (both positive and negative) (1 == mixed)",
"type": "string"
},
"score": {
"description": "the sentiment score (0.0 - 1.0) directed towards the object",
"type": "string"
},
"type": {
"description": "the sentiment polarity directed towards the object",
"type": "string"
}
}
},
"subject": {
"properties": {
"entity": {
"$ref": "#/definitions/entity"
},
"sentiment": {
"$ref": "#/definitions/sentiment"
},
"text": {
"description": "the detected subject text",
"type": "string"
}
}
},
"targetedEmotionResult": {
"properties": {
"emotions": {
"$ref": "#/definitions/targetedEmotions"
},
"text": {
"description": "Excerpt from the source text that corresponds with this result",
"type": "string"
}
}
},
"targetedEmotions": {
"properties": {
"anger": {
"description": "probability that the text implies anger towards the target",
"type": "string"
},
"disgust": {
"description": "probability that the text implies disgust towards the target",
"type": "string"
},
"fear": {
"description": "probability that the text implies fear towards the target",
"type": "string"
},
"joy": {
"description": "probability that the text implies joy towards the target",
"type": "string"
},
"sadness": {
"description": "probability that the text implies sadness towards the target",
"type": "string"
}
}
},
"typedRelation": {
"properties": {
"arguments": {
"items": {
"$ref": "#/definitions/typed_relations_argument"
},
"type": "array"
},
"score": {
"description": "Confidence score between 0 and 1. The higher the score, the greater the confidence",
"type": "string"
},
"sentence": {
"description": "Text from the document that contains the relation",
"type": "string"
},
"type": {
"description": "Type of the detected relation",
"type": "string"
}
}
},
"typed_relations_argument": {
"properties": {
"entities": {
"items": {
"$ref": "#/definitions/typed_relations_entity"
},
"type": "array"
},
"part": {
"description": "The argument's part in the relation. For example, an award might be the \"first\" part in an \"awardedTo\" relation",
"type": "string"
},
"text": {
"description": "Text from the input that describes the argument",
"type": "string"
}
}
},
"typed_relations_entity": {
"properties": {
"id": {
"description": "Unique identifier for the detected entity",
"type": "string"
},
"text": {
"description": "Text from the input that describes the entity",
"type": "string"
},
"type": {
"description": "Entity type",
"type": "string"
}
}
},
"verb": {
"properties": {
"negated": {
"description": "whether this action verb was negated in the detected relation - 1 = negated, 0 = not negated",
"type": "string"
},
"tense": {
"description": "tense of the detected action verb - past, present, future",
"type": "string"
},
"text": {
"description": "lemmatized base form of the detected action verb",
"type": "string"
}
}
}
},
"host": "gateway-a.watsonplatform.net",
"info": {
"description": "The AlchemyLanguage API uses natural language processing technology and machine learning algorithms to extract semantic meta-data from content, such as information on people, places, companies, topics, facts, relationships, authors, and languages.",
"title": "IBM Alchemy Language",
"version": "1.0.0",
"x-tags": ["machine learning"]
},
"meta": {
"created": 1486756139004,
"revision": 0,
"version": 0
},
"parameters": {
"anchorDate_formData": {
"description": "The date to use as \"today\" when interpreting phrases in the text like \"next tuesday.\" Format: `yyyy-mm-dd hh:mm:ss`",
"in": "formData",
"name": "anchorDate",
"required": false,
"type": "string"
},
"anchorDate_query": {
"description": "The date to use as \"today\" when interpreting phrases in the text like \"next tuesday.\" Format: `yyyy-mm-dd hh:mm:ss`",
"in": "query",
"name": "anchorDate",
"required": false,
"type": "string"
},
"apikey_formData": {
"description": "Your API key",
"in": "formData",
"name": "apikey",
"required": false,
"type": "string"
},
"apikey_query": {
"description": "Your API key",
"in": "query",
"name": "apikey",
"required": false,
"type": "string"
},
"content_type": {
"default": "application/x-www-form-urlencoded",
"description": "must be 'application/x-www-form-urlencoded'",
"in": "header",
"name": "Content-Type",
"required": true,
"type": "string"
},
"coreference_formData": {
"description": "Set this to 0 to ignore coreferences (he, she, it, etc) for entities",
"in": "formData",
"name": "coreference",
"required": false,
"type": "string"
},
"coreference_query": {
"description": "Set this to 0 to ignore coreferences (he, she, it, etc) for entities",
"in": "query",
"name": "coreference",
"required": false,
"type": "string"
},
"cquery_formData": {
"description": "<a href='http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/alchemylanguage/visual_constraints.shtml' target='_'>Visual constraints query</a> to use when <code>sourceText</code> is set to <code>cquery</code>",
"in": "formData",
"name": "cquery",
"required": false,
"type": "string"
},
"cquery_query": {
"description": "<a href='http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/alchemylanguage/visual_constraints.shtml' target='_blank'>Visual constraints query</a> to use when <code>sourceText</code> is set to <code>cquery</code>",
"in": "query",
"name": "cquery",
"required": false,
"type": "string"
},
"disambiguate_formData": {
"description": "Set this to 0 to hide entity disambiguation information in the response",
"enum": [0, 1],
"in": "formData",
"name": "disambiguate",
"required": false,
"type": "number"
},
"disambiguate_query": {
"description": "Set this to 0 to hide entity disambiguation information in the response",
"enum": [0, 1],
"in": "query",
"name": "disambiguate",
"required": false,
"type": "number"
},
"entities_formData": {
"description": "Set this to 1 to identify entities in detected relations<br><b>This incurs an additional API transaction</b>",
"enum": [0, 1],
"in": "formData",
"name": "entities",
"required": false,
"type": "number"
},
"entities_query": {
"description": "Set this to 1 to identify entities in detected relations<br><b>This incurs an additional API transaction</b>",
"enum": [0, 1],
"in": "query",
"name": "entities",
"required": false,
"type": "number"
},
"extractLinks_formData": {
"description": "Set this to 1 to include hyperlinks in the extracted web page text",
"enum": [0, 1],
"in": "formData",
"name": "extractLinks",
"required": false,
"type": "number"
},
"extractLinks_query": {
"description": "Set this to 1 to include hyperlinks in the extracted web page text",
"enum": [0, 1],
"in": "query",
"name": "extractLinks",
"required": false,
"type": "number"
},
"extract_formData": {
"default": "concepts,keywords,entities,taxonomy",
"description": "Comma separated list of analysis features: <ul><li>authors</li><li>concepts</li><li>dates</li><li>doc-emotion</li><li>entities</li><li>feeds</li><li>keywords</li><li>pub-date</li><li>relations</li><li>typed-rels</li><li>doc-sentiment</li><li>taxonomy</li><li>title</li></ul>",
"in": "formData",
"name": "extract",
"required": false,
"type": "string"
},
"extract_query": {
"default": "concepts,keywords,entities,taxonomy",
"description": "Comma separated list of analysis features: <ul><li>authors</li><li>concepts</li><li>dates</li><li>doc-emotion</li><li>entities</li><li>feeds</li><li>keywords</li><li>pub-date</li><li>relations</li><li>typed-rels</li><li>doc-sentiment</li><li>taxonomy</li><li>title</li></ul>",
"in": "query",
"name": "extract",
"required": false,
"type": "string"
},
"html_formData": {
"description": "HTML content (must be URL encoded)",
"in": "formData",
"name": "html",
"required": true,
"type": "string"
},
"html_query": {
"description": "HTML content (must be URL encoded)",
"in": "query",
"name": "html",
"required": true,
"type": "string"
},
"jsonp_formData": {
"description": "JSONP callback (requires 'outputMode' to be set to 'json')",
"in": "formData",
"name": "jsonp",
"required": false,
"type": "string"
},
"jsonp_query": {
"description": "JSONP callback (requires <code>outputMode</code> to be set to <code>json</code>)",
"in": "query",
"name": "jsonp",
"required": false,
"type": "string"
},
"keywordExtractMode_formData": {
"description": "keyword extraction mode",
"enum": ["normal", "strict"],
"in": "formData",
"name": "keywordExtractMode",
"required": false,
"type": "string"
},
"keywordExtractMode_query": {
"description": "keyword extraction mode",
"enum": ["normal", "strict"],
"in": "query",
"name": "keywordExtractMode",
"required": false,
"type": "string"
},
"keywords_formData": {
"description": "Set this to 1 to identify keywords in detected relations<br><b>This incurs an additional API transaction</b>",
"enum": [0, 1],
"in": "formData",
"name": "keywords",
"required": false,
"type": "number"
},
"keywords_query": {
"description": "Set this to 1 to identify keywords in detected relations<br><b>This incurs an additional API transaction</b>",
"enum": [0, 1],
"in": "query",
"name": "keywords",
"required": false,
"type": "number"
},
"knowledgeGraph_formData": {
"description": "Set to 1 to include knowledge graph information in the results <br><b>Incurs an additional API transaction</b>",
"enum": [0, 1],
"in": "formData",
"name": "knowledgeGraph",
"required": false,
"type": "number"
},
"knowledgeGraph_formData_combined": {
"description": "Include knowledge graph information in the results for each applicable function in the combined call. This incurs one additional transaction for each function involved.",
"enum": [0, 1],
"in": "formData",
"name": "knowledgeGraph",
"required": false,
"type": "integer"
},
"knowledgeGraph_query": {
"description": "Set to 1 to include knowledge graph information in the results <br><b>Incurs an additional API transaction</b>",
"enum": [0, 1],
"in": "query",
"name": "knowledgeGraph",
"required": false,
"type": "integer"
},
"knowledgeGraph_query_combined": {
"description": "Include knowledge graph information in the results for each applicable function in the combined call. This incurs one additional transaction for each function involved.",
"enum": [0, 1],
"in": "query",
"name": "knowledgeGraph",
"required": false,
"type": "integer"
},
"linkedData_formData": {
"description": "Set this to 0 to disable linkedData links in the response",
"enum": [0, 1],
"in": "formData",
"name": "linkedData",
"required": false,
"type": "integer"
},
"linkedData_query": {
"description": "Set this to 0 to disable linkedData links in the response",
"enum": [0, 1],
"in": "query",
"name": "linkedData",
"required": false,
"type": "integer"
},
"maxRetrieve_formData": {
"description": "maximum number of results to return for each extract function",
"in": "formData",
"name": "maxRetrieve",
"required": false,
"type": "integer"
},
"maxRetrieve_formData_concepts": {
"description": "maximum number of concepts to return (default 8)",
"in": "formData",
"name": "maxRetrieve",
"required": false,
"type": "integer"
},
"maxRetrieve_formData_entities": {
"description": "maximum number of entities to return (default 50)",
"in": "formData",
"name": "maxRetrieve",
"required": false,
"type": "integer"
},
"maxRetrieve_formData_keywords": {
"description": "maximum number of keywords to return (default 50)",
"in": "formData",
"name": "maxRetrieve",
"required": false,
"type": "integer"
},
"maxRetrieve_formData_relations": {
"description": "maximum number of relations to return (default 50, max 100)",
"in": "formData",
"name": "maxRetrieve",
"required": false,
"type": "integer"
},
"maxRetrieve_query": {
"description": "maximum number of results to return for each extract function",
"in": "query",
"name": "maxRetrieve",
"required": false,
"type": "integer"
},
"maxRetrieve_query_concepts": {
"description": "maximum number of concepts to return (default 8)",
"in": "query",
"name": "maxRetrieve",
"required": false,
"type": "integer"
},
"maxRetrieve_query_entities": {
"description": "maximum number of entities to return (default 50)",
"in": "query",
"name": "maxRetrieve",
"required": false,
"type": "integer"
},
"maxRetrieve_query_keywords": {
"description": "maximum number of keywords to return (default 50)",
"in": "query",
"name": "maxRetrieve",
"required": false,
"type": "integer"
},
"maxRetrieve_query_relations": {
"description": "maximum number of relations to return (default 50, max 100)",
"in": "query",
"name": "maxRetrieve",
"required": false,
"type": "integer"
},
"metadata_url_formData": {
"description": "Input here will appear in the url field in the response",
"in": "formData",
"name": "url",
"required": false,
"type": "string"
},
"metadata_url_query": {
"description": "Input here will appear in the url field in the response",
"in": "query",
"name": "url",
"required": false,
"type": "string"
},
"model_formData": {
"description": "Unique identifier for a custom model. By default, one of the following models are used depending on the language of the source text:<p><ul><li>en-news</li><li>es-news</li><li>ar-news</li></ul></p>",
"in": "formData",
"name": "model",
"required": false,
"type": "string"
},
"model_query": {
"description": "Unique identifier for a custom model. By default, one of the following models are used depending on the language of the source text:<p><ul><li>en-news</li><li>es-news</li><li>ar-news</li></ul></p>",
"in": "query",
"name": "model",
"required": false,
"type": "string"
},
"outputMode_formData": {
"description": "Desired response format (default XML)",
"enum": ["json", "rdf", "xml"],
"in": "formData",
"name": "outputMode",
"required": false,
"type": "string"
},
"outputMode_query": {
"description": "Desired response format (default XML)",
"enum": ["json", "rdf", "xml"],
"in": "query",
"name": "outputMode",
"required": false,
"type": "string"
},
"quotations_formData": {
"description": "Set this to 1 to return quotations associated with detected entities",
"enum": [0, 1],
"in": "formData",
"name": "quotations",
"required": false,
"type": "integer"
},
"quotations_query": {
"description": "Set this to 1 to return quotations associated with detected entities",
"enum": [0, 1],
"in": "query",
"name": "quotations",
"required": false,
"type": "integer"
},
"requireEntities_formData": {
"description": "Set this to 1 to only report relations that contain at least one entity",
"enum": [0, 1],
"in": "formData",
"name": "requireEntities",
"required": false,
"type": "number"
},
"requireEntities_query": {
"description": "Set this to 1 to only report relations that contain at least one entity",
"enum": [0, 1],
"in": "query",
"name": "requireEntities",
"required": false,
"type": "number"
},
"sentimentExcludeEntities_formData": {
"description": "Set this to 1 to exclude entity name text from sentiment analysis (for example, do not analyze \"New\" in \"New York\")",
"enum": [0, 1],
"in": "formData",
"name": "sentimentExcludeEntities",
"required": false,
"type": "number"
},
"sentimentExcludeEntities_query": {
"description": "Set this to 1 to exclude entity name text from sentiment analysis (for example, do not analyze \"New\" in \"New York\")",
"enum": [0, 1],
"in": "query",
"name": "sentimentExcludeEntities",
"required": false,
"type": "number"
},
"sentiment_formData": {
"description": "Set this to 1 to return sentient information for each detected result<br><b>Incurs an additional API transaction</b>",
"enum": [0, 1],
"in": "formData",
"name": "sentiment",
"required": false,
"type": "integer"
},
"sentiment_query": {
"description": "Set this to 1 to return sentiment information for each detected result<br><b>Incurs an additional API transaction</b>",
"enum": [0, 1],
"in": "query",
"name": "sentiment",
"required": false,
"type": "integer"
},
"showSourceText_formData": {
"description": "Set this to 1 to include the original source text in the API response (default 0)",
"enum": [0, 1],
"in": "formData",
"name": "showSourceText",
"required": false,
"type": "integer"
},
"showSourceText_query": {
"description": "Set this to 1 to include the original source text in the API response (default 0)",
"enum": [0, 1],
"in": "query",
"name": "showSourceText",
"required": false,
"type": "integer"
},
"sourceText_formData": {
"description": "Method used to obtain the source text from the HTML file (default cleaned_or_raw)",
"enum": [
"cleaned_or_raw (default)",
"cleaned",
"raw",
"xpath",
"xpath_or_raw",
"cleaned_and_xpath"
],
"in": "formData",
"name": "sourceText",
"required": false,
"type": "string"
},
"sourceText_query": {
"description": "Method used to obtain the source text from the HTML file (default cleaned_or_raw)",
"enum": [
"cleaned_or_raw (default)",
"cleaned",
"raw",
"xpath",
"xpath_or_raw",
"cleaned_and_xpath"
],
"in": "query",
"name": "sourceText",
"required": false,
"type": "string"
},
"structuredEntities_formData": {
"description": "Set this to 0 to ignore structured entities, such as Quantity, EmailAddress, TwitterHandle, Hashtag, and IPAddress",
"enum": [0, 1],
"in": "formData",
"name": "structuredEntities",
"required": false,
"type": "integer"
},
"structuredEntities_query": {
"description": "Set this to 0 to ignore structured entities, such as Quantity, EmailAddress, TwitterHandle, Hashtag, and IPAddress",
"enum": [0, 1],
"in": "query",
"name": "structuredEntities",
"required": false,
"type": "integer"
},
"targets_formData": {
"description": "Pipe delimited list of target phrases (must be URL encoded) - sentiment targeted towards these phrases will be analyzed",
"in": "formData",
"name": "targets",
"required": true,
"type": "string"
},
"targets_formData_emotion": {
"description": "Pipe delimited list of target phrases (must be URL encoded) - Emotion Analysis will be performed on the phrases in the context of the source text",
"in": "formData",
"name": "targets",
"required": true,
"type": "string"
},
"targets_query": {
"description": "Pipe delimited list of target phrases (must be URL encoded) - sentiment targeted towards these phrases will be analyzed",
"in": "query",
"name": "targe