Skip to content

Commit

Permalink
Add spec changes
Browse files Browse the repository at this point in the history
Co-authored-by: Michael <[email protected]>
  • Loading branch information
platform-endpoints and mkozakov committed Nov 14, 2024
1 parent 39fa33a commit 959dd36
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions cohere-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5825,12 +5825,12 @@ paths:
- STRICT
- NONE
description: |
Used to select the [safety instruction](/docs/safety-modes) inserted into the prompt. Defaults to `CONTEXTUAL`.
Used to select the [safety instruction](https://docs.cohere.com/docs/safety-modes) inserted into the prompt. Defaults to `CONTEXTUAL`.
When `NONE` is specified, the safety instruction will be omitted.

Safety modes are not yet configurable in combination with `tools`, `tool_results` and `documents` parameters.

**Note**: This parameter is only compatible with models [Command R 08-2024](/docs/command-r#august-2024-release), [Command R+ 08-2024](/docs/command-r-plus#august-2024-release) and newer.
**Note**: This parameter is only compatible with models [Command R 08-2024](https://docs.cohere.com/docs/command-r#august-2024-release), [Command R+ 08-2024](https://docs.cohere.com/docs/command-r-plus#august-2024-release) and newer.

Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments
responses:
Expand Down Expand Up @@ -7856,7 +7856,7 @@ paths:
$ref: "#/components/responses/GatewayTimeout"
description: |
<Warning>
This API is marked as "Legacy" and is no longer maintained. Follow the [migration guide](/docs/migrating-from-cogenerate-to-cochat) to start using the Chat API.
This API is marked as "Legacy" and is no longer maintained. Follow the [migration guide](https://docs.cohere.com/docs/migrating-from-cogenerate-to-cochat) to start using the Chat API.
</Warning>
Generates realistic text conditioned on a given input.
requestBody:
Expand All @@ -7882,7 +7882,7 @@ paths:
- public
description: |-
The identifier of the model to generate with. Currently available models are `command` (default), `command-nightly` (experimental), `command-light`, and `command-light-nightly` (experimental).
Smaller, "light" models are faster, while larger models will perform better. [Custom models](/docs/training-custom-models) can also be supplied with their full ID.
Smaller, "light" models are faster, while larger models will perform better. [Custom models](https://docs.cohere.com/docs/training-custom-models) can also be supplied with their full ID.
writeOnly: true
num_generations:
type: integer
Expand Down Expand Up @@ -11533,7 +11533,7 @@ paths:

Embeddings can be used to create classifiers as well as empower semantic search. To learn more about embeddings, see the embedding page.

If you want to learn more how to use the embedding model, have a look at the [Semantic Search Guide](/docs/semantic-search).
If you want to learn more how to use the embedding model, have a look at the [Semantic Search Guide](https://docs.cohere.com/docs/semantic-search).
requestBody:
content:
application/json:
Expand Down Expand Up @@ -11579,7 +11579,7 @@ paths:
description: |-
Defaults to embed-english-v2.0

The identifier of the model. Smaller "light" models are faster, while larger models will perform better. [Custom models](/docs/training-custom-models) can also be supplied with their full ID.
The identifier of the model. Smaller "light" models are faster, while larger models will perform better. [Custom models](https://docs.cohere.com/docs/training-custom-models) can also be supplied with their full ID.

Available models and corresponding embedding dimensions:

Expand Down Expand Up @@ -15127,7 +15127,7 @@ paths:

Embeddings can be used to create text classifiers as well as empower semantic search. To learn more about embeddings, see the embedding page.

If you want to learn more how to use the embedding model, have a look at the [Semantic Search Guide](/docs/semantic-search).
If you want to learn more how to use the embedding model, have a look at the [Semantic Search Guide](https://docs.cohere.com/docs/semantic-search).
requestBody:
content:
application/json:
Expand Down Expand Up @@ -15177,7 +15177,7 @@ paths:
description: |-
Defaults to embed-english-v2.0

The identifier of the model. Smaller "light" models are faster, while larger models will perform better. [Custom models](/docs/training-custom-models) can also be supplied with their full ID.
The identifier of the model. Smaller "light" models are faster, while larger models will perform better. [Custom models](https://docs.cohere.com/docs/training-custom-models) can also be supplied with their full ID.

Available models and corresponding embedding dimensions:

Expand Down Expand Up @@ -18446,7 +18446,7 @@ paths:
$ref: "#/components/responses/GatewayTimeout"
description: |
<Warning>
This API is marked as "Legacy" and is no longer maintained. Follow the [migration guide](/docs/migrating-from-cogenerate-to-cochat) to start using the Chat API.
This API is marked as "Legacy" and is no longer maintained. Follow the [migration guide](https://docs.cohere.com/docs/migrating-from-cogenerate-to-cochat) to start using the Chat API.
</Warning>
Generates a summary in English for a given text.
requestBody:
Expand Down Expand Up @@ -21952,7 +21952,7 @@ components:
schema:
x-fern-availability: beta
description: |
A JSON schema object that the output will adhere to. There are some restrictions we have on the schema, refer to [our guide](/docs/structured-outputs-json#schema-constraints) for more information.
A JSON schema object that the output will adhere to. There are some restrictions we have on the schema, refer to [our guide](https://docs.cohere.com/docs/structured-outputs-json#schema-constraints) for more information.
Example (required name and age object):
```json
{
Expand Down Expand Up @@ -22821,7 +22821,7 @@ components:
$ref: "#/components/schemas/ResponseFormatTypeV2"
json_schema:
description: |
A [JSON schema](https://json-schema.org/overview/what-is-jsonschema) object that the output will adhere to. There are some restrictions we have on the schema, refer to [our guide](/docs/structured-outputs-json#schema-constraints) for more information.
A [JSON schema](https://json-schema.org/overview/what-is-jsonschema) object that the output will adhere to. There are some restrictions we have on the schema, refer to [our guide](https://docs.cohere.com/docs/structured-outputs-json#schema-constraints) for more information.
Example (required name and age object):
```json
{
Expand Down Expand Up @@ -23207,9 +23207,10 @@ components:
`ALL`. The likelihood refers to the average log-likelihood of the
entire specified string, which is useful for [evaluating the
performance of your model](likelihood-eval), especially if you've
created a [custom model](/docs/training-custom-models). Individual
token likelihoods provide the log-likelihood of each token. The
first token will not have a likelihood.
created a [custom
model](https://docs.cohere.com/docs/training-custom-models).
Individual token likelihoods provide the log-likelihood of each
token. The first token will not have a likelihood.
items:
type: object
x-fern-audiences:
Expand Down

0 comments on commit 959dd36

Please sign in to comment.