Skip to content

feat: Updated OpenAPI spec #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Apr 15, 2026
Merged

feat: Updated OpenAPI spec #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/libs/Ideogram/Generated/Ideogram.DatasetsClient.TrainDatasetModel.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ partial void ProcessTrainDatasetModelResponseContent(

/// <summary>
/// Train a model from a dataset<br/>
/// Start training a custom model from a dataset. The dataset must contain at least 5 images. Returns the model ID and training status.
/// Start training a custom model from a dataset. The dataset must contain at least 15 images. Returns the model ID and training status.
/// </summary>
/// <param name="datasetId"></param>
/// <param name="request"></param>
Expand Down Expand Up @@ -494,7 +494,7 @@ partial void ProcessTrainDatasetModelResponseContent(
}
/// <summary>
/// Train a model from a dataset<br/>
/// Start training a custom model from a dataset. The dataset must contain at least 5 images. Returns the model ID and training status.
/// Start training a custom model from a dataset. The dataset must contain at least 15 images. Returns the model ID and training status.
/// </summary>
/// <param name="datasetId"></param>
/// <param name="modelName">
Expand Down
4 changes: 2 additions & 2 deletions src/libs/Ideogram/Generated/Ideogram.DatasetsClient.UploadDatasetAssets.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ partial void ProcessUploadDatasetAssetsResponseContent(

/// <summary>
/// Upload assets to a dataset<br/>
/// Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions.
/// Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions. A dataset can contain up to 100 images.
/// </summary>
/// <param name="datasetId"></param>
/// <param name="request"></param>
Expand Down Expand Up @@ -505,7 +505,7 @@ partial void ProcessUploadDatasetAssetsResponseContent(
}
/// <summary>
/// Upload assets to a dataset<br/>
/// Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions.
/// Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions. A dataset can contain up to 100 images.
/// </summary>
/// <param name="datasetId"></param>
/// <param name="files">
Expand Down
4 changes: 2 additions & 2 deletions src/libs/Ideogram/Generated/Ideogram.IDatasetsClient.TrainDatasetModel.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ public partial interface IDatasetsClient
{
/// <summary>
/// Train a model from a dataset<br/>
/// Start training a custom model from a dataset. The dataset must contain at least 5 images. Returns the model ID and training status.
/// Start training a custom model from a dataset. The dataset must contain at least 15 images. Returns the model ID and training status.
/// </summary>
/// <param name="datasetId"></param>
/// <param name="request"></param>
Expand All @@ -21,7 +21,7 @@ public partial interface IDatasetsClient
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// Train a model from a dataset<br/>
/// Start training a custom model from a dataset. The dataset must contain at least 5 images. Returns the model ID and training status.
/// Start training a custom model from a dataset. The dataset must contain at least 15 images. Returns the model ID and training status.
/// </summary>
/// <param name="datasetId"></param>
/// <param name="modelName">
Expand Down
4 changes: 2 additions & 2 deletions src/libs/Ideogram/Generated/Ideogram.IDatasetsClient.UploadDatasetAssets.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ public partial interface IDatasetsClient
{
/// <summary>
/// Upload assets to a dataset<br/>
/// Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions.
/// Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions. A dataset can contain up to 100 images.
/// </summary>
/// <param name="datasetId"></param>
/// <param name="request"></param>
Expand All @@ -21,7 +21,7 @@ public partial interface IDatasetsClient
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// Upload assets to a dataset<br/>
/// Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions.
/// Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions. A dataset can contain up to 100 images.
/// </summary>
/// <param name="datasetId"></param>
/// <param name="files">
Expand Down
4 changes: 2 additions & 2 deletions src/libs/Ideogram/Generated/autosdk.generated-examples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"Order": 5,
"Title": "Train a model from a dataset",
"Slug": "train-dataset-model",
"Description": "Start training a custom model from a dataset. The dataset must contain at least 5 images. Returns the model ID and training status.",
"Description": "Start training a custom model from a dataset. The dataset must contain at least 15 images. Returns the model ID and training status.",
"Language": "http",
"Code": "### Train a model from a dataset\n# @name train_dataset_model\nPOST {{host}}/datasets/{{dataset_id}}/train_model\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022model_name\u0022: \u0022my-custom-model\u0022,\n \u0022lora_rank\u0022: 64,\n \u0022num_chips\u0022: 32,\n \u0022ema\u0022: 0.999,\n \u0022base_model_version\u0022: \u0022V_3_1\u0022,\n \u0022training_steps\u0022: 1000,\n \u0022learning_rate\u0022: 0.0001\n}\n\n## Responses\n# 200\n# Description: Training started successfully\n# Content-Type: application/json\n# 400\n# Description: Bad request\n# 401\n# Description: Unauthorized\n# 404\n# Description: Dataset not found",
"Format": "http",
Expand All @@ -59,7 +59,7 @@
"Order": 6,
"Title": "Upload assets to a dataset",
"Slug": "upload-dataset-assets",
"Description": "Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions.",
"Description": "Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions. A dataset can contain up to 100 images.",
"Language": "http",
"Code": "### Upload assets to a dataset\n# @name upload_dataset_assets\nPOST {{host}}/datasets/{{dataset_id}}/upload_assets\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data\nAccept: application/json\n\n## Responses\n# 200\n# Description: Upload summary\n# Content-Type: application/json\n# 400\n# Description: Bad request\n# 401\n# Description: Unauthorized\n# 404\n# Description: Dataset not found",
"Format": "http",
Expand Down
4 changes: 2 additions & 2 deletions src/libs/Ideogram/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@
},
"/datasets/{dataset_id}/train_model": {
"post": {
"description": "Start training a custom model from a dataset. The dataset must contain at least 5 images. Returns the model ID and training status.\n",
"description": "Start training a custom model from a dataset. The dataset must contain at least 15 images. Returns the model ID and training status.\n",
"operationId": "train_dataset_model",
"parameters": [
{
Expand Down Expand Up @@ -198,7 +198,7 @@
},
"/datasets/{dataset_id}/upload_assets": {
"post": {
"description": "Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions.\n",
"description": "Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions. A dataset can contain up to 100 images.\n",
"operationId": "upload_dataset_assets",
"parameters": [
{
Expand Down