You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -52,7 +52,7 @@ API keys are security credentials required to perform API requests to Modzy. Our
52
52
53
53
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.
54
54
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).
56
56
57
57
58
58
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
78
78
79
79
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.
@@ -121,7 +121,7 @@ Models require inputs to have a specific *input name* declared in the job reques
121
121
122
122
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`.
123
123
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):
Model specific sample requests are available in the version details and in the Model Details page.
132
132
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):
134
134
135
135
```javascript
136
136
let modelVersion =awaitmodzyClient.getModelVersion("ed542963de", "0.0.27");
@@ -154,7 +154,7 @@ Modzy supports several *input types* such as `text`, `embedded` for Base64 strin
154
154
155
155
[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.
156
156
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):
158
158
159
159
```javascript
160
160
let job =awaitmodzyClient.submitJobText(
@@ -167,13 +167,13 @@ let job = await modzyClient.submitJobText(
167
167
);
168
168
```
169
169
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):
171
171
172
172
```javascript
173
173
job =awaitmodzyClient.blockUntilComplete(job);
174
174
```
175
175
176
-
[Get the results](https://models.modzy.com/docs/jobs/results/retrieve-results):
176
+
[Get the results](https://docs.modzy.com/reference/get-results):
177
177
178
178
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.
179
179
@@ -204,33 +204,33 @@ try{
204
204
205
205
## Features
206
206
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).
208
208
209
209
## APIs
210
210
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).
212
212
213
213
214
214
| Feature | Code |Api route
215
215
| --- | --- | ---
216
-
|Get all models|modzyClient.getAllModels()|[api/models](https://models.modzy.com/docs/marketplace/models/retrieve-all-models-versions)|
|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)|
|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)|
|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)|
0 commit comments