Skip to content

Commit 1d86cbf

Browse files
Merge pull request #9 from modzy/readmeUpdates
readme
2 parents dc3d307 + 0270174 commit 1d86cbf

File tree

1 file changed

+36
-35
lines changed

1 file changed

+36
-35
lines changed

README.adoc

+36-35
Original file line numberDiff line numberDiff line change
@@ -209,77 +209,78 @@ Currently we support the following api routes:
209209
|===
210210
|Feature|Code|Api route
211211

212-
|[small]#Retrieve all models#
212+
|[small]#Get all models#
213213
|[small]#modzyClient.getAllModels()#
214-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models[api/models]#
214+
|[small]#link:{doc-pages}marketplace/models/retrieve-all-models-versions[/api/models/all/versions/all]#
215215

216-
|[small]#Retrieve some models#
216+
|[small]#List some models#
217217
|[small]#modzyClient.getModels()#
218-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models[api/models]#
218+
|[small]#link:{doc-pages}marketplace/models/retrieve-models[/api/models]#
219219

220-
|[small]#Retrieve model details#
220+
|[small]#Get model details#
221221
|[small]#modzyClient.getModel()#
222-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-model-details[api/models/:model-id]#
222+
|[small]#link:{doc-pages}marketplace/models/retrieve-model-details[/api/models/:modelId]#
223223

224-
|[small]#Retrieve model by name#
224+
|[small]#Search models by name#
225225
|[small]#modzyClient.getModelByName()#
226-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models[api/models]#
226+
|[small]#link:{doc-pages}marketplace/models/search-model-details[/api/models/search]#
227227

228-
|[small]#Retrieve related models#
228+
|[small]#Get related models#
229229
|[small]#modzyClient.getRelatedModels()#
230-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-related-models[api/models/:model-id/related-models]#
230+
|[small]#link:{doc-pages}marketplace/models/retrieve-related-models[/api/models/:modelId/related-models]#
231231

232-
|[small]#Retrieve model versions#
232+
|[small]#List model versions#
233233
|[small]#modzyClient.getModelVersions()#
234-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-related-models[api/models/:model-id/versions]#
234+
|[small]#link:{doc-pages}marketplace/versions/retrieve-versions[/api/models/:modelId/versions]#
235235

236-
|[small]#Retrieve model version details#
236+
|[small]#Get version details#
237237
|[small]#modzyClient.getModelVersion()#
238-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-related-models[api/models/:model-id/versions/:version-id]#
238+
|[small]#link:{doc-pages}marketplace/versions/retrieve-version-details[/api/models/:modelId/versions/:version]#
239239

240-
|[small]#Retrieve all tags#
240+
|[small]#List tags#
241241
|[small]#modzyClient.getAllTags()#
242-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-tags[api/models/tags]#
242+
|[small]#link:{doc-pages}marketplace/tags/retrieve-tags[/api/models/tags]#
243243

244-
|[small]#Retrieve Tags and Models#
244+
|[small]#Get models by tags#
245245
|[small]#modzyClient.getTagsAndModels()#
246-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models-by-tags[api/models/tags/:tag-id]#
246+
|[small]#link:{doc-pages}marketplace/tags/retrieve-models-by-tags[/api/models/tags/:tagId]#
247247

248-
|[small]#Submit a Job (Text)#
248+
|[small]#Create a Job (Text)#
249249
|[small]#modzyClient.submitJobText()#
250-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
250+
|[small]#link:{doc-pages}jobs/jobs/submit-job-text[/api/jobs]#
251251

252-
|[small]#Submit a Job (Embedded)#
252+
|[small]#Create a Job (Embedded)#
253253
|[small]#modzyClient.submitJobEmbedded()#
254-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
254+
|[small]#link:{doc-pages}jobs/jobs/submit-job-embedded[/api/jobs]#
255255

256-
|[small]#Submit a Job (AWS S3)#
256+
|[small]#Create a Job (AWS S3)#
257257
|[small]#modzyClient.submitJobAWSS3()#
258-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
258+
|[small]#link:{doc-pages}jobs/jobs/submit-job-aws[/api/jobs]#
259259

260-
|[small]#Submit a Job (JDBC)#
260+
|[small]#Create a Job (JDBC)#
261261
|[small]#modzyClient.submitJobJDBC()#
262-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
262+
|[small]#link:{doc-pages}jobs/jobs/submit-job-jdbc[/api/jobs]#
263263

264-
|[small]#Cancel job#
264+
|[small]#Cancel a job#
265265
|[small]#modzyClient.cancelJob()#
266-
|[small]#link:{doc-pages}api-reference/jobs/cancel-pending-job[api/jobs/:job-id]#
266+
|[small]#link:{doc-pages}jobs/jobs/cancel-pending-job[/api/jobs/:jobId]#
267267

268268
|[small]#Hold until inference is complete#
269269
|[small]#modzyClient.blockUntilComplete()#
270-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
270+
|[small]#link:{doc-pages}jobs/jobs/submit-job-text[/api/jobs]#
271271

272-
|[small]#Get Job details#
272+
|[small]#Get job details#
273273
|[small]#modzyClient.getJob()#
274-
|[small]#link:{doc-pages}api-reference/jobs/retrieve-job-details[api/jobs/:job-id]#
274+
|[small]#link:{doc-pages}jobs/jobs/retrieve-job-details[/api/jobs/:jobId]#
275275

276-
|[small]#Retrieve results#
276+
|[small]#Get results#
277277
|[small]#modzyClient.cancelJob()#
278-
|[small]#link:{doc-pages}api-reference/jobs/cancel-pending-job[api/jobs/:job-id]#
278+
|[small]#link:{doc-pages}jobs/results/retrieve-results[/api/results/:jobId]#
279279

280-
|[small]#Retrieve Job History#
280+
|[small]#List the job history#
281281
|[small]#modzyClient.getJobHistory()#
282-
|[small]#link:{doc-pages}api-reference/jobs/retrieve-job-history[api/jobs/history]#
282+
|[small]#link:{doc-pages}jobs/job-history/retrieve-job-history[/api/jobs/history]#
283+
283284

284285
|===
285286

0 commit comments

Comments
 (0)