Skip to content

Commit

Permalink
Add spec changes
Browse files Browse the repository at this point in the history
Co-authored-by: billytrend-cohere <[email protected]>
  • Loading branch information
platform-endpoints and billytrend-cohere committed Oct 28, 2024
1 parent 9e252c0 commit 06f4ad7
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion cohere-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ paths:
summary: Chat
operationId: chat
x-fern-streaming:
stream-description: |
Generates a streamed text response to a user message.

To learn how to use the Chat API and RAG follow our [Text Generation guides](https://docs.cohere.com/docs/chat-api).
stream-condition: $request.stream
response:
required:
Expand Down Expand Up @@ -5876,6 +5880,10 @@ paths:
x-fern-streaming:
format: sse
stream-condition: $request.stream
stream-description: |
Generates a text response to a user message. To learn how to use the Chat API and RAG follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).

Follow the [Migration Guide](https://docs.cohere.com/v2/docs/migrating-v1-to-v2) for instructions on moving from API v1 to API v2.
response:
required:
- id
Expand Down Expand Up @@ -5920,7 +5928,7 @@ paths:
citation-end: "#/components/schemas/CitationEndEvent"
message-end: "#/components/schemas/ChatMessageEndEvent"
description: |
Generates a message from the model in response to a provided conversation. To learn more about the features of the Chat API follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
Generates a text response to a user message and streams it down, token by token. To learn how to use the Chat API with streaming follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).

Follow the [Migration Guide](https://docs.cohere.com/v2/docs/migrating-v1-to-v2) for instructions on moving from API v1 to API v2.
parameters:
Expand Down

0 comments on commit 06f4ad7

Please sign in to comment.