Skip to content

Commit

Permalink
docs: update description of openapi inference endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
zevisert committed Nov 27, 2023
1 parent 68c2056 commit 7c76a94
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions specification/protocol/open_inference_rest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,11 @@ paths:
schema:
$ref: '#/components/schemas/inference_request'
description: >
An inference request is made with an HTTP POST to an inference endpoint.
Send data to a model for inferencing via an [Inference Request JSON Object](#inference-request-json-object).
Compliant servers return an [Inference Response JSON Object](#inference-response-json-object) or an [Inference Response JSON Error Object](#inference-response-json-error-object).
See [Inference Request Examples](#inference-request-examples) for some example HTTP/REST requests and responses.
The model name and version must be provided in the URL.
See [Inference Request Examples](#inference-request-examples) for some example HTTP/REST requests and responses.
'/v2/models/{MODEL_NAME}/infer':
parameters:
- schema:
Expand Down Expand Up @@ -213,10 +214,11 @@ paths:
schema:
$ref: '#/components/schemas/inference_request'
description: >
An inference request is made with an HTTP POST to an inference endpoint.
Send data to a model for inferencing via an [Inference Request JSON Object](#inference-request-json-object).
Compliant servers return an [Inference Response JSON Object](#inference-response-json-object) or an [Inference Response JSON Error Object](#inference-response-json-error-object).
See [Inference Request Examples](#inference-request-examples) for some example HTTP/REST requests and responses.
The model name is provided in the URL. The server may choose a model version based on its own policies or return an error.
See [Inference Request Examples](#inference-request-examples) for some example HTTP/REST requests and responses.
components:
schemas:
metadata_server_response:
Expand Down

0 comments on commit 7c76a94

Please sign in to comment.