Skip to content

Commit 075e86a

Browse files
Merge pull request #13 from modzy/update/links_for_new_Docs_site
updating links
2 parents af203c8 + d95a07a commit 075e86a

File tree

2 files changed

+32
-32
lines changed

2 files changed

+32
-32
lines changed

README.md

+31-31
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
![GitHub Release Date](https://img.shields.io/github/issues-raw/modzy/sdk-java)
1313

1414

15-
[The job lifecycle](https://models.modzy.com/docs/how-to-guides/job-lifecycle) | [API Keys](https://models.modzy.com/docs/how-to-guides/api-keys) | [Samples](https://github.com/modzy/sdk-java/tree/main/samples) | [Documentation](https://models.modzy.com/docs)
15+
[The job lifecycle](https://docs.modzy.com/reference/the-job-lifecycle) | [API Keys](https://docs.modzy.com/reference/api-keys-1) | [Samples](https://github.com/modzy/sdk-java/tree/main/samples) | [Documentation](https://docs.modzy.com/docs)
1616

1717
</div>
1818

@@ -47,7 +47,7 @@ API keys are security credentials required to perform API requests to Modzy. Our
4747

4848
The *public* part is the API keys' visible part only used to identify the key and by itself, it’s unable to perform API requests.
4949

50-
The *private* 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 can [replace the API key](https://models.modzy.com/docs/users-keys/api-keys/replace-API-key).
50+
The *private* 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 can [replace the API key](https://docs.modzy.com/reference/update-a-keys-body).
5151

5252

5353
Find your API key in your user profile. To get your full API key click on "Get key":
@@ -74,7 +74,7 @@ Modzy’s Marketplace includes pre-trained and re-trainable AI models from indus
7474

7575
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.
7676

77-
[List models](https://models.modzy.com/docs/marketplace/models/retrieve-models)
77+
[List models](https://docs.modzy.com/reference/list-models):
7878

7979
```java
8080
List<Model> models = modzyClient.getAllModels();
@@ -85,16 +85,16 @@ for( Model model : models ){
8585

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

88-
[List tags](https://models.modzy.com/docs/marketplace/tags/retrieve-tags):
88+
[List tags](https://docs.modzy.com/reference/list-tags):
8989

9090
```java
9191
List<Tag> tags = modzyClient.getTagClient().getAllTags();
9292
for( Tag tag : tags ){
93-
System.out.println("Tag: "+tag);
93+
System.out.println("Tag: "+tag);
9494
}
9595
```
9696

97-
[List models by tag](https://models.modzy.com/docs/marketplace/tags/retrieve-models-by-tags):
97+
[List models by tag](https://docs.modzy.com/reference/list-models-by-tag):
9898

9999
```java
100100
TagWrapper tagsModels = modzyClient.getTagsAndModels("language_and_text");
@@ -111,7 +111,7 @@ Models require inputs to have a specific *input name* declared in the job reques
111111

112112
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 requires `input-1` and `input-2`.
113113

114-
[Get a model's details](https://models.modzy.com/docs/marketplace/models/retrieve-model-details):
114+
[Get a model's details](https://docs.modzy.com/reference/list-model-details):
115115

116116
```java
117117
Model saModel = modzyClient.getModel("ed542963de");
@@ -120,7 +120,7 @@ System.out.println("Model: "+saModel);
120120

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

123-
[Get version details](https://models.modzy.com/docs/marketplace/versions/retrieve-version-details):
123+
[Get version details](https://docs.modzy.com/reference/get-version-details):
124124

125125
```java
126126
ModelVersion modelVersion = modzyClient.getModelVersion("ed542963de", "0.0.27");
@@ -149,19 +149,19 @@ Modzy supports several *input types* such as `text`, `embedded` for Base64 strin
149149

150150
[Here](https://github.com/modzy/sdk-java/blob/readmeUpdates/samples.adoc) are samples to submit jobs with `embedded`, `aws-s3`, `aws-s3-folder`, and `jdbc` input types.
151151

152-
[Submit a job with the model, version, and input items](https://models.modzy.com/docs/jobs/jobs/submit-job-text):
152+
[Submit a job with the model, version, and input items](https://docs.modzy.com/reference/create-a-job-1):
153153

154154
```java
155155
Job job = modzyClient.submitJobText("ed542963de", "0.0.27", "Modzy is great!");
156156
```
157157

158-
[Hold until the inference is complete and results become available](https://models.modzy.com/docs/jobs/jobs/retrieve-job-details):
158+
[Hold until the inference is complete and results become available](https://docs.modzy.com/reference/get-job-details):
159159

160160
```java
161161
Job job = modzyClient.blockUntilComplete(job, 20000);
162162
```
163163

164-
[Get the results](https://models.modzy.com/docs/jobs/results/retrieve-results):
164+
[Get the results](https://docs.modzy.com/reference/get-results):
165165

166166
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.
167167

@@ -195,33 +195,33 @@ catch(ApiException ae){
195195

196196
## Features
197197

198-
Modzy supports [batch processing](https://models.modzy.com/docs/features/batch-processing), [explainability](https://models.modzy.com/docs/features/explainability), and [model drift detection](https://models.modzy.com/docs/features/model-drift).
198+
Modzy supports [batch processing](https://docs.modzy.com/reference/batch-processing), [explainability](https://docs.modzy.com/reference/explainability), and [model drift detection](https://docs.modzy.com/reference/model-drift-1).
199199

200200
## APIs
201201

202-
Here is a list of Modzy APIs. To see all the APIs, check our [Documentation](https://models.modzy.com/docs/home/home).
202+
Here is a list of Modzy APIs. To see all the APIs, check our [Documentation](https://docs.modzy.com/reference/introduction).
203203

204204

205205
| Feature | Code |Api route
206206
| --- | --- | ---
207-
|Get all models|modzyClient.getAllModels()|[api/models](https://models.modzy.com/docs/marketplace/models/retrieve-all-models-versions)|
208-
|List models|modzyClient.getModels()|[api/models](https://models.modzy.com/docs/marketplace/models/retrieve-models)|
209-
|Get model details|modzyClient.getModel()|[api/models/:model-id](https://models.modzy.com/docs/marketplace/models/retrieve-model-details)|
210-
|List models by name|modzyClient.getModelByName()|[api/models](https://models.modzy.com/docs/marketplace/models/retrieve-models)|
211-
|List models by tags|modzyClient.getTagsAndModels()|[api/models/tags/:tag-id](https://models.modzy.com/docs/marketplace/tags/retrieve-models-by-tags) |
212-
|Get related models|modzyClient.getRelatedModels()|[api/models/:model-id/related-models](https://models.modzy.com/docs/marketplace/models/retrieve-related-models)|
213-
|Get a model's versions|modzyClient.getModelVersions()|[api/models/:model-id/versions](https://models.modzy.com/docs/marketplace/versions/retrieve-versions)|
214-
|Get version details|modzyClient.getModelVersions()|[api/models/:model-id/versions/:version-id](https://models.modzy.com/docs/marketplace/versions/retrieve-version-details)|
215-
|List tags|modzyClient.getAllTags()|[api/models/tags](https://models.modzy.com/docs/marketplace/tags/retrieve-tags)|
216-
|Submit a Job (Text)|modzyClient.submitJobText()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-text)|
217-
|Submit a Job (Embedded)|modzyClient.submitJobEmbedded()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-embedded)|
218-
|Submit a Job (AWS S3)|modzyClient.submitJobAWSS3()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-aws)|
219-
|Submit a Job (JDBC)|modzyClient.submitJobJDBC()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-jdbc)|
220-
|Cancel a job|modzyClient.cancelJob()|[api/jobs/:job-id](https://models.modzy.com/docs/jobs/jobs/cancel-pending-job) |
221-
|Hold until inference is complete|modzyClient.blockUntilComplete()|[api/jobs/:job-id](https://models.modzy.com/docs/jobs/jobs/retrieve-job-details) |
222-
|Get job details|modzyClient.getJob()|[api/jobs/:job-id](https://models.modzy.com/docs/jobs/jobs/retrieve-job-details) |
223-
|Get results|modzyClient.getResults()|[api/results/:job-id](https://models.modzy.com/docs/jobs/results/retrieve-results) |
224-
|Get the job history|modzyClient.getJobHistory()|[api/jobs/history](https://models.modzy.com/docs/jobs/job-history/retrieve-job-history) |
207+
|Get all models|modzyClient.getAllModels()|[api/models](https://docs.modzy.com/reference/get-all-models)|
208+
|List models|modzyClient.getModels()|[api/models](https://docs.modzy.com/reference/list-models)|
209+
|Get model details|modzyClient.getModel()|[api/models/:model-id](https://docs.modzy.com/reference/list-model-details)|
210+
|List models by name|modzyClient.getModelByName()|[api/models](https://docs.modzy.com/reference/list-models)|
211+
|List models by tags|modzyClient.getTagsAndModels()|[api/models/tags/:tag-id](https://docs.modzy.com/reference/list-models-by-tag) |
212+
|Get related models|modzyClient.getRelatedModels()|[api/models/:model-id/related-models](https://docs.modzy.com/reference/get-related-models)|
213+
|Get a model's versions|modzyClient.getModelVersions()|[api/models/:model-id/versions](https://docs.modzy.com/reference/list-versions)|
214+
|Get version details|modzyClient.getModelVersions()|[api/models/:model-id/versions/:version-id](https://docs.modzy.com/reference/get-version-details)|
215+
|List tags|modzyClient.getAllTags()|[api/models/tags](https://docs.modzy.com/reference/list-tags)|
216+
|Submit a Job (Text)|modzyClient.submitJobText()|[api/jobs](https://docs.modzy.com/reference/create-a-job-1)|
217+
|Submit a Job (Embedded)|modzyClient.submitJobEmbedded()|[api/jobs](https://docs.modzy.com/reference/create-a-job-1)|
218+
|Submit a Job (AWS S3)|modzyClient.submitJobAWSS3()|[api/jobs](https://docs.modzy.com/reference/create-a-job-1)|
219+
|Submit a Job (JDBC)|modzyClient.submitJobJDBC()|[api/jobs](https://docs.modzy.com/reference/create-a-job-1)|
220+
|Cancel a job|modzyClient.cancelJob()|[api/jobs/:job-id](https://docs.modzy.com/reference/cancel-a-job) |
221+
|Hold until inference is complete|modzyClient.blockUntilComplete()|[api/jobs/:job-id](https://docs.modzy.com/reference/get-job-details) |
222+
|Get job details|modzyClient.getJob()|[api/jobs/:job-id](https://docs.modzy.com/reference/get-job-details) |
223+
|Get results|modzyClient.getResults()|[api/results/:job-id](https://docs.modzy.com/reference/get-results) |
224+
|List the job history|modzyClient.getJobHistory()|[api/jobs/history](https://docs.modzy.com/reference/list-the-job-history) |
225225

226226
## Samples
227227

contributing.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
3939
<div align="center">
4040
<a href="/README.adoc" style="text-decoration:none">Readme</a> |
41-
<a href=https://models.modzy.com/docs/home/home style="text-decoration:none">Documentation</a>
41+
<a href=https://docs.modzy.com/docs style="text-decoration:none">Documentation</a>
4242
4343
</div>
4444

0 commit comments

Comments
 (0)