Collaboration diagram for dc_processor.alchemyapi.AlchemyAPI:

Public Member Functions
def	__init__ (self)

def	entities (self, flavor, data, options={})

def	keywords (self, flavor, data, options={})

def	concepts (self, flavor, data, options={})

def	sentiment (self, flavor, data, options={})

def	sentiment_targeted (self, flavor, data, target, options={})

def	text (self, flavor, data, options={})

def	text_raw (self, flavor, data, options={})

def	author (self, flavor, data, options={})

def	language (self, flavor, data, options={})

def	title (self, flavor, data, options={})

def	relations (self, flavor, data, options={})

def	category (self, flavor, data, options={})

def	feeds (self, flavor, data, options={})

def	microformats (self, flavor, data, options={})

def	imageExtraction (self, flavor, data, options={})

def	taxonomy (self, flavor, data, options={})

def	combined (self, flavor, data, options={})

def	imageTagging (self, flavor, data, options={})

Public Attributes
	apikey

Static Public Attributes
dictionary	ENDPOINTS = {}

string	BASE_URL = 'http://access.alchemyapi.com/calls'

	s = requests.Session()

Private Member Functions
def	__analyze (self, endpoint, params, post_data=bytearray())

Detailed Description

Definition at line 65 of file alchemyapi.py.

Constructor & Destructor Documentation

◆ init()

def dc_processor.alchemyapi.AlchemyAPI.__init__ ( self )

Initializes the SDK so it can send requests to AlchemyAPI for analysis.
It loads the API key from api_key.txt and configures the endpoints.

Definition at line 136 of file alchemyapi.py.

     def __init__(self):
         """
         Initializes the SDK so it can send requests to AlchemyAPI for analysis.
         It loads the API key from api_key.txt and configures the endpoints.
         """
 
         import sys
         try:
             # Open the key file and read the key
             f = open("api_key.txt", "r")
             key = f.read().strip()
 
             if key == '':
                 # The key file should't be blank
                 print(
                     'The api_key.txt file appears to be blank, please run: python alchemyapi.py YOUR_KEY_HERE')
                 print(
                     'If you do not have an API Key from AlchemyAPI, please register for one at: http://www.alchemyapi.com/api/register.html')
                 sys.exit(0)
             elif len(key) != 40:
                 # Keys should be exactly 40 characters long
                 print(
                     'It appears that the key in api_key.txt is invalid. Please make sure the file only includes the API key, and it is the correct one.')
                 sys.exit(0)
             else:
                 # setup the key
                 self.apikey = key
 
             # Close file
             f.close()
         except IOError:
             # The file doesn't exist, so show the message and create the file.
             print(
                 'API Key not found! Please run: python alchemyapi.py YOUR_KEY_HERE')
             print(
                 'If you do not have an API Key from AlchemyAPI, please register for one at: http://www.alchemyapi.com/api/register.html')
 
             # create a blank key file
             open('api_key.txt', 'a').close()
             sys.exit(0)
         except Exception as e:
             print(e)
 

Member Function Documentation

◆ __analyze()

def dc_processor.alchemyapi.AlchemyAPI.__analyze	(	self,
		endpoint,
		params,
		post_data = `bytearray()`
	)

private

HTTP Request wrapper that is called by the endpoint functions. This function is not intended to be called through an external interface.
It makes the call, then converts the returned JSON string into a Python object.

