Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ namespace tryAGI.OpenAI
public partial interface IVectorStoresClient
{
/// <summary>
/// Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).
/// Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).<br/>
/// This endpoint is subject to a per-vector-store write rate limit of 300 requests per minute, shared with `/vector_stores/{vector_store_id}/file_batches`.<br/>
/// For uploading multiple files to the same vector store, use the file batches endpoint to reduce request volume.
/// </summary>
/// <param name="vectorStoreId">
/// Example: vs_abc123
Expand All @@ -19,13 +21,15 @@ public partial interface IVectorStoresClient
global::tryAGI.OpenAI.CreateVectorStoreFileRequest request,
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).
/// Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).<br/>
/// This endpoint is subject to a per-vector-store write rate limit of 300 requests per minute, shared with `/vector_stores/{vector_store_id}/file_batches`.<br/>
/// For uploading multiple files to the same vector store, use the file batches endpoint to reduce request volume.
/// </summary>
/// <param name="vectorStoreId">
/// Example: vs_abc123
/// </param>
/// <param name="fileId">
/// A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files.
/// A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](/docs/api-reference/vector-stores-file-batches/createBatch) to minimize per-vector-store write requests.
/// </param>
/// <param name="chunkingStrategy">
/// The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ public partial interface IVectorStoresClient
{
/// <summary>
/// Create a vector store file batch.<br/>
/// The maximum number of files in a single batch request is 2000.
/// The maximum number of files in a single batch request is 2000.<br/>
/// Vector store file attach requests are rate limited per vector store (300 requests per minute across both this endpoint and `/vector_stores/{vector_store_id}/files`).<br/>
/// For ingesting multiple files into the same vector store, this batch endpoint is recommended.
/// </summary>
/// <param name="vectorStoreId">
/// Example: vs_abc123
Expand All @@ -21,16 +23,18 @@ public partial interface IVectorStoresClient
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// Create a vector store file batch.<br/>
/// The maximum number of files in a single batch request is 2000.
/// The maximum number of files in a single batch request is 2000.<br/>
/// Vector store file attach requests are rate limited per vector store (300 requests per minute across both this endpoint and `/vector_stores/{vector_store_id}/files`).<br/>
/// For ingesting multiple files into the same vector store, this batch endpoint is recommended.
/// </summary>
/// <param name="vectorStoreId">
/// Example: vs_abc123
/// </param>
/// <param name="fileIds">
/// A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. Mutually exclusive with `files`.
/// A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `files`.
/// </param>
/// <param name="files">
/// A list of objects that each include a `file_id` plus optional `attributes` or `chunking_strategy`. Use this when you need to override metadata for specific files. The global `attributes` or `chunking_strategy` will be ignored and must be specified for each file. The maximum batch size is 2000 files. Mutually exclusive with `file_ids`.
/// A list of objects that each include a `file_id` plus optional `attributes` or `chunking_strategy`. Use this when you need to override metadata for specific files. The global `attributes` or `chunking_strategy` will be ignored and must be specified for each file. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `file_ids`.
/// </param>
/// <param name="chunkingStrategy">
/// The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ namespace tryAGI.OpenAI
public sealed partial class CreateVectorStoreFileBatchRequest
{
/// <summary>
/// A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. Mutually exclusive with `files`.
/// A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `files`.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("file_ids")]
public global::System.Collections.Generic.IList<string>? FileIds { get; set; }

/// <summary>
/// A list of objects that each include a `file_id` plus optional `attributes` or `chunking_strategy`. Use this when you need to override metadata for specific files. The global `attributes` or `chunking_strategy` will be ignored and must be specified for each file. The maximum batch size is 2000 files. Mutually exclusive with `file_ids`.
/// A list of objects that each include a `file_id` plus optional `attributes` or `chunking_strategy`. Use this when you need to override metadata for specific files. The global `attributes` or `chunking_strategy` will be ignored and must be specified for each file. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `file_ids`.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("files")]
public global::System.Collections.Generic.IList<global::tryAGI.OpenAI.CreateVectorStoreFileRequest>? Files { get; set; }
Expand Down Expand Up @@ -43,10 +43,10 @@ public sealed partial class CreateVectorStoreFileBatchRequest
/// Initializes a new instance of the <see cref="CreateVectorStoreFileBatchRequest" /> class.
/// </summary>
/// <param name="fileIds">
/// A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. Mutually exclusive with `files`.
/// A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `files`.
/// </param>
/// <param name="files">
/// A list of objects that each include a `file_id` plus optional `attributes` or `chunking_strategy`. Use this when you need to override metadata for specific files. The global `attributes` or `chunking_strategy` will be ignored and must be specified for each file. The maximum batch size is 2000 files. Mutually exclusive with `file_ids`.
/// A list of objects that each include a `file_id` plus optional `attributes` or `chunking_strategy`. Use this when you need to override metadata for specific files. The global `attributes` or `chunking_strategy` will be ignored and must be specified for each file. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `file_ids`.
/// </param>
/// <param name="chunkingStrategy">
/// The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace tryAGI.OpenAI
public sealed partial class CreateVectorStoreFileRequest
{
/// <summary>
/// A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files.
/// A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](/docs/api-reference/vector-stores-file-batches/createBatch) to minimize per-vector-store write requests.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("file_id")]
[global::System.Text.Json.Serialization.JsonRequired]
Expand Down Expand Up @@ -38,7 +38,7 @@ public sealed partial class CreateVectorStoreFileRequest
/// Initializes a new instance of the <see cref="CreateVectorStoreFileRequest" /> class.
/// </summary>
/// <param name="fileId">
/// A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files.
/// A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](/docs/api-reference/vector-stores-file-batches/createBatch) to minimize per-vector-store write requests.
/// </param>
/// <param name="chunkingStrategy">
/// The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ partial void ProcessCreateVectorStoreFileResponseContent(
ref string content);

/// <summary>
/// Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).
/// Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).<br/>
/// This endpoint is subject to a per-vector-store write rate limit of 300 requests per minute, shared with `/vector_stores/{vector_store_id}/file_batches`.<br/>
/// For uploading multiple files to the same vector store, use the file batches endpoint to reduce request volume.
/// </summary>
/// <param name="vectorStoreId">
/// Example: vs_abc123
Expand Down Expand Up @@ -188,13 +190,15 @@ partial void ProcessCreateVectorStoreFileResponseContent(
}
}
/// <summary>
/// Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).
/// Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).<br/>
/// This endpoint is subject to a per-vector-store write rate limit of 300 requests per minute, shared with `/vector_stores/{vector_store_id}/file_batches`.<br/>
/// For uploading multiple files to the same vector store, use the file batches endpoint to reduce request volume.
/// </summary>
/// <param name="vectorStoreId">
/// Example: vs_abc123
/// </param>
/// <param name="fileId">
/// A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files.
/// A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](/docs/api-reference/vector-stores-file-batches/createBatch) to minimize per-vector-store write requests.
/// </param>
/// <param name="chunkingStrategy">
/// The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ partial void ProcessCreateVectorStoreFileBatchResponseContent(

/// <summary>
/// Create a vector store file batch.<br/>
/// The maximum number of files in a single batch request is 2000.
/// The maximum number of files in a single batch request is 2000.<br/>
/// Vector store file attach requests are rate limited per vector store (300 requests per minute across both this endpoint and `/vector_stores/{vector_store_id}/files`).<br/>
/// For ingesting multiple files into the same vector store, this batch endpoint is recommended.
/// </summary>
/// <param name="vectorStoreId">
/// Example: vs_abc123
Expand Down Expand Up @@ -190,16 +192,18 @@ partial void ProcessCreateVectorStoreFileBatchResponseContent(
}
/// <summary>
/// Create a vector store file batch.<br/>
/// The maximum number of files in a single batch request is 2000.
/// The maximum number of files in a single batch request is 2000.<br/>
/// Vector store file attach requests are rate limited per vector store (300 requests per minute across both this endpoint and `/vector_stores/{vector_store_id}/files`).<br/>
/// For ingesting multiple files into the same vector store, this batch endpoint is recommended.
/// </summary>
/// <param name="vectorStoreId">
/// Example: vs_abc123
/// </param>
/// <param name="fileIds">
/// A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. Mutually exclusive with `files`.
/// A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `files`.
/// </param>
/// <param name="files">
/// A list of objects that each include a `file_id` plus optional `attributes` or `chunking_strategy`. Use this when you need to override metadata for specific files. The global `attributes` or `chunking_strategy` will be ignored and must be specified for each file. The maximum batch size is 2000 files. Mutually exclusive with `file_ids`.
/// A list of objects that each include a `file_id` plus optional `attributes` or `chunking_strategy`. Use this when you need to override metadata for specific files. The global `attributes` or `chunking_strategy` will be ignored and must be specified for each file. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `file_ids`.
/// </param>
/// <param name="chunkingStrategy">
/// The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.
Expand Down
Loading