Skip to content

Commit dced85d

Browse files
committed
updating links
1 parent 1fa302c commit dced85d

File tree

2 files changed

+31
-32
lines changed

2 files changed

+31
-32
lines changed

README.md

+30-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-javascript)
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-javascript/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-javascript/tree/main/samples) | [Documentation](https://docs.modzy.com/docs)
1616

1717
</div>
1818

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

5353
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.
5454

55-
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).
55+
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).
5656

5757

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

7979
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.
8080

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

8383
```javascript
8484
const models = await modzyClient.getAllModels();
@@ -91,7 +91,7 @@ models.forEach(
9191

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

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

9696
```javascript
9797
const tags = await modzyClient.getAllTags();
@@ -102,7 +102,7 @@ tags.forEach(
102102
);
103103
```
104104

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

107107
```javascript
108108
const tagsModels = await modzyClient.getTagsAndModels("language_and_text");
@@ -121,7 +121,7 @@ Models require inputs to have a specific *input name* declared in the job reques
121121

122122
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`.
123123

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

126126
```javascript
127127
const saModel = await modzyClient.getModel("ed542963de");
@@ -130,7 +130,7 @@ console.log(JSON.stringify(saModel));
130130

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

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

135135
```javascript
136136
let modelVersion = await modzyClient.getModelVersion("ed542963de", "0.0.27");
@@ -154,7 +154,7 @@ Modzy supports several *input types* such as `text`, `embedded` for Base64 strin
154154

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

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

159159
```javascript
160160
let job = await modzyClient.submitJobText(
@@ -167,13 +167,13 @@ let job = await modzyClient.submitJobText(
167167
);
168168
```
169169

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

172172
```javascript
173173
job = await modzyClient.blockUntilComplete(job);
174174
```
175175

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

178178
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.
179179

@@ -204,33 +204,33 @@ try{
204204

205205
## Features
206206

207-
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).
207+
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).
208208

209209
## APIs
210210

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

213213

214214
| Feature | Code |Api route
215215
| --- | --- | ---
216-
|Get all models|modzyClient.getAllModels()|[api/models](https://models.modzy.com/docs/marketplace/models/retrieve-all-models-versions)|
217-
|List models|modzyClient.getModels()|[api/models](https://models.modzy.com/docs/marketplace/models/retrieve-models)|
218-
|Get model details|modzyClient.getModel()|[api/models/:model-id](https://models.modzy.com/docs/marketplace/models/retrieve-model-details)|
219-
|List models by name|modzyClient.getModelByName()|[api/models](https://models.modzy.com/docs/marketplace/models/retrieve-models)|
220-
|List models by tag|modzyClient.getAllTags()|[api/models/tags](https://models.modzy.com/docs/marketplace/tags/retrieve-models-by-tags)|
221-
|Get related models|modzyClient.getRelatedModels()|[api/models/:model-id/related-models](https://models.modzy.com/docs/marketplace/models/retrieve-related-models)|
222-
|Get a model's versions|modzyClient.getModelClient().getModelVersions()|[api/models/:model-id/versions](https://models.modzy.com/docs/marketplace/versions/retrieve-versions)|
223-
|Get version details|modzyClient.getModelVersion()|[api/models/:model-id/versions/:version-id](https://models.modzy.com/docs/marketplace/versions/retrieve-version-details)|
224-
|List tags|modzyClient.getAllTags()|[api/models/tags](https://models.modzy.com/docs/marketplace/tags/retrieve-tags)|
225-
|Submit a Job (Text)|modzyClient.submitJobText()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-text)|
226-
|Submit a Job (Embedded)|modzyClient.submitJobEmbedded()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-embedded)|
227-
|Submit a Job (AWS S3)|modzyClient.submitJobAWSS3()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-aws)|
228-
|Submit a Job (JDBC)|modzyClient.submitJobJDBC()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-jdbc)|
229-
|Cancel a job|modzyClient.cancelJob()|[api/jobs/:job-id](https://models.modzy.com/docs/jobs/jobs/cancel-pending-job) |
230-
|Hold until inference is complete|modzyClient.blockUntilComplete()|[api/jobs/:job-id](https://models.modzy.com/docs/jobs/job-history/retrieve-job-history-details) |
231-
|Get job details|modzyClient.getJob()|[api/jobs/:job-id](https://models.modzy.com/docs/jobs/job-history/retrieve-job-history-details) |
232-
|Get results|modzyClient.getResults()|[api/results/:job-id](https://models.modzy.com/docs/jobs/results/retrieve-results) |
233-
|Get the job history|modzyClient.getJobHistory()|[api/jobs/history](https://models.modzy.com/docs/jobs/job-history/retrieve-job-history) |
216+
|Get all models|modzyClient.getAllModels()|[api/models](https://docs.modzy.com/reference/get-all-models)|
217+
|List models|modzyClient.getModels()|[api/models](https://docs.modzy.com/reference/list-models)|
218+
|Get model details|modzyClient.getModel()|[api/models/:model-id](https://docs.modzy.com/reference/list-model-details)|
219+
|List models by name|modzyClient.getModelByName()|[api/models](https://docs.modzy.com/reference/list-models)|
220+
|List models by tag|modzyClient.getAllTags()|[api/models/tags](https://docs.modzy.com/reference/list-models-by-tag)|
221+
|Get related models|modzyClient.getRelatedModels()|[api/models/:model-id/related-models](https://docs.modzy.com/reference/get-related-models)|
222+
|Get a model's versions|modzyClient.getModelClient().getModelVersions()|[api/models/:model-id/versions](https://docs.modzy.com/reference/list-versions)|
223+
|Get version details|modzyClient.getModelVersion()|[api/models/:model-id/versions/:version-id](https://docs.modzy.com/reference/get-version-details)|
224+
|List tags|modzyClient.getAllTags()|[api/models/tags](https://docs.modzy.com/reference/list-tags)|
225+
|Submit a Job (Text)|modzyClient.submitJobText()|[api/jobs](https://docs.modzy.com/reference/create-a-job-1)|
226+
|Submit a Job (Embedded)|modzyClient.submitJobEmbedded()|[api/jobs](https://docs.modzy.com/reference/create-a-job-1)|
227+
|Submit a Job (AWS S3)|modzyClient.submitJobAWSS3()|[api/jobs](https://docs.modzy.com/reference/create-a-job-1)|
228+
|Submit a Job (JDBC)|modzyClient.submitJobJDBC()|[api/jobs](https://docs.modzy.com/reference/create-a-job-1)|
229+
|Cancel a job|modzyClient.cancelJob()|[api/jobs/:job-id](https://docs.modzy.com/reference/cancel-a-job) |
230+
|Hold until inference is complete|modzyClient.blockUntilComplete()|[api/jobs/:job-id](https://docs.modzy.com/reference/get-job-details) |
231+
|Get job details|modzyClient.getJob()|[api/jobs/:job-id](https://docs.modzy.com/reference/get-job-details) |
232+
|Get results|modzyClient.getResults()|[api/results/:job-id](https://docs.modzy.com/reference/get-results) |
233+
|List the job history|modzyClient.getJobHistory()|[api/jobs/history](https://docs.modzy.com/reference/list-the-job-history) |
234234

235235
## Samples
236236

@@ -260,4 +260,3 @@ We are happy to receive contributions from all of our users. Check out our [cont
260260

261261

262262
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](https://github.com/modzy/sdk-javascript/tree/main//CODE_OF_CONDUCT.md)
263-

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.md" 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)