INPUT:
url -> the full URI encoded url

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 723 of file alchemyapi.py.

     def __analyze(self, endpoint, params, post_data=bytearray()):
         """
         HTTP Request wrapper that is called by the endpoint functions. This function is not intended to be called through an external interface.
         It makes the call, then converts the returned JSON string into a Python object.
 
         INPUT:
         url -> the full URI encoded url
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Add the API Key and set the output mode to JSON
         params['apikey'] = self.apikey
         params['outputMode'] = 'json'
         # Insert the base url
 
         post_url = ""
         try:
             post_url = AlchemyAPI.BASE_URL + endpoint + \
                 '?' + urlencode(params).encode('utf-8')
         except TypeError:
             post_url = AlchemyAPI.BASE_URL + endpoint + '?' + urlencode(params)
 
         results = ""
         try:
             results = self.s.post(url=post_url, data=post_data)
         except Exception as e:
             print(e)
             return {'status': 'ERROR', 'statusInfo': 'network-error'}
         try:
             return results.json()
         except Exception as e:
             if results != "":
                 print(results)
             print(e)
             return {'status': 'ERROR', 'statusInfo': 'parse-error'}

Here is the call graph for this function:



Here is the caller graph for this function:

◆ author()

def dc_processor.alchemyapi.AlchemyAPI.author	(	self,
		flavor,
		data,
		options = `{}`
	)

Extracts the author from a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/author-extraction/
For the docs, please refer to: http://www.alchemyapi.com/api/author-extraction/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Availble Options:
none

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 374 of file alchemyapi.py.

     def author(self, flavor, data, options={}):
         """
         Extracts the author from a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/author-extraction/
         For the docs, please refer to: http://www.alchemyapi.com/api/author-extraction/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Availble Options:
         none
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['author']:
             return {'status': 'ERROR', 'statusInfo': 'author extraction for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['author'][flavor], {}, options)
 

Here is the call graph for this function:

◆ category()

def dc_processor.alchemyapi.AlchemyAPI.category	(	self,
		flavor,
		data,
		options = `{}`
	)

Categorizes the text for text, a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/text-categorization/
For the docs, please refer to: http://www.alchemyapi.com/api/text-categorization/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
showSourceText -> 0: disabled (default), 1: enabled

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 487 of file alchemyapi.py.

     def category(self, flavor, data, options={}):
         """
         Categorizes the text for text, a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/text-categorization/
         For the docs, please refer to: http://www.alchemyapi.com/api/text-categorization/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         showSourceText -> 0: disabled (default), 1: enabled
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['category']:
             return {'status': 'ERROR', 'statusInfo': 'text categorization for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
 
         return self.__analyze(AlchemyAPI.ENDPOINTS['category'][flavor], {}, options)
 

Here is the call graph for this function:

◆ combined()

def dc_processor.alchemyapi.AlchemyAPI.combined	(	self,
		flavor,
		data,
		options = `{}`
	)

Combined call for page-image, entity, keyword, title, author, taxonomy,  concept.

INPUT:
flavor -> which version of the call, i.e.  url or html.
data -> the data to analyze, either the the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
extract ->
    Possible values: page-image, entity, keyword, title, author, taxonomy,  concept
    default        : entity, keyword, taxonomy,  concept

disambiguate ->
    disambiguate detected entities
    Possible values:
1 : enabled (default)
0 : disabled

linkedData ->
    include Linked Data content links with disambiguated entities
    Possible values :
1 : enabled (default)
0 : disabled

coreference ->
    resolve he/she/etc coreferences into detected entities
    Possible values:
1 : enabled (default)
0 : disabled

quotations ->
    enable quotations extraction
    Possible values:
1 : enabled
0 : disabled (default)

sentiment ->
    enable entity-level sentiment analysis
    Possible values:
1 : enabled
0 : disabled (default)

showSourceText ->
    include the original 'source text' the entities were extracted from within the API response
    Possible values:
1 : enabled
0 : disabled (default)

maxRetrieve ->
    maximum number of named entities to extract
    default : 50

baseUrl ->
    rel-tag output base http url


OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 639 of file alchemyapi.py.

     def combined(self, flavor, data, options={}):
         """
         Combined call for page-image, entity, keyword, title, author, taxonomy,  concept.
 
         INPUT:
         flavor -> which version of the call, i.e.  url or html.
         data -> the data to analyze, either the the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         extract ->
             Possible values: page-image, entity, keyword, title, author, taxonomy,  concept
             default        : entity, keyword, taxonomy,  concept
 
         disambiguate ->
             disambiguate detected entities
             Possible values:
                 1 : enabled (default)
                 0 : disabled
 
         linkedData ->
             include Linked Data content links with disambiguated entities
             Possible values :
                 1 : enabled (default)
                 0 : disabled
 
         coreference ->
             resolve he/she/etc coreferences into detected entities
             Possible values:
                 1 : enabled (default)
                 0 : disabled
 
         quotations ->
             enable quotations extraction
             Possible values:
                 1 : enabled
                 0 : disabled (default)
 
         sentiment ->
             enable entity-level sentiment analysis
             Possible values:
                 1 : enabled
                 0 : disabled (default)
 
         showSourceText ->
             include the original 'source text' the entities were extracted from within the API response
             Possible values:
                 1 : enabled
                 0 : disabled (default)
 
         maxRetrieve ->
             maximum number of named entities to extract
             default : 50
 
         baseUrl ->
             rel-tag output base http url
 
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
         if flavor not in AlchemyAPI.ENDPOINTS['combined']:
             return {'status': 'ERROR', 'statusInfo': 'combined for ' + flavor + ' not available'}
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['combined'][flavor], {}, options)
 

