Repository files navigation

Clone the repository:

• $ git clone https://github.com/modzy/sdk-java.git

Usemaven to install the SDK.

• $ ./mvnw install -DskipTests=true

Add the dependency in yourpom.xml file:

<dependency><groupId>com.modzy</groupId><artifactId>modzy-sdk</artifactId><version>0.0.1</version></dependency>

API keys are security credentials required to perform API requests to Modzy. Our API keys are composed of an ID that is split by a dot into two parts: a public and private part.

Thepublic part is the API keys' visible part only used to identify the key and by itself, it’s unable to perform API requests.

Theprivate part is the public part's complement and it’s required to perform API requests. Since it’s not stored on Modzy’s servers, it cannot be recovered. Make sure to save it securely. If lost, you canreplace the API key.

Find your API key in your user profile. To get your full API key click on "Get key":

Once you have amodel andversion identified, get authenticated with your API key.

ModzyClientmodzyClient =newModzyClient("http://url.to.modzy/api","API Key");

Modzy’s Marketplace includes pre-trained and re-trainable AI models from industry-leading machine learning companies, accelerating the process from data to value.

The Model service drives the Marketplace and can be integrated with other applications, scripts, and systems. It provides routes to list, search, and filter model and model-version details.

List models:

List<Model>models =modzyClient.getAllModels();for(Modelmodel :models ){System.out.println("Model: "+model);}

Tags help categorize and filter models. They make model browsing easier.

List tags:

List<Tag>tags =modzyClient.getTagClient().getAllTags();for(Tagtag :tags ){System.out.println("Tag: "+tag);}

List models by tag:

TagWrappertagsModels =modzyClient.getTagsAndModels("language_and_text");for(Modelmodel :tagsModels.getModels() ){System.out.println("Model: "+model);}

Models accept specificinput fileMIME types. Some models may require multiple input file types to run data accordingly. In this sample, we use a model that requirestext/plain.

Models require inputs to have a specificinput name declared in the job request. This name can be found in the model’s details. In this sample, we use a model that requiresinput.txt.

Additionally, users can set their own input names. When multiple input items are processed in a job, these names are helpful to identify and get each input’s results. In this sample, we use a model that requiresinput-1 andinput-2.

Get a model's details:

ModelsaModel =modzyClient.getModel("ed542963de");System.out.println("Model: "+saModel);

Model specific sample requests are available in the version details and in the Model Details page.

Get version details:

ModelVersionmodelVersion =modzyClient.getModelVersion("ed542963de","0.0.27");// then you'll get all the details about the specific model versionSystem.out.println(String.format("ModelVersion details properties: %s",getNotNullProperties(modelVersion)));// Probably the more interesting are the ones related with the inputs and outputs of the modelSystem.out.println("  inputs:");for(ModelInputinput :modelVersion.getInputs() ){System.out.println(String.format("    key %s, type %s, description: %s",input.getName(),input.getAcceptedMediaTypes(),input.getDescription())    );}System.out.println("  outputs:");for(ModelOutputoutput :modelVersion.getOutputs() ){System.out.println(String.format("    key %s, type %s, description: %s",output.getName(),output.getMediaType(),output.getDescription())    );}

Ajob is the process that sends data to a model, sets the model to run the data, and returns results.

Modzy supports severalinput types such astext,embedded for Base64 strings,aws-s3 andaws-s3-folder for inputs hosted in buckets, andjdbc for inputs stored in databases. In this sample, we usetext.

Here are samples to submit jobs withembedded,aws-s3,aws-s3-folder, andjdbc input types.

Submit a job with the model, version, and input items:

Jobjob =modzyClient.submitJobText("ed542963de","0.0.27","Modzy is great!");

Hold until the inference is complete and results become available:

Jobjob =modzyClient.blockUntilComplete(job,20000);

Get the results:

Results are available per input item and can be identified with the name provided for each input item upon job request. You can also add an input name to the route and limit the results to any given input item.

Jobs requested for multiple input items may have partial results available prior to job completion.

JobOutput<JsonNode>jobResult =modzyClient.getResult(job);Map<String,Map<String,JsonNode>>results =jobResult.getResults();

Errors may arise for different reasons. Fetch errors to know what is their cause and how to fix them.

Submitting jobs:

try{Map<String,JsonNode>retValue=this.modzyClient.submitJobTextBlockUntilComplete("ed542963de","Modzy is great!");}catch(ApiExceptionae){System.out.println("The job submission fails with message "+ae.getMessage());as.printStackTrace();}

Modzy supportsbatch processing,explainability, andmodel drift detection.

Here is a list of Modzy APIs. To see all the APIs, check ourDocumentation.

Check out oursamples for details on specific use cases.

To run samples:

Set the base url and api key in each sample file:

// TODO: set the base url of modzy api and you api keyModzyClientmodzyClient=newModzyClient("https://http://modzy.url","modzy-api.key");

Or follow the instructionshere to learn more.

And then, you can:

$ ./mvnw exec:java -Dexec.mainClass="com.modzy.sdk.samples.ModelSamples"

We are happy to receive contributions from all of our users. Check out ourcontributing file to learn more.