> For the complete documentation index, see [/llms.txt](/llms.txt).

> Source: /api/groundedness-checking

# Groundedness checking

OpenAPI spec: `./openapi/openapi-groundedness-check.yaml`

- `POST /chat/completions`

<br />

## Response

**Return values**

Returns a `chat.completion` object.

**The chat completion object**

<table><tbody><tr><td><strong>id</strong> string<br />A unique identifier assigned to the chat completion, with each segment sharing the same ID.</td></tr><tr><td><strong>object</strong> string <br />The type of object, consistently designated as `chat.completion`</td></tr><tr><td><strong>created</strong> integer<br />The creation time of the chat completion, marked by a Unix timestamp in seconds.</td></tr><tr><td><strong>model</strong> string<br />A string indicating the version of the model that was utilized for the request.</td></tr><tr><td><strong>choices</strong> list<br />An array of choices provided as chat completion outcomes.</td></tr><tr><td><strong>choices\[].index</strong> integer <br />The index of the choice in the list of choices.</td></tr><tr><td><strong>choices\[].message</strong> object <br />A chat completion message generated by the model.</td></tr><tr><td><strong>choices\[].message.role</strong> string <br />The role of the author of this message.</td></tr><tr><td><strong>choices\[].message.content</strong> string <br />The contents of the message.</td></tr><tr><td><strong>choices\[].logprobs</strong> null<br />This field is not yet available.</td></tr><tr><td><strong>choices\[].finish\_reason</strong> string<br />The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached.</td></tr><tr><td><strong>usage</strong> object<br />Usage statistics for the completion request.</td></tr><tr><td><strong>usage.completion\_tokens</strong> integer<br />Number of tokens in the generated completion.</td></tr><tr><td><strong>usage.prompt\_tokens</strong> integer<br />Number of tokens in the prompt.</td></tr><tr><td><strong>usage.total\_tokens</strong> integer<br />Total number of tokens used in the request (prompt + completion).</td></tr><tr><td><strong>system\_fingerprint</strong> null <br />This field is not yet available.</td></tr></tbody></table>

## Example

### Request

_Request/response examples: groundedness-checking / request_

### Response

_Example: groundedness-checking / response-200 / default_