deeperlib.api.aminer package¶

Submodules¶

deeperlib.api.aminer.advanced_personapi module¶

class deeperlib.api.aminer.advanced_personapi.AdvancedPersonApi(top_k, delay, search_term, **kwargs)[source]¶

Bases: deeperlib.api.simapi.SimpleApi

A subclass implemented for aminer/search/pub/advanced api—-https://api.aminer.org/api/search/pub/advanced

Initialize the object. Set url and create session. Set other parameters and top_k for future api call.

Parameters:	top_k – top-k constraint delay – time interval between a failed api call and the next api call search_term – the field for query string kwargs – other parameters

callAPI(params)[source]¶

Call api until it returns messages successfully.

Parameters:	params – all the parameters needed by an api
Returns:	businesses in returned documents

callMulAPI(queries)[source]¶

getDelay()[source]¶

getID()[source]¶

getKwargs()[source]¶

getSearchTerm()[source]¶

getSession()[source]¶

getToken()[source]¶

getTopk()[source]¶

getURL()[source]¶

setDelay(delay)[source]¶

setID(client_id, client_secret)[source]¶

setKwargs(kwargs)[source]¶

setSearchTerm(search_term)[source]¶

setSession(session)[source]¶

setToken()[source]¶

setTopk(top_k)[source]¶

setURL(url)[source]¶

deeperlib.api.aminer.advanced_publapi module¶

class deeperlib.api.aminer.advanced_publapi.AdvancedPublApi(top_k, delay, search_term, **kwargs)[source]¶

Bases: deeperlib.api.simapi.SimpleApi

A subclass implemented for aminer/search/pub/advanced api—-https://api.aminer.org/api/search/pub/advanced

Initialize the object. Set url and create session. Set other parameters and top_k for future api call.

Parameters:	top_k – top-k constraint delay – time interval between a failed api call and the next api call search_term – the field for query string kwargs – other parameters

callAPI(params)[source]¶

Call api until it returns messages successfully.

Parameters:	params – all the parameters needed by an api
Returns:	businesses in returned documents

callMulAPI(queries)[source]¶

Call api with multiple threads. Therefore, we can issue several queries and get all of the top k documents at the same time.

Parameters:	queries – queries list
Returns:	messages returned from api

getDelay()[source]¶

getID()[source]¶

getKwargs()[source]¶

getSearchTerm()[source]¶

getSession()[source]¶

getToken()[source]¶

getTopk()[source]¶

getURL()[source]¶

setDelay(delay)[source]¶

setID(client_id, client_secret)[source]¶

setKwargs(kwargs)[source]¶

setSearchTerm(search_term)[source]¶

setSession(session)[source]¶

setToken()[source]¶

setTopk(top_k)[source]¶

setURL(url)[source]¶

deeperlib.api.aminer.personapi module¶

class deeperlib.api.aminer.personapi.PersonApi(top_k, delay, search_term, **kwargs)[source]¶

Bases: deeperlib.api.simapi.SimpleApi

A subclass implemented for aminer/search/person api—-https://api.aminer.org/api/search/person

Initialize the object. Set url and create session. Set other parameters and top_k for future api call.

Parameters:	top_k – top-k constraint delay – time interval between a failed api call and the next api call search_term – the field for query string kwargs – other parameters

callAPI(params)[source]¶

Call api until it returns messages successfully.

Parameters:	params – all the parameters needed by an api
Returns:	businesses in returned documents

callMulAPI(queries)[source]¶

Call api with multiple threads. Therefore, we can issue several queries and get all of the top k documents at the same time.

Parameters:	queries – queries list
Returns:	messages returned from api

getDelay()[source]¶

getID()[source]¶

getKwargs()[source]¶

getSearchTerm()[source]¶

getSession()[source]¶

getToken()[source]¶

getTopk()[source]¶

getURL()[source]¶

setDelay(delay)[source]¶

setID(client_id, client_secret)[source]¶

setKwargs(kwargs)[source]¶

setSearchTerm(search_term)[source]¶

setSession(session)[source]¶

setToken()[source]¶

setTopk(top_k)[source]¶

setURL(url)[source]¶

deeperlib.api.aminer.publapi module¶

class deeperlib.api.aminer.publapi.PublApi(top_k, delay, search_term, **kwargs)[source]¶

Bases: deeperlib.api.simapi.SimpleApi

A subclass implemented for aminer/search/pub api—-https://api.aminer.org/api/search/pub

Initialize the object. Set url and create session. Set other parameters and top_k for future api call.

Parameters:	top_k – top-k constraint delay – time interval between a failed api call and the next api call search_term – the field for query string kwargs – other parameters

callAPI(params)[source]¶

Call api until it returns messages successfully.

Parameters:	params – all the parameters needed by an api
Returns:	businesses in returned documents

callMulAPI(queries)[source]¶

Call api with multiple threads. Therefore, we can issue several queries and get all of the top k documents at the same time.

Parameters:	queries – queries list
Returns:	messages returned from api

getDelay()[source]¶

getID()[source]¶

getKwargs()[source]¶

getSearchTerm()[source]¶

getSession()[source]¶

getToken()[source]¶

getTopk()[source]¶

getURL()[source]¶

setDelay(delay)[source]¶

setID(client_id, client_secret)[source]¶

setKwargs(kwargs)[source]¶

setSearchTerm(search_term)[source]¶

setSession(session)[source]¶

setToken()[source]¶

setTopk(top_k)[source]¶

setURL(url)[source]¶

Module contents¶