Skip to content

Commit ebcc6e4

Browse files
authored
readme updates (#10)
* readme * caps
1 parent 6a99e03 commit ebcc6e4

File tree

1 file changed

+45
-45
lines changed

1 file changed

+45
-45
lines changed

README.adoc

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -213,97 +213,97 @@ Currently we support the following api routes:
213213
|===
214214
|Feature|Code|Api route
215215

216-
|[small]#Retrieve all models#
216+
|[small]#Get all models#
217217
|[small]#client.models.get_all()#
218-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models[api/models]#
218+
|[small]#link:{doc-pages}marketplace/models/retrieve-all-models-versions[/api/models/all/versions/all]#
219219

220-
|[small]#Retrieve some models#
220+
|[small]#List some models#
221221
|[small]#client.models.get_models()#
222-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models[api/models]#
222+
|[small]#link:{doc-pages}marketplace/models/retrieve-models[/api/models]#
223223

224-
|[small]#Retrieve model details#
224+
|[small]#Get model details#
225225
|[small]#client.models.get()#
226-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-model-details[api/models/:model-id]#
226+
|[small]#link:{doc-pages}marketplace/models/retrieve-model-details[/api/models/:modelId]#
227227

228-
|[small]#Retrieve model by name#
228+
|[small]#Search models by name#
229229
|[small]#client.models.get_by_name()#
230-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models[api/models]#
230+
|[small]#link:{doc-pages}marketplace/models/search-model-details[/api/models/search]#
231231

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

236-
|[small]#Retrieve model versions#
236+
|[small]#List model versions#
237237
|[small]#client.models.get_versions()#
238-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-versions[api/models/:model-id/versions]#
238+
|[small]#link:{doc-pages}marketplace/versions/retrieve-versions[/api/models/:modelId/versions]#
239239

240-
|[small]#Retrieve model version details#
240+
|[small]#Get version details#
241241
|[small]#client.models.get_version()#
242-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-version-details[api/models/:model-id/versions/:version-id]#
242+
|[small]#link:{doc-pages}marketplace/versions/retrieve-version-details[/api/models/:modelId/versions/:version]#
243243

244-
|[small]#Retrieve all tags#
244+
|[small]#List tags#
245245
|[small]#client.tags.get_all()#
246-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-tags[api/models/tags]#
246+
|[small]#link:{doc-pages}marketplace/tags/retrieve-tags[/api/models/tags]#
247247

248-
|[small]#Retrieve Tags and Models#
248+
|[small]#Get models by tags#
249249
|[small]#client.tags.get_tags_and_models()#
250-
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models-by-tags[api/models/tags/:tag-id]#
250+
|[small]#link:{doc-pages}marketplace/tags/retrieve-models-by-tags[/api/models/tags/:tagId]#
251251

252-
|[small]#Submit a Job (Single Text)#
252+
|[small]#Create a job (single text)#
253253
|[small]#client.jobs.submit_text()#
254-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
254+
|[small]#link:{doc-pages}jobs/jobs/submit-job-text[/api/jobs]#
255255

256-
|[small]#Submit a Job (Multiple Text)#
256+
|[small]#Create a job (multiple text)#
257257
|[small]#client.jobs.submit_text_bulk()#
258-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
258+
|[small]#link:{doc-pages}jobs/jobs/submit-job-text[/api/jobs]#
259259

260-
|[small]#Submit a Job (Single Embedded)#
260+
|[small]#Create a job (single embedded)#
261261
|[small]#client.jobs.submit_bytes()#
262-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
262+
|[small]#link:{doc-pages}jobs/jobs/submit-job-embedded[/api/jobs]#
263263

264-
|[small]#Submit a Job (Multiple Embedded)#
264+
|[small]#Create a job (multiple embedded)#
265265
|[small]#client.jobs.submit_bytes_bulk()#
266-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
266+
|[small]#link:{doc-pages}jobs/jobs/submit-job-embedded[/api/jobs]#
267267

268-
|[small]#Submit a Job (Single File)#
268+
|[small]#Create a job (single file)#
269269
|[small]#client.jobs.submit_files()#
270-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
270+
|[small]#link:{doc-pages}jobs/jobs/submit-job-embedded[/api/jobs]#
271271

272-
|[small]#Submit a Job (Multiple Files)#
272+
|[small]#Create a job (multiple files)#
273273
|[small]#client.jobs.submit_files_bulk()#
274-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
274+
|[small]#link:{doc-pages}jobs/jobs/submit-job-embedded[/api/jobs]#
275275

276-
|[small]#Submit a Job (Single AWS S3)#
276+
|[small]#Create a job (single AWS S3)#
277277
|[small]#client.jobs.submit_aws_s3()#
278-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
278+
|[small]#link:{doc-pages}jobs/jobs/submit-job-aws[/api/jobs]#
279279

280-
|[small]#Submit a Job (Multiple AWS S3)#
280+
|[small]#Create a job (multiple AWS S3)#
281281
|[small]#client.jobs.submit_aws_s3_bulk()#
282-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
282+
|[small]#link:{doc-pages}jobs/jobs/submit-job-aws[/api/jobs]#
283283

284-
|[small]#Submit a Job (JDBC)#
284+
|[small]#Create a job (JDBC)#
285285
|[small]#client.jobs.submit_jdbc()#
286-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
286+
|[small]#link:{doc-pages}jobs/jobs/submit-job-jdbc[/api/jobs]#
287287

288-
|[small]#Cancel job#
288+
|[small]#Cancel a job#
289289
|[small]#job.cancel()#
290-
|[small]#link:{doc-pages}api-reference/jobs/cancel-pending-job[api/jobs/:job-id]#
290+
|[small]#link:{doc-pages}jobs/jobs/cancel-pending-job[/api/jobs/:jobId]#
291291

292292
|[small]#Hold until inference is complete#
293293
|[small]#job.block_until_complete()#
294-
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
294+
|[small]#link:{doc-pages}jobs/jobs/submit-job-text[/api/jobs]#
295295

296-
|[small]#Get Job details#
296+
|[small]#Get job details#
297297
|[small]#client.jobs.get()#
298-
|[small]#link:{doc-pages}api-reference/jobs/retrieve-job-details[api/jobs/:job-id]#
298+
|[small]#link:{doc-pages}jobs/jobs/retrieve-job-details[/api/jobs/:jobId]#
299299

300-
|[small]#Retrieve results#
300+
|[small]#Get results#
301301
|[small]#job.get_result()#
302-
|[small]#link:{doc-pages}api-reference/jobs/cancel-pending-job[api/jobs/:job-id]#
302+
|[small]#link:{doc-pages}jobs/results/retrieve-results[/api/results/:jobId]#
303303

304-
|[small]#Retrieve Job History#
304+
|[small]#List the job history#
305305
|[small]#client.jobs.get_history()#
306-
|[small]#link:{doc-pages}api-reference/jobs/retrieve-job-history[api/jobs/history]#
306+
|[small]#link:{doc-pages}jobs/job-history/retrieve-job-history[/api/jobs/history]#
307307

308308
|===
309309

0 commit comments

Comments
 (0)