From 1269e0dc8f52f931395f2428a6b7f720d578f9c7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 27 Nov 2024 21:18:57 +0000 Subject: [PATCH] feat: Updated OpenAPI spec --- .../Generated/Cohere.CohereApi.Chatv2.g.cs | 8 ++++++++ .../Generated/Cohere.ICohereApi.Chatv2.g.cs | 7 +++++++ .../Generated/Cohere.Models.Chatv2Request.g.cs | 17 +++++++++++++++++ src/libs/Cohere/openapi.yaml | 5 +++++ 4 files changed, 37 insertions(+) diff --git a/src/libs/Cohere/Generated/Cohere.CohereApi.Chatv2.g.cs b/src/libs/Cohere/Generated/Cohere.CohereApi.Chatv2.g.cs index 17e6c84..bd759d0 100644 --- a/src/libs/Cohere/Generated/Cohere.CohereApi.Chatv2.g.cs +++ b/src/libs/Cohere/Generated/Cohere.CohereApi.Chatv2.g.cs @@ -513,6 +513,12 @@ partial void ProcessChatv2ResponseContent( /// Follow the [Migration Guide](https://docs.cohere.com/v2/docs/migrating-v1-to-v2) for instructions on moving from API v1 to API v2. /// /// + /// + /// Defaults to `false`.
+ /// When `true`, the response will be a SSE stream of events. The final event will contain the complete response, and will have an `event_type` of `"stream-end"`.
+ /// Streaming is beneficial for user interfaces that render the contents of the response piece by piece, as it gets generated.
+ /// Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments + /// /// /// The name of a compatible [Cohere model](https://docs.cohere.com/v2/docs/models) (such as command-r or command-r-plus) or the ID of a [fine-tuned](https://docs.cohere.com/v2/docs/chat-fine-tuning) model. /// @@ -593,6 +599,7 @@ partial void ProcessChatv2ResponseContent( string model, global::System.Collections.Generic.IList messages, string? xClientName = default, + bool? stream = default, global::System.Collections.Generic.IList? tools = default, bool? strictTools = default, global::System.Collections.Generic.IList>? documents = default, @@ -612,6 +619,7 @@ partial void ProcessChatv2ResponseContent( { var __request = new global::Cohere.Chatv2Request { + Stream = stream, Model = model, Messages = messages, Tools = tools, diff --git a/src/libs/Cohere/Generated/Cohere.ICohereApi.Chatv2.g.cs b/src/libs/Cohere/Generated/Cohere.ICohereApi.Chatv2.g.cs index c9c2758..b8cbb0d 100644 --- a/src/libs/Cohere/Generated/Cohere.ICohereApi.Chatv2.g.cs +++ b/src/libs/Cohere/Generated/Cohere.ICohereApi.Chatv2.g.cs @@ -24,6 +24,12 @@ public partial interface ICohereApi /// Follow the [Migration Guide](https://docs.cohere.com/v2/docs/migrating-v1-to-v2) for instructions on moving from API v1 to API v2. /// /// + /// + /// Defaults to `false`.
+ /// When `true`, the response will be a SSE stream of events. The final event will contain the complete response, and will have an `event_type` of `"stream-end"`.
+ /// Streaming is beneficial for user interfaces that render the contents of the response piece by piece, as it gets generated.
+ /// Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments + /// /// /// The name of a compatible [Cohere model](https://docs.cohere.com/v2/docs/models) (such as command-r or command-r-plus) or the ID of a [fine-tuned](https://docs.cohere.com/v2/docs/chat-fine-tuning) model. /// @@ -104,6 +110,7 @@ public partial interface ICohereApi string model, global::System.Collections.Generic.IList messages, string? xClientName = default, + bool? stream = default, global::System.Collections.Generic.IList? tools = default, bool? strictTools = default, global::System.Collections.Generic.IList>? documents = default, diff --git a/src/libs/Cohere/Generated/Cohere.Models.Chatv2Request.g.cs b/src/libs/Cohere/Generated/Cohere.Models.Chatv2Request.g.cs index 2de4206..6962502 100644 --- a/src/libs/Cohere/Generated/Cohere.Models.Chatv2Request.g.cs +++ b/src/libs/Cohere/Generated/Cohere.Models.Chatv2Request.g.cs @@ -10,6 +10,15 @@ namespace Cohere /// public sealed partial class Chatv2Request { + /// + /// Defaults to `false`.
+ /// When `true`, the response will be a SSE stream of events. The final event will contain the complete response, and will have an `event_type` of `"stream-end"`.
+ /// Streaming is beneficial for user interfaces that render the contents of the response piece by piece, as it gets generated.
+ /// Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments + ///
+ [global::System.Text.Json.Serialization.JsonPropertyName("stream")] + public bool? Stream { get; set; } + /// /// The name of a compatible [Cohere model](https://docs.cohere.com/v2/docs/models) (such as command-r or command-r-plus) or the ID of a [fine-tuned](https://docs.cohere.com/v2/docs/chat-fine-tuning) model. /// @@ -148,6 +157,12 @@ public sealed partial class Chatv2Request /// /// Initializes a new instance of the class. /// + /// + /// Defaults to `false`.
+ /// When `true`, the response will be a SSE stream of events. The final event will contain the complete response, and will have an `event_type` of `"stream-end"`.
+ /// Streaming is beneficial for user interfaces that render the contents of the response piece by piece, as it gets generated.
+ /// Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments + /// /// /// The name of a compatible [Cohere model](https://docs.cohere.com/v2/docs/models) (such as command-r or command-r-plus) or the ID of a [fine-tuned](https://docs.cohere.com/v2/docs/chat-fine-tuning) model. /// @@ -226,6 +241,7 @@ public sealed partial class Chatv2Request public Chatv2Request( string model, global::System.Collections.Generic.IList messages, + bool? stream, global::System.Collections.Generic.IList? tools, bool? strictTools, global::System.Collections.Generic.IList>? documents, @@ -244,6 +260,7 @@ public Chatv2Request( { this.Model = model ?? throw new global::System.ArgumentNullException(nameof(model)); this.Messages = messages ?? throw new global::System.ArgumentNullException(nameof(messages)); + this.Stream = stream; this.Tools = tools; this.StrictTools = strictTools; this.Documents = documents; diff --git a/src/libs/Cohere/openapi.yaml b/src/libs/Cohere/openapi.yaml index 09b2b06..db4d8c9 100644 --- a/src/libs/Cohere/openapi.yaml +++ b/src/libs/Cohere/openapi.yaml @@ -759,6 +759,11 @@ paths: - model type: object properties: + stream: + type: boolean + description: "Defaults to `false`.\n\nWhen `true`, the response will be a SSE stream of events. The final event will contain the complete response, and will have an `event_type` of `\"stream-end\"`.\n\nStreaming is beneficial for user interfaces that render the contents of the response piece by piece, as it gets generated.\n\nCompatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments\n" + x-fern-audiences: + - public model: type: string description: 'The name of a compatible [Cohere model](https://docs.cohere.com/v2/docs/models) (such as command-r or command-r-plus) or the ID of a [fine-tuned](https://docs.cohere.com/v2/docs/chat-fine-tuning) model.'