Merge pull request #111 from tryAGI/bot/update-openapi_202411220628

feat:Update openapi.yaml file in src/libs/Cohere directory

Author: github-actions[bot]

src/libs/Cohere/Generated/Cohere.CohereApi.Rerankv2.g.cs

@@ -508,31 +508,32 @@ partial void ProcessRerankv2ResponseContent(
         /// </summary>
         /// <param name="xClientName"></param>
         /// <param name="model">
-        /// The identifier of the model to use, one of : `rerank-english-v3.0`, `rerank-multilingual-v3.0`, `rerank-english-v2.0`, `rerank-multilingual-v2.0`
+        /// The identifier of the model to use. <br/>
+        /// Supported models:<br/>
+        ///   - `rerank-english-v3.0`<br/>
+        ///   - `rerank-multilingual-v3.0`<br/>
+        ///   - `rerank-english-v2.0`<br/>
+        ///   - `rerank-multilingual-v2.0`
         /// </param>
         /// <param name="query">
         /// The search query
         /// </param>
         /// <param name="documents">
-        /// A list of document objects or strings to rerank.<br/>
-        /// If a document is provided the text fields is required and all other fields will be preserved in the response.<br/>
-        /// The total max chunks (length of documents * max_chunks_per_doc) must be less than 10000.<br/>
-        /// We recommend a maximum of 1,000 documents for optimal endpoint performance.
+        /// A list of texts that will be compared to the `query`.<br/>
+        /// For optimal performance we recommend against sending more than 1,000 documents in a single request.<br/>
+        /// **Note**: long documents will automatically be truncated to the value of `max_tokens_per_doc`.<br/>
+        /// **Note**: structured data should be formatted as YAML strings for best performance.  
         /// </param>
         /// <param name="topN">
-        /// The number of most relevant documents or indices to return, defaults to the length of the documents
-        /// </param>
-        /// <param name="rankFields">
-        /// If a JSON object is provided, you can specify which keys you would like to have considered for reranking. The model will rerank based on order of the fields passed in (i.e. rank_fields=['title','author','text'] will rerank using the values in title, author, text  sequentially. If the length of title, author, and text exceeds the context length of the model, the chunking will not re-consider earlier fields). If not provided, the model will use the default text field for ranking.
+        /// Limits the returned number of rerank results to the specified value. If not passed, all the rerank results will be returned.
         /// </param>
         /// <param name="returnDocuments">
         /// - If false, returns results without the doc text - the api will return a list of {index, relevance score} where index is inferred from the list passed into the request.<br/>
         /// - If true, returns results with the doc text passed in - the api will return an ordered list of {index, text, relevance score} where index + text refers to the list passed into the request.<br/>
         /// Default Value: false
         /// </param>
-        /// <param name="maxChunksPerDoc">
-        /// The maximum number of chunks to produce internally from a document<br/>
-        /// Default Value: 10
+        /// <param name="maxTokensPerDoc">
+        /// Defaults to `4096`. Long documents will be automatically truncated to the specified number of tokens.
         /// </param>
         /// <param name="cancellationToken">The token to cancel the operation with</param>
         /// <exception cref="global::System.InvalidOperationException"></exception>
@@ -542,9 +543,8 @@ partial void ProcessRerankv2ResponseContent(
             global::System.Collections.Generic.IList<global::Cohere.OneOf<string, global::Cohere.RerankDocument>> documents,
             string? xClientName = default,
             int? topN = default,
-            global::System.Collections.Generic.IList<string>? rankFields = default,
             bool? returnDocuments = default,
-            int? maxChunksPerDoc = default,
+            int? maxTokensPerDoc = default,
             global::System.Threading.CancellationToken cancellationToken = default)
         {
             var __request = new global::Cohere.Rerankv2Request
@@ -553,9 +553,8 @@ partial void ProcessRerankv2ResponseContent(
                 Query = query,
                 Documents = documents,
                 TopN = topN,
-                RankFields = rankFields,
                 ReturnDocuments = returnDocuments,
-                MaxChunksPerDoc = maxChunksPerDoc,
+                MaxTokensPerDoc = maxTokensPerDoc,
             };
 
             return await Rerankv2Async(

src/libs/Cohere/Generated/Cohere.ICohereApi.Rerankv2.g.cs

@@ -23,31 +23,32 @@ public partial interface ICohereApi
         /// </summary>
         /// <param name="xClientName"></param>
         /// <param name="model">
-        /// The identifier of the model to use, one of : `rerank-english-v3.0`, `rerank-multilingual-v3.0`, `rerank-english-v2.0`, `rerank-multilingual-v2.0`
+        /// The identifier of the model to use. <br/>
+        /// Supported models:<br/>
+        ///   - `rerank-english-v3.0`<br/>
+        ///   - `rerank-multilingual-v3.0`<br/>
+        ///   - `rerank-english-v2.0`<br/>
+        ///   - `rerank-multilingual-v2.0`
         /// </param>
         /// <param name="query">
         /// The search query
         /// </param>
         /// <param name="documents">
-        /// A list of document objects or strings to rerank.<br/>
-        /// If a document is provided the text fields is required and all other fields will be preserved in the response.<br/>
-        /// The total max chunks (length of documents * max_chunks_per_doc) must be less than 10000.<br/>
-        /// We recommend a maximum of 1,000 documents for optimal endpoint performance.
+        /// A list of texts that will be compared to the `query`.<br/>
+        /// For optimal performance we recommend against sending more than 1,000 documents in a single request.<br/>
+        /// **Note**: long documents will automatically be truncated to the value of `max_tokens_per_doc`.<br/>
+        /// **Note**: structured data should be formatted as YAML strings for best performance.  
         /// </param>
         /// <param name="topN">
-        /// The number of most relevant documents or indices to return, defaults to the length of the documents
-        /// </param>
-        /// <param name="rankFields">
-        /// If a JSON object is provided, you can specify which keys you would like to have considered for reranking. The model will rerank based on order of the fields passed in (i.e. rank_fields=['title','author','text'] will rerank using the values in title, author, text  sequentially. If the length of title, author, and text exceeds the context length of the model, the chunking will not re-consider earlier fields). If not provided, the model will use the default text field for ranking.
+        /// Limits the returned number of rerank results to the specified value. If not passed, all the rerank results will be returned.
         /// </param>
         /// <param name="returnDocuments">
         /// - If false, returns results without the doc text - the api will return a list of {index, relevance score} where index is inferred from the list passed into the request.<br/>
         /// - If true, returns results with the doc text passed in - the api will return an ordered list of {index, text, relevance score} where index + text refers to the list passed into the request.<br/>
         /// Default Value: false
         /// </param>
-        /// <param name="maxChunksPerDoc">
-        /// The maximum number of chunks to produce internally from a document<br/>
-        /// Default Value: 10
+        /// <param name="maxTokensPerDoc">
+        /// Defaults to `4096`. Long documents will be automatically truncated to the specified number of tokens.
         /// </param>
         /// <param name="cancellationToken">The token to cancel the operation with</param>
         /// <exception cref="global::System.InvalidOperationException"></exception>
@@ -57,9 +58,8 @@ public partial interface ICohereApi
             global::System.Collections.Generic.IList<global::Cohere.OneOf<string, global::Cohere.RerankDocument>> documents,
             string? xClientName = default,
             int? topN = default,
-            global::System.Collections.Generic.IList<string>? rankFields = default,
             bool? returnDocuments = default,
-            int? maxChunksPerDoc = default,
+            int? maxTokensPerDoc = default,
             global::System.Threading.CancellationToken cancellationToken = default);
     }
 }

