wisecube 0.0.6

Wisecube SDK for graph Search

Wisecube SDK - Version - 0.0.1

Overview

The Wisecube SDK provides a Python interface to interact with the Wisecube AI services. This SDK allows developers to seamlessly integrate with Wisecube's APIs for various functionalities.

Getting Started

1. Install the sdk from github

pip install wisecube

2. Authentication

Create an instance of the WisecubeClient class with your API key. This is done in a python console:

from src import WisecubeClient

Replace with API key !

auth_key = WisecubeClient('api_key')

API Usage

# Replace with the API key
auth_client = WisecubeClient('api_key')

# Perform operations using the SDK methods
auth_client.client.qa("Which proteins participate in the formation of the ryanodine receptor quaternary macromolecular complex?")

***Below is a table with the APIs and a short descirption. ***

APIs	Description
qa	returns the answer and documents related to the question
documents	return documents for the question
search_graph	returns results containing nodes and edges
search_text	returns a list of entities related to the search term
advanced_search	returns a dataframe with multiple rows, each representing a different entity with its URI and label
getPredicates	retrieves information about predicates associated with a given label
executeVectorFunction	retrieves embeddings for the given entities
executeScoreFunction	returns the score for each triple
getAdmetPrediction	returns prediction using ADMET models and sagemaker

QA

Description

This API provides relevant summary information for the specified question, including the answer and relevant documents associated with them.

auth_client.client.qa(question)

Parameters

• question (String): the input must be a question you want the answer to

Documents

Description

This API query provides insights and relevant documents related to the question.

auth_client.client.documents(question)

Parameters

• question (String): the input must be a question to get the documents

Search Graph

Description

This API retrieves insights based on specified parameters and returns the results in the form of a subgraph containing nodes and edges.

auth_client.client.search_graph(graphIds, nr=20)

Parameters

• -graphIds ([String]): the input must be a list of ids, ID of the starting node in the graph
• -maxNeighbors(Int): represented by nr : optional variable, default is 10,representing the maximum number of neighbor nodes to retrieve

Search Text

Description

The API returns a list of entities related to the search term.

auth_client.client.search_text(searchText)

Parameters

• searchText (String): the string you want to search

Advanced Search

Description

This API returns the entities retrieved from the Wikidata database based on the provided query.

auth_client.client.advancedSearch(query)

Parameters

• query (String): query for advanced search, encoded as a string

Predicate Graph

Description

The API retrieves information about predicates associated with a given label.

auth_api_client.getPredicates(labels)

Parameters

• labels(String): represents the label of a predicate

Execute Vector Function

Description

The API retrieves embeddings for the given entities.

auth_api_client.executeVectorFunction(graphIds)

Parameters

• graphIds[String]: variable used to specify a list of graph IDs

Execute Score Function

Description

This API retrieves the score for each triple.

auth_api_client.executeScoreFunction(triples)

Parameters

• triples[[String]]: variable representing a list of lists of strings, containing three elements

Admet Prediction

Description

This API retrieves prediction using ADMET models and sagemaker.

List of models: [BBB, logS, CYP2CI9i, LogD7, PGPi, PGPs, HIA, F20, F30, PPB, VD, CYPIA2i, CYPIA2s, CYP3A4i, CYP3A4s, CYP2C9i, CYP2C9s, CYP2C19s, CYP2D6i, CYP2D6s, CL, Ames, DILI, SkinS ]

auth_api_client.getAdmetPrediction(smiles=smiles, model=model.BBB)

Parameters

• smiles[String]: specification in the form of a line notation for describing the structure of chemical species
• model (String): represents the model name