Here is the call graph for this function:

◆ concepts()

def dc_processor.alchemyapi.AlchemyAPI.concepts	(	self,
		flavor,
		data,
		options = `{}`
	)

Tags the concepts for text, a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/concept-tagging/
For the docs, please refer to: http://www.alchemyapi.com/api/concept-tagging/

Available Options:
maxRetrieve -> the maximum number of concepts to retrieve (default: 8)
linkedData -> include linked data, 0: disabled, 1: enabled (default)
showSourceText -> 0:disabled (default), 1: enabled

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 240 of file alchemyapi.py.

     def concepts(self, flavor, data, options={}):
         """
         Tags the concepts for text, a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/concept-tagging/
         For the docs, please refer to: http://www.alchemyapi.com/api/concept-tagging/
 
         Available Options:
         maxRetrieve -> the maximum number of concepts to retrieve (default: 8)
         linkedData -> include linked data, 0: disabled, 1: enabled (default)
         showSourceText -> 0:disabled (default), 1: enabled
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['concepts']:
             return {'status': 'ERROR', 'statusInfo': 'concept tagging for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['concepts'][flavor], {}, options)
 

Here is the call graph for this function:

◆ entities()

def dc_processor.alchemyapi.AlchemyAPI.entities	(	self,
		flavor,
		data,
		options = `{}`
	)

Extracts the entities for text, a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/entity-extraction/
For the docs, please refer to: http://www.alchemyapi.com/api/entity-extraction/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
disambiguate -> disambiguate entities (i.e. Apple the company vs. apple the fruit). 0: disabled, 1: enabled (default)
linkedData -> include linked data on disambiguated entities. 0: disabled, 1: enabled (default)
coreference -> resolve coreferences (i.e. the pronouns that correspond to named entities). 0: disabled, 1: enabled (default)
quotations -> extract quotations by entities. 0: disabled (default), 1: enabled.
sentiment -> analyze sentiment for each entity. 0: disabled (default), 1: enabled. Requires 1 additional API transction if enabled.
showSourceText -> 0: disabled (default), 1: enabled
maxRetrieve -> the maximum number of entities to retrieve (default: 50)

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 179 of file alchemyapi.py.

     def entities(self, flavor, data, options={}):
         """
         Extracts the entities for text, a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/entity-extraction/
         For the docs, please refer to: http://www.alchemyapi.com/api/entity-extraction/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         disambiguate -> disambiguate entities (i.e. Apple the company vs. apple the fruit). 0: disabled, 1: enabled (default)
         linkedData -> include linked data on disambiguated entities. 0: disabled, 1: enabled (default)
         coreference -> resolve coreferences (i.e. the pronouns that correspond to named entities). 0: disabled, 1: enabled (default)
         quotations -> extract quotations by entities. 0: disabled (default), 1: enabled.
         sentiment -> analyze sentiment for each entity. 0: disabled (default), 1: enabled. Requires 1 additional API transction if enabled.
         showSourceText -> 0: disabled (default), 1: enabled
         maxRetrieve -> the maximum number of entities to retrieve (default: 50)
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['entities']:
             return {'status': 'ERROR', 'statusInfo': 'entity extraction for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['entities'][flavor], {}, options)
 

Here is the call graph for this function:

◆ feeds()

def dc_processor.alchemyapi.AlchemyAPI.feeds	(	self,
		flavor,
		data,
		options = `{}`
	)

Detects the RSS/ATOM feeds for a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/feed-detection/
For the docs, please refer to: http://www.alchemyapi.com/api/feed-detection/

INPUT:
flavor -> which version of the call, i.e.  url or html.
data -> the data to analyze, either the the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
none

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 514 of file alchemyapi.py.

     def feeds(self, flavor, data, options={}):
         """
         Detects the RSS/ATOM feeds for a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/feed-detection/
         For the docs, please refer to: http://www.alchemyapi.com/api/feed-detection/
 
         INPUT:
         flavor -> which version of the call, i.e.  url or html.
         data -> the data to analyze, either the the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         none
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['feeds']:
             return {'status': 'ERROR', 'statusInfo': 'feed detection for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['feeds'][flavor], {}, options)
 

Here is the call graph for this function:

◆ imageExtraction()

def dc_processor.alchemyapi.AlchemyAPI.imageExtraction	(	self,
		flavor,
		data,
		options = `{}`
	)

Extracts main image from a URL

INPUT:
flavor -> which version of the call (url only currently).
data -> URL to analyze
options -> various parameters that can be used to adjust how the API works,
see below for more info on the available options.

Available Options:
extractMode ->
     trust-metadata  :  (less CPU intensive, less accurate)
     always-infer    :  (more CPU intensive, more accurate)
OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 566 of file alchemyapi.py.

     def imageExtraction(self, flavor, data, options={}):
         """
         Extracts main image from a URL
 
         INPUT:
         flavor -> which version of the call (url only currently).
         data -> URL to analyze
         options -> various parameters that can be used to adjust how the API works,
         see below for more info on the available options.
 
         Available Options:
         extractMode ->
              trust-metadata  :  (less CPU intensive, less accurate)
              always-infer    :  (more CPU intensive, more accurate)
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
         if flavor not in AlchemyAPI.ENDPOINTS['image']:
             return {'status': 'ERROR', 'statusInfo': 'image extraction for ' + flavor + ' not available'}
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['image'][flavor], {}, options)
 

