From 06f4ad797781f6d8d316f26080acd415c03de496 Mon Sep 17 00:00:00 2001 From: platform-endpoints Date: Mon, 28 Oct 2024 16:56:37 +0000 Subject: [PATCH] Add spec changes Co-authored-by: billytrend-cohere <144115527+billytrend-cohere@users.noreply.github.com> --- cohere-openapi.yaml | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/cohere-openapi.yaml b/cohere-openapi.yaml index c42b3f43..eed27b01 100644 --- a/cohere-openapi.yaml +++ b/cohere-openapi.yaml @@ -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: @@ -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 @@ -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: