neverminedio/molecule_service
This service implementation is part of the Molecule Summarizer by Nevermined.
The Summarizer takes a reasearch paper focused on DeSci env, and generated a summary, using OpenAI API, that includes key information about molecules and proteins.
This service handles the clients request of new jobs and integrates Nevermined, so all the input data, and the sumary result, are Nevermined Assets.
There are 3 endpoints:
More information about the endpoints in summarizer/v1/docs
It's important to remark that this service does not interact with OpenAI in anyway, and it's not responsible to create the summary. Only manage the job request and the integration with Nevermined. There is another piece in the Molecule Summarizer architecture, fed by the jobs created here, that create this summaries using ChatGPT.
nvmrc
fileInstall all necessary dependencies via:
yarn
You can build the project running
yarn build
And check the linter
yarn lint
Copy the local profile configuration via:
yarn setup:dev
This will leave you with a local.js
file within the config
folder that will be used as the profile configuration.
#### Nevermined Integration
### Service configuration
ACCESS_TOKEN_SECRET. Token user needs to include in Authorization Header
DOWNLOAD_PATH. Path to a folder where the service wil download the files contained in the input assets
JOB_INDEX_NAME. Name of the index to store all the job request. Default value is molecule_job
SUMMARY_INDEX_NAME. Name of the index to store the output summaries. Default value is molecule_summary
ELASTIC_CLOUD_ID. If you are using an Elastic Cloud account
ELASTIC_API_KEY. If you are using Elastic Cloud, an apiKey to authenticate
ELASTIC_NODE. Host of an Elastic 8 instance. Not necessary if you are using Elastic Cloud
ELASTIC_CERT_PATH. Path to a certificate to use in Elastic 8 connection.
ELASTIC_USER. If basic authentication is enabled
ELASTIC_PASSWORD. If basic authentication is enabled
GCLOUD_BUCKET.Name of a GCloud Storage Bocket
GOOGLE_APPLICATION_CREDENTIALS. Path to a credentials file for Google Cloud
NVM_APP_DOMAIN. Domain of the Nevermined App where the user can visualice the details of the DDO with the result. Example: 'https://goerli.nevermined.app'
NVM_APP_DATASET_URL. Dataset url in Nevermined App. Default to '/en/dataset'
SUMMARY_COVER_IMAGE_URL. Url of an image the service will use as cover image for the new asset.
docker pull neverminedio/molecule_service