Here is the call graph for this function:

◆ imageTagging()

def dc_processor.alchemyapi.AlchemyAPI.imageTagging	(	self,
		flavor,
		data,
		options = `{}`
	)

INPUT:
flavor -> which version of the call only url or image.
data -> the data to analyze, either the the url or path to image.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Definition at line 705 of file alchemyapi.py.

     def imageTagging(self, flavor, data, options={}):
         """
 
         INPUT:
         flavor -> which version of the call only url or image.
         data -> the data to analyze, either the the url or path to image.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
         """
         if flavor not in AlchemyAPI.ENDPOINTS['imagetagging']:
             return {'status': 'ERROR', 'statusInfo': 'imagetagging for ' + flavor + ' not available'}
         elif 'image' == flavor:
             image = open(data, 'rb').read()
             options['imagePostMode'] = 'raw'
             return self.__analyze(AlchemyAPI.ENDPOINTS['imagetagging'][flavor], options, image)
 
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['imagetagging'][flavor], {}, options)
 

Here is the call graph for this function:

◆ keywords()

def dc_processor.alchemyapi.AlchemyAPI.keywords	(	self,
		flavor,
		data,
		options = `{}`
	)

Extracts the keywords from text, a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/keyword-extraction/
For the docs, please refer to: http://www.alchemyapi.com/api/keyword-extraction/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
keywordExtractMode -> normal (default), strict
sentiment -> analyze sentiment for each keyword. 0: disabled (default), 1: enabled. Requires 1 additional API transaction if enabled.
showSourceText -> 0: disabled (default), 1: enabled.
maxRetrieve -> the max number of keywords returned (default: 50)

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 211 of file alchemyapi.py.

     def keywords(self, flavor, data, options={}):
         """
         Extracts the keywords from text, a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/keyword-extraction/
         For the docs, please refer to: http://www.alchemyapi.com/api/keyword-extraction/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         keywordExtractMode -> normal (default), strict
         sentiment -> analyze sentiment for each keyword. 0: disabled (default), 1: enabled. Requires 1 additional API transaction if enabled.
         showSourceText -> 0: disabled (default), 1: enabled.
         maxRetrieve -> the max number of keywords returned (default: 50)
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['keywords']:
             return {'status': 'ERROR', 'statusInfo': 'keyword extraction for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['keywords'][flavor], {}, options)
 

Here is the call graph for this function:

◆ language()

def dc_processor.alchemyapi.AlchemyAPI.language	(	self,
		flavor,
		data,
		options = `{}`
	)

Detects the language for text, a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/api/language-detection/
For the docs, please refer to: http://www.alchemyapi.com/products/features/language-detection/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
none

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 400 of file alchemyapi.py.

     def language(self, flavor, data, options={}):
         """
         Detects the language for text, a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/api/language-detection/
         For the docs, please refer to: http://www.alchemyapi.com/products/features/language-detection/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         none
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['language']:
             return {'status': 'ERROR', 'statusInfo': 'language detection for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['language'][flavor], {}, options)
 

Here is the call graph for this function:

◆ microformats()

def dc_processor.alchemyapi.AlchemyAPI.microformats	(	self,
		flavor,
		data,
		options = `{}`
	)

Parses the microformats for a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/microformats-parsing/
For the docs, please refer to: http://www.alchemyapi.com/api/microformats-parsing/

INPUT:
flavor -> which version of the call, i.e.  url or html.
data -> the data to analyze, either the the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
none

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 540 of file alchemyapi.py.

     def microformats(self, flavor, data, options={}):
         """
         Parses the microformats for a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/microformats-parsing/
         For the docs, please refer to: http://www.alchemyapi.com/api/microformats-parsing/
 
         INPUT:
         flavor -> which version of the call, i.e.  url or html.
         data -> the data to analyze, either the the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         none
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['microformats']:
             return {'status': 'ERROR', 'statusInfo': 'microformat extraction for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['microformats'][flavor], {}, options)
 

Here is the call graph for this function:

◆ relations()

def dc_processor.alchemyapi.AlchemyAPI.relations	(	self,
		flavor,
		data,
		options = `{}`
	)

Extracts the relations for text, a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/relation-extraction/
For the docs, please refer to: http://www.alchemyapi.com/api/relation-extraction/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
sentiment -> 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
keywords -> extract keywords from the subject and object. 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
entities -> extract entities from the subject and object. 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
requireEntities -> only extract relations that have entities. 0: disabled (default), 1: enabled.
sentimentExcludeEntities -> exclude full entity name in sentiment analysis. 0: disabled, 1: enabled (default)
disambiguate -> disambiguate entities (i.e. Apple the company vs. apple the fruit). 0: disabled, 1: enabled (default)
linkedData -> include linked data with disambiguated entities. 0: disabled, 1: enabled (default).
coreference -> resolve entity coreferences. 0: disabled, 1: enabled (default)
showSourceText -> 0: disabled (default), 1: enabled.
maxRetrieve -> the maximum number of relations to extract (default: 50, max: 100)

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 452 of file alchemyapi.py.

     def relations(self, flavor, data, options={}):
         """
         Extracts the relations for text, a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/relation-extraction/
         For the docs, please refer to: http://www.alchemyapi.com/api/relation-extraction/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         sentiment -> 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
         keywords -> extract keywords from the subject and object. 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
         entities -> extract entities from the subject and object. 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
         requireEntities -> only extract relations that have entities. 0: disabled (default), 1: enabled.
         sentimentExcludeEntities -> exclude full entity name in sentiment analysis. 0: disabled, 1: enabled (default)
         disambiguate -> disambiguate entities (i.e. Apple the company vs. apple the fruit). 0: disabled, 1: enabled (default)
         linkedData -> include linked data with disambiguated entities. 0: disabled, 1: enabled (default).
         coreference -> resolve entity coreferences. 0: disabled, 1: enabled (default)
         showSourceText -> 0: disabled (default), 1: enabled.
         maxRetrieve -> the maximum number of relations to extract (default: 50, max: 100)
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['relations']:
             return {'status': 'ERROR', 'statusInfo': 'relation extraction for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['relations'][flavor], {}, options)
 

Here is the call graph for this function:

◆ sentiment()

def dc_processor.alchemyapi.AlchemyAPI.sentiment	(	self,
		flavor,
		data,
		options = `{}`
	)

Calculates the sentiment for text, a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/sentiment-analysis/
For the docs, please refer to: http://www.alchemyapi.com/api/sentiment-analysis/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
showSourceText -> 0: disabled (default), 1: enabled

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 263 of file alchemyapi.py.

     def sentiment(self, flavor, data, options={}):
         """
         Calculates the sentiment for text, a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/sentiment-analysis/
         For the docs, please refer to: http://www.alchemyapi.com/api/sentiment-analysis/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         showSourceText -> 0: disabled (default), 1: enabled
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['sentiment']:
             return {'status': 'ERROR', 'statusInfo': 'sentiment analysis for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['sentiment'][flavor], {}, options)
 

Here is the call graph for this function:

◆ sentiment_targeted()

def dc_processor.alchemyapi.AlchemyAPI.sentiment_targeted	(	self,
		flavor,
		data,
		target,
		options = `{}`
	)

Calculates the targeted sentiment for text, a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/sentiment-analysis/
For the docs, please refer to: http://www.alchemyapi.com/api/sentiment-analysis/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
target -> the word or phrase to run sentiment analysis on.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
showSourceText  -> 0: disabled, 1: enabled

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 289 of file alchemyapi.py.

     def sentiment_targeted(self, flavor, data, target, options={}):
         """
         Calculates the targeted sentiment for text, a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/sentiment-analysis/
         For the docs, please refer to: http://www.alchemyapi.com/api/sentiment-analysis/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         target -> the word or phrase to run sentiment analysis on.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         showSourceText  -> 0: disabled, 1: enabled
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure the target is valid
         if target is None or target == '':
             return {'status': 'ERROR', 'statusInfo': 'targeted sentiment requires a non-null target'}
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['sentiment_targeted']:
             return {'status': 'ERROR', 'statusInfo': 'targeted sentiment analysis for ' + flavor + ' not available'}
 
         # add the URL encoded data and target to the options and analyze
         options[flavor] = data
         options['target'] = target
         return self.__analyze(AlchemyAPI.ENDPOINTS['sentiment_targeted'][flavor], {}, options)
 

Here is the call graph for this function:

◆ taxonomy()

def dc_processor.alchemyapi.AlchemyAPI.taxonomy	(	self,
		flavor,
		data,
		options = `{}`
	)

Taxonomy classification operations.

INPUT:
flavor -> which version of the call, i.e. url or html.
data -> the data to analyze, either the the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
showSourceText ->
include the original 'source text' the taxonomy categories were extracted from within the API response
Possible values:
1 - enabled
0 - disabled (default)

sourceText ->
where to obtain the text that will be processed by this API call.

AlchemyAPI supports multiple modes of text extraction:
web page cleaning (removes ads, navigation links, etc.), raw text extraction
(processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.

Possible values:
cleaned_or_raw : cleaning enabled, fallback to raw when cleaning produces no text (default)
cleaned : operate on 'cleaned' web page text (web page cleaning enabled)
raw : operate on raw web page text (web page cleaning disabled)
cquery : operate on the results of a visual constraints query
Note: The 'cquery' http argument must also be set to a valid visual constraints query.
xpath : operate on the results of an XPath query
Note: The 'xpath' http argument must also be set to a valid XPath query.

cquery ->
a visual constraints query to apply to the web page.

xpath ->
an XPath query to apply to the web page.

baseUrl ->
rel-tag output base http url (must be uri-argument encoded)

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 588 of file alchemyapi.py.

     def taxonomy(self, flavor, data, options={}):
         """
         Taxonomy classification operations.
 
         INPUT:
         flavor -> which version of the call, i.e.  url or html.
         data -> the data to analyze, either the the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
 
         Available Options:
         showSourceText  ->
             include the original 'source text' the taxonomy categories were extracted from within the API response
             Possible values:
                 1 - enabled
                 0 - disabled (default)
 
         sourceText ->
             where to obtain the text that will be processed by this API call.
 
             AlchemyAPI supports multiple modes of text extraction:
                 web page cleaning (removes ads, navigation links, etc.), raw text extraction
                 (processes all web page text, including ads / nav links), visual constraint queries, and XPath queries.
 
             Possible values:
                 cleaned_or_raw  : cleaning enabled, fallback to raw when cleaning produces no text (default)
                 cleaned         : operate on 'cleaned' web page text (web page cleaning enabled)
                 raw             : operate on raw web page text (web page cleaning disabled)
                 cquery          : operate on the results of a visual constraints query
                                   Note: The 'cquery' http argument must also be set to a valid visual constraints query.
                 xpath           : operate on the results of an XPath query
                                   Note: The 'xpath' http argument must also be set to a valid XPath query.
 
         cquery ->
             a visual constraints query to apply to the web page.
 
         xpath ->
             an XPath query to apply to the web page.
 
         baseUrl ->
             rel-tag output base http url (must be uri-argument encoded)
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
 
         """
         if flavor not in AlchemyAPI.ENDPOINTS['taxonomy']:
             return {'status': 'ERROR', 'statusInfo': 'taxonomy for ' + flavor + ' not available'}
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['taxonomy'][flavor], {}, options)
 

Here is the call graph for this function:

◆ text()

def dc_processor.alchemyapi.AlchemyAPI.text	(	self,
		flavor,
		data,
		options = `{}`
	)

Extracts the cleaned text (removes ads, navigation, etc.) for text, a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/
For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
useMetadata -> utilize meta description data, 0: disabled, 1: enabled (default)
extractLinks -> include links, 0: disabled (default), 1: enabled.

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 321 of file alchemyapi.py.

     def text(self, flavor, data, options={}):
         """
         Extracts the cleaned text (removes ads, navigation, etc.) for text, a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/
         For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         useMetadata -> utilize meta description data, 0: disabled, 1: enabled (default)
         extractLinks -> include links, 0: disabled (default), 1: enabled.
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['text']:
             return {'status': 'ERROR', 'statusInfo': 'clean text extraction for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['text'][flavor], options)
 

Here is the call graph for this function:

◆ text_raw()

def dc_processor.alchemyapi.AlchemyAPI.text_raw	(	self,
		flavor,
		data,
		options = `{}`
	)

Extracts the raw text (includes ads, navigation, etc.) for a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/
For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
none

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 348 of file alchemyapi.py.

     def text_raw(self, flavor, data, options={}):
         """
         Extracts the raw text (includes ads, navigation, etc.) for a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/
         For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         none
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['text_raw']:
             return {'status': 'ERROR', 'statusInfo': 'raw text extraction for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['text_raw'][flavor], {}, options)
 

Here is the call graph for this function:

◆ title()

def dc_processor.alchemyapi.AlchemyAPI.title	(	self,
		flavor,
		data,
		options = `{}`
	)

Extracts the title for a URL or HTML.
For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/
For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/

INPUT:
flavor -> which version of the call, i.e. text, url or html.
data -> the data to analyze, either the text, the url or html code.
options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

Available Options:
useMetadata -> utilize title info embedded in meta data, 0: disabled, 1: enabled (default)

OUTPUT:
The response, already converted from JSON to a Python object.

Definition at line 426 of file alchemyapi.py.

     def title(self, flavor, data, options={}):
         """
         Extracts the title for a URL or HTML.
         For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/
         For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/
 
         INPUT:
         flavor -> which version of the call, i.e. text, url or html.
         data -> the data to analyze, either the text, the url or html code.
         options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
 
         Available Options:
         useMetadata -> utilize title info embedded in meta data, 0: disabled, 1: enabled (default)
 
         OUTPUT:
         The response, already converted from JSON to a Python object.
         """
 
         # Make sure this request supports this flavor
         if flavor not in AlchemyAPI.ENDPOINTS['title']:
             return {'status': 'ERROR', 'statusInfo': 'title extraction for ' + flavor + ' not available'}
 
         # add the data to the options and analyze
         options[flavor] = data
         return self.__analyze(AlchemyAPI.ENDPOINTS['title'][flavor], {}, options)
 

Here is the call graph for this function:

Member Data Documentation

◆ apikey

dc_processor.alchemyapi.AlchemyAPI.apikey

Definition at line 162 of file alchemyapi.py.

◆ BASE_URL

string dc_processor.alchemyapi.AlchemyAPI.BASE_URL = 'http://access.alchemyapi.com/calls'

static

Definition at line 132 of file alchemyapi.py.

◆ ENDPOINTS

dictionary dc_processor.alchemyapi.AlchemyAPI.ENDPOINTS = {}

static

Definition at line 67 of file alchemyapi.py.

◆ s

dc_processor.alchemyapi.AlchemyAPI.s = requests.Session()

static

Definition at line 134 of file alchemyapi.py.

The documentation for this class was generated from the following file:

sources/hce/dc_processor/alchemyapi.py

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __analyze()

◆ author()

◆ category()

◆ combined()

◆ concepts()

◆ entities()

◆ feeds()

◆ imageExtraction()

◆ imageTagging()

◆ keywords()

◆ language()

◆ microformats()

◆ relations()

◆ sentiment()

◆ sentiment_targeted()

◆ taxonomy()

◆ text()

◆ text_raw()

◆ title()

Member Data Documentation

◆ apikey

◆ BASE_URL

◆ ENDPOINTS

◆ s

◆ init()