src/libs/Cohere/Generated/Cohere.Models.Rerankv2Request.g.cs

@@ -11,7 +11,12 @@ namespace Cohere
     public sealed partial class Rerankv2Request
     {
         /// <summary>
-        /// The identifier of the model to use, one of : `rerank-english-v3.0`, `rerank-multilingual-v3.0`, `rerank-english-v2.0`, `rerank-multilingual-v2.0`
+        /// The identifier of the model to use. <br/>
+        /// Supported models:<br/>
+        ///   - `rerank-english-v3.0`<br/>
+        ///   - `rerank-multilingual-v3.0`<br/>
+        ///   - `rerank-english-v2.0`<br/>
+        ///   - `rerank-multilingual-v2.0`
         /// </summary>
         [global::System.Text.Json.Serialization.JsonPropertyName("model")]
         [global::System.Text.Json.Serialization.JsonRequired]
@@ -25,27 +30,21 @@ public sealed partial class Rerankv2Request
         public required string Query { get; set; }
 
         /// <summary>
-        /// A list of document objects or strings to rerank.<br/>
-        /// If a document is provided the text fields is required and all other fields will be preserved in the response.<br/>
-        /// The total max chunks (length of documents * max_chunks_per_doc) must be less than 10000.<br/>
-        /// We recommend a maximum of 1,000 documents for optimal endpoint performance.
+        /// A list of texts that will be compared to the `query`.<br/>
+        /// For optimal performance we recommend against sending more than 1,000 documents in a single request.<br/>
+        /// **Note**: long documents will automatically be truncated to the value of `max_tokens_per_doc`.<br/>
+        /// **Note**: structured data should be formatted as YAML strings for best performance.  
         /// </summary>
         [global::System.Text.Json.Serialization.JsonPropertyName("documents")]
         [global::System.Text.Json.Serialization.JsonRequired]
         public required global::System.Collections.Generic.IList<global::Cohere.OneOf<string, global::Cohere.RerankDocument>> Documents { get; set; }
 
         /// <summary>
-        /// The number of most relevant documents or indices to return, defaults to the length of the documents
+        /// Limits the returned number of rerank results to the specified value. If not passed, all the rerank results will be returned.
         /// </summary>
         [global::System.Text.Json.Serialization.JsonPropertyName("top_n")]
         public int? TopN { get; set; }
 
-        /// <summary>
-        /// If a JSON object is provided, you can specify which keys you would like to have considered for reranking. The model will rerank based on order of the fields passed in (i.e. rank_fields=['title','author','text'] will rerank using the values in title, author, text  sequentially. If the length of title, author, and text exceeds the context length of the model, the chunking will not re-consider earlier fields). If not provided, the model will use the default text field for ranking.
-        /// </summary>
-        [global::System.Text.Json.Serialization.JsonPropertyName("rank_fields")]
-        public global::System.Collections.Generic.IList<string>? RankFields { get; set; }
-
         /// <summary>
         /// - If false, returns results without the doc text - the api will return a list of {index, relevance score} where index is inferred from the list passed into the request.<br/>
         /// - If true, returns results with the doc text passed in - the api will return an ordered list of {index, text, relevance score} where index + text refers to the list passed into the request.<br/>
@@ -55,11 +54,10 @@ public sealed partial class Rerankv2Request
         public bool? ReturnDocuments { get; set; }
 
         /// <summary>
-        /// The maximum number of chunks to produce internally from a document<br/>
-        /// Default Value: 10
+        /// Defaults to `4096`. Long documents will be automatically truncated to the specified number of tokens.
         /// </summary>
-        [global::System.Text.Json.Serialization.JsonPropertyName("max_chunks_per_doc")]
-        public int? MaxChunksPerDoc { get; set; }
+        [global::System.Text.Json.Serialization.JsonPropertyName("max_tokens_per_doc")]
+        public int? MaxTokensPerDoc { get; set; }
 
         /// <summary>
         /// Additional properties that are not explicitly defined in the schema
@@ -71,49 +69,48 @@ public sealed partial class Rerankv2Request
         /// Initializes a new instance of the <see cref="Rerankv2Request" /> class.
         /// </summary>
         /// <param name="model">
-        /// The identifier of the model to use, one of : `rerank-english-v3.0`, `rerank-multilingual-v3.0`, `rerank-english-v2.0`, `rerank-multilingual-v2.0`
+        /// The identifier of the model to use. <br/>
+        /// Supported models:<br/>
+        ///   - `rerank-english-v3.0`<br/>
+        ///   - `rerank-multilingual-v3.0`<br/>
+        ///   - `rerank-english-v2.0`<br/>
+        ///   - `rerank-multilingual-v2.0`
         /// </param>
         /// <param name="query">
         /// The search query
         /// </param>
         /// <param name="documents">
-        /// A list of document objects or strings to rerank.<br/>
-        /// If a document is provided the text fields is required and all other fields will be preserved in the response.<br/>
-        /// The total max chunks (length of documents * max_chunks_per_doc) must be less than 10000.<br/>
-        /// We recommend a maximum of 1,000 documents for optimal endpoint performance.
+        /// A list of texts that will be compared to the `query`.<br/>
+        /// For optimal performance we recommend against sending more than 1,000 documents in a single request.<br/>
+        /// **Note**: long documents will automatically be truncated to the value of `max_tokens_per_doc`.<br/>
+        /// **Note**: structured data should be formatted as YAML strings for best performance.  
         /// </param>
         /// <param name="topN">
-        /// The number of most relevant documents or indices to return, defaults to the length of the documents
-        /// </param>
-        /// <param name="rankFields">
-        /// If a JSON object is provided, you can specify which keys you would like to have considered for reranking. The model will rerank based on order of the fields passed in (i.e. rank_fields=['title','author','text'] will rerank using the values in title, author, text  sequentially. If the length of title, author, and text exceeds the context length of the model, the chunking will not re-consider earlier fields). If not provided, the model will use the default text field for ranking.
+        /// Limits the returned number of rerank results to the specified value. If not passed, all the rerank results will be returned.
         /// </param>
         /// <param name="returnDocuments">
         /// - If false, returns results without the doc text - the api will return a list of {index, relevance score} where index is inferred from the list passed into the request.<br/>
         /// - If true, returns results with the doc text passed in - the api will return an ordered list of {index, text, relevance score} where index + text refers to the list passed into the request.<br/>
         /// Default Value: false
         /// </param>
-        /// <param name="maxChunksPerDoc">
-        /// The maximum number of chunks to produce internally from a document<br/>
-        /// Default Value: 10
+        /// <param name="maxTokensPerDoc">
+        /// Defaults to `4096`. Long documents will be automatically truncated to the specified number of tokens.
         /// </param>
         [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
         public Rerankv2Request(
             string model,
             string query,
             global::System.Collections.Generic.IList<global::Cohere.OneOf<string, global::Cohere.RerankDocument>> documents,
             int? topN,
-            global::System.Collections.Generic.IList<string>? rankFields,
             bool? returnDocuments,
-            int? maxChunksPerDoc)
+            int? maxTokensPerDoc)
         {
             this.Model = model ?? throw new global::System.ArgumentNullException(nameof(model));
             this.Query = query ?? throw new global::System.ArgumentNullException(nameof(query));
             this.Documents = documents ?? throw new global::System.ArgumentNullException(nameof(documents));
             this.TopN = topN;
-            this.RankFields = rankFields;
             this.ReturnDocuments = returnDocuments;
-            this.MaxChunksPerDoc = maxChunksPerDoc;
+            this.MaxTokensPerDoc = maxTokensPerDoc;
         }
 
         /// <summary>