@picteus/extension-sdk 0.8.0 → 0.10.0

package/dist/picteus-ws-client/apis/ImageApi.d.ts

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.9.0
+ * The version of the OpenAPI document: 0.14.1
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import type { ComputedImageFormat, ExtensionImageEmbeddings, ExtensionImageFeature, ExtensionImageTag, Image, ImageDistance, ImageEmbeddings, ImageFeature, ImageFormat, ImageMediaUrl, ImageMetadata, ImageResizeRender, ImageSummaryList, SearchCriteria, SearchRange, SearchSorting } from '../models/index.js';
+import type { ComputedImageFormat, ExtensionImageEmbeddings, ExtensionImageFeature, ExtensionImageTag, GenerationRecipe, Image, ImageDistance, ImageEmbeddings, ImageFeature, ImageFormat, ImageMediaUrl, ImageMetadata, ImageResizeRender, SearchFeaturesResult, SearchImageResult, SearchImageSummaryResult, SearchMediaUrlResult, SearchParameters, SearchTagsResult } from '../models/index.js';
 export interface ImageApiImageClosestEmbeddingsImagesRequest {
     extensionId: string;
     count: number;
@@ -54,6 +54,9 @@ export interface ImageApiImageGetAllEmbeddingsRequest {
 export interface ImageApiImageGetAllFeaturesRequest {
     id: string;
 }
+export interface ImageApiImageGetAllRecipesRequest {
+    id: string;
+}
 export interface ImageApiImageGetAllTagsRequest {
     id: string;
 }
@@ -61,9 +64,17 @@ export interface ImageApiImageGetEmbeddingsRequest {
     id: string;
     extensionId: string;
 }
+export interface ImageApiImageGetFeaturesRequest {
+    id: string;
+    extensionId: string;
+}
 export interface ImageApiImageGetMetadataRequest {
     id: string;
 }
+export interface ImageApiImageGetTagsRequest {
+    id: string;
+    extensionId: string;
+}
 export interface ImageApiImageMediaUrlRequest {
     id: string;
     format?: ImageFormat;
@@ -75,11 +86,26 @@ export interface ImageApiImageModifyRequest {
     id: string;
     body: Blob;
 }
-export interface ImageApiImageSearchRequest {
-    criteria?: SearchCriteria;
-    sorting?: SearchSorting;
-    range?: SearchRange;
-    ids?: Array<string>;
+export interface ImageApiImageSearchFeaturesRequest {
+    searchParameters: SearchParameters;
+    extensionIds?: Array<string>;
+}
+export interface ImageApiImageSearchImagesRequest {
+    searchParameters: SearchParameters;
+}
+export interface ImageApiImageSearchMediaUrlRequest {
+    searchParameters: SearchParameters;
+    format?: ImageFormat;
+    width?: number;
+    height?: number;
+    resizeRender?: ImageResizeRender;
+}
+export interface ImageApiImageSearchSummariesRequest {
+    searchParameters: SearchParameters;
+}
+export interface ImageApiImageSearchTagsRequest {
+    searchParameters: SearchParameters;
+    extensionIds?: Array<string>;
 }
 export interface ImageApiImageSetEmbeddingsRequest {
     id: string;
@@ -264,6 +290,20 @@ export interface ImageApiInterface {
      * Gets all the features of an image
      */
     imageGetAllFeatures(requestParameters: ImageApiImageGetAllFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ExtensionImageFeature>>;
+    /**
+     * Returns the recipes of an image for all extensions.
+     * @summary Gets all the recipes of an image
+     * @param {string} id The image identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageGetAllRecipesRaw(requestParameters: ImageApiImageGetAllRecipesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GenerationRecipe>>>;
+    /**
+     * Returns the recipes of an image for all extensions.
+     * Gets all the recipes of an image
+     */
+    imageGetAllRecipes(requestParameters: ImageApiImageGetAllRecipesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GenerationRecipe>>;
     /**
      * Returns the tags of an image for all extensions.
      * @summary Gets all the tags of an image
@@ -293,6 +333,21 @@ export interface ImageApiInterface {
      * Gets the embeddings of an image
      */
     imageGetEmbeddings(requestParameters: ImageApiImageGetEmbeddingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageEmbeddings>;
+    /**
+     * Returns the features of an image given an extension.
+     * @summary Gets all the features of an image for an extension
+     * @param {string} id The image identifier
+     * @param {string} extensionId The extension identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageGetFeaturesRaw(requestParameters: ImageApiImageGetFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ImageFeature>>>;
+    /**
+     * Returns the features of an image given an extension.
+     * Gets all the features of an image for an extension
+     */
+    imageGetFeatures(requestParameters: ImageApiImageGetFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ImageFeature>>;
     /**
      * Returns all the metadata of an image available in its representation file.
      * @summary Gets the metadata of an image
@@ -308,7 +363,22 @@ export interface ImageApiInterface {
      */
     imageGetMetadata(requestParameters: ImageApiImageGetMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageMetadata>;
     /**
-     * Returns the URL of the image, given for some given dimensions and format, which may used to display it.
+     * Returns the tags of an image given an extension.
+     * @summary Gets the tags of an image for an extension
+     * @param {string} id The image identifier
+     * @param {string} extensionId The extension identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageGetTagsRaw(requestParameters: ImageApiImageGetTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Returns the tags of an image given an extension.
+     * Gets the tags of an image for an extension
+     */
+    imageGetTags(requestParameters: ImageApiImageGetTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Returns the URL of the image, given some given dimensions and format, which may used to display it.
      * @summary Gets an URL of the image
      * @param {string} id The image identifier
      * @param {ImageFormat} [format] The image format
@@ -321,7 +391,7 @@ export interface ImageApiInterface {
      */
     imageMediaUrlRaw(requestParameters: ImageApiImageMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageMediaUrl>>;
     /**
-     * Returns the URL of the image, given for some given dimensions and format, which may used to display it.
+     * Returns the URL of the image, given some given dimensions and format, which may used to display it.
      * Gets an URL of the image
      */
     imageMediaUrl(requestParameters: ImageApiImageMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageMediaUrl>;
@@ -341,22 +411,81 @@ export interface ImageApiInterface {
      */
     imageModify(requestParameters: ImageApiImageModifyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Image>;
     /**
-     * Searches images, given criteria.
-     * @summary Searches images
-     * @param {SearchCriteria} [criteria] The criteria that will be applied to the search as a filter
-     * @param {SearchSorting} [sorting] Indicates how the search results should be sorted
-     * @param {SearchRange} [range] The range of items to consider following the search
-     * @param {Array<string>} [ids] The repository identifiers the images should belong to
+     * Retrieves image features following search parameters.
+     * @summary Retrieves image features
+     * @param {SearchParameters} searchParameters
+     * @param {Array<string>} [extensionIds] The extension identifiers the features must belong to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageSearchFeaturesRaw(requestParameters: ImageApiImageSearchFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchFeaturesResult>>;
+    /**
+     * Retrieves image features following search parameters.
+     * Retrieves image features
+     */
+    imageSearchFeatures(requestParameters: ImageApiImageSearchFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchFeaturesResult>;
+    /**
+     * Retrieves image details following search parameters.
+     * @summary Retrieves image details
+     * @param {SearchParameters} searchParameters
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageSearchImagesRaw(requestParameters: ImageApiImageSearchImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchImageResult>>;
+    /**
+     * Retrieves image details following search parameters.
+     * Retrieves image details
+     */
+    imageSearchImages(requestParameters: ImageApiImageSearchImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchImageResult>;
+    /**
+     * Retrieves image media URLs following search parameters.
+     * @summary Retrieves image media URLs
+     * @param {SearchParameters} searchParameters
+     * @param {ImageFormat} [format] The image format
+     * @param {number} [width] The image maximum width ; if not defined, the original width is used
+     * @param {number} [height] The image maximum height ; if not defined, the original height is used
+     * @param {ImageResizeRender} [resizeRender] The way the image should be resized
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageSearchMediaUrlRaw(requestParameters: ImageApiImageSearchMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchMediaUrlResult>>;
+    /**
+     * Retrieves image media URLs following search parameters.
+     * Retrieves image media URLs
+     */
+    imageSearchMediaUrl(requestParameters: ImageApiImageSearchMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchMediaUrlResult>;
+    /**
+     * Retrieves image summaries following search parameters.
+     * @summary Retrieves image summaries
+     * @param {SearchParameters} searchParameters
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ImageApiInterface
      */
-    imageSearchRaw(requestParameters: ImageApiImageSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageSummaryList>>;
+    imageSearchSummariesRaw(requestParameters: ImageApiImageSearchSummariesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchImageSummaryResult>>;
     /**
-     * Searches images, given criteria.
-     * Searches images
+     * Retrieves image summaries following search parameters.
+     * Retrieves image summaries
      */
-    imageSearch(requestParameters: ImageApiImageSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageSummaryList>;
+    imageSearchSummaries(requestParameters: ImageApiImageSearchSummariesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchImageSummaryResult>;
+    /**
+     * Retrieves image tags following search parameters.
+     * @summary Retrieves image tags
+     * @param {SearchParameters} searchParameters
+     * @param {Array<string>} [extensionIds] The extension identifiers the tags must belong to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageSearchTagsRaw(requestParameters: ImageApiImageSearchTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchTagsResult>>;
+    /**
+     * Retrieves image tags following search parameters.
+     * Retrieves image tags
+     */
+    imageSearchTags(requestParameters: ImageApiImageSearchTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchTagsResult>;
     /**
      * Sets the computed embeddings of an image for a given extension.
      * @summary Sets the embeddings of an image
@@ -391,7 +520,7 @@ export interface ImageApiInterface {
     imageSetFeatures(requestParameters: ImageApiImageSetFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Sets the tags of an image for a given extension.
-     * @summary Sets the tags of an image if necessary
+     * @summary Sets the tags of an image
      * @param {string} id The image identifier
      * @param {string} extensionId The extension identifier
      * @param {Array<string>} requestBody The image tags
@@ -402,7 +531,7 @@ export interface ImageApiInterface {
     imageSetTagsRaw(requestParameters: ImageApiImageSetTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
      * Sets the tags of an image for a given extension.
-     * Sets the tags of an image if necessary
+     * Sets the tags of an image
      */
     imageSetTags(requestParameters: ImageApiImageSetTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
@@ -540,6 +669,16 @@ export declare class ImageApi extends runtime.BaseAPI implements ImageApiInterfa
      * Gets all the features of an image
      */
     imageGetAllFeatures(requestParameters: ImageApiImageGetAllFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ExtensionImageFeature>>;
+    /**
+     * Returns the recipes of an image for all extensions.
+     * Gets all the recipes of an image
+     */
+    imageGetAllRecipesRaw(requestParameters: ImageApiImageGetAllRecipesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GenerationRecipe>>>;
+    /**
+     * Returns the recipes of an image for all extensions.
+     * Gets all the recipes of an image
+     */
+    imageGetAllRecipes(requestParameters: ImageApiImageGetAllRecipesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GenerationRecipe>>;
     /**
      * Returns the tags of an image for all extensions.
      * Gets all the tags of an image
@@ -560,6 +699,16 @@ export declare class ImageApi extends runtime.BaseAPI implements ImageApiInterfa
      * Gets the embeddings of an image
      */
     imageGetEmbeddings(requestParameters: ImageApiImageGetEmbeddingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageEmbeddings>;
+    /**
+     * Returns the features of an image given an extension.
+     * Gets all the features of an image for an extension
+     */
+    imageGetFeaturesRaw(requestParameters: ImageApiImageGetFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ImageFeature>>>;
+    /**
+     * Returns the features of an image given an extension.
+     * Gets all the features of an image for an extension
+     */
+    imageGetFeatures(requestParameters: ImageApiImageGetFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ImageFeature>>;
     /**
      * Returns all the metadata of an image available in its representation file.
      * Gets the metadata of an image
@@ -571,12 +720,22 @@ export declare class ImageApi extends runtime.BaseAPI implements ImageApiInterfa
      */
     imageGetMetadata(requestParameters: ImageApiImageGetMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageMetadata>;
     /**
-     * Returns the URL of the image, given for some given dimensions and format, which may used to display it.
+     * Returns the tags of an image given an extension.
+     * Gets the tags of an image for an extension
+     */
+    imageGetTagsRaw(requestParameters: ImageApiImageGetTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Returns the tags of an image given an extension.
+     * Gets the tags of an image for an extension
+     */
+    imageGetTags(requestParameters: ImageApiImageGetTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Returns the URL of the image, given some given dimensions and format, which may used to display it.
      * Gets an URL of the image
      */
     imageMediaUrlRaw(requestParameters: ImageApiImageMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageMediaUrl>>;
     /**
-     * Returns the URL of the image, given for some given dimensions and format, which may used to display it.
+     * Returns the URL of the image, given some given dimensions and format, which may used to display it.
      * Gets an URL of the image
      */
     imageMediaUrl(requestParameters: ImageApiImageMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageMediaUrl>;
@@ -591,15 +750,55 @@ export declare class ImageApi extends runtime.BaseAPI implements ImageApiInterfa
      */
     imageModify(requestParameters: ImageApiImageModifyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Image>;
     /**
-     * Searches images, given criteria.
-     * Searches images
+     * Retrieves image features following search parameters.
+     * Retrieves image features
+     */
+    imageSearchFeaturesRaw(requestParameters: ImageApiImageSearchFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchFeaturesResult>>;
+    /**
+     * Retrieves image features following search parameters.
+     * Retrieves image features
+     */
+    imageSearchFeatures(requestParameters: ImageApiImageSearchFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchFeaturesResult>;
+    /**
+     * Retrieves image details following search parameters.
+     * Retrieves image details
+     */
+    imageSearchImagesRaw(requestParameters: ImageApiImageSearchImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchImageResult>>;
+    /**
+     * Retrieves image details following search parameters.
+     * Retrieves image details
+     */
+    imageSearchImages(requestParameters: ImageApiImageSearchImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchImageResult>;
+    /**
+     * Retrieves image media URLs following search parameters.
+     * Retrieves image media URLs
+     */
+    imageSearchMediaUrlRaw(requestParameters: ImageApiImageSearchMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchMediaUrlResult>>;
+    /**
+     * Retrieves image media URLs following search parameters.
+     * Retrieves image media URLs
+     */
+    imageSearchMediaUrl(requestParameters: ImageApiImageSearchMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchMediaUrlResult>;
+    /**
+     * Retrieves image summaries following search parameters.
+     * Retrieves image summaries
+     */
+    imageSearchSummariesRaw(requestParameters: ImageApiImageSearchSummariesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchImageSummaryResult>>;
+    /**
+     * Retrieves image summaries following search parameters.
+     * Retrieves image summaries
+     */
+    imageSearchSummaries(requestParameters: ImageApiImageSearchSummariesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchImageSummaryResult>;
+    /**
+     * Retrieves image tags following search parameters.
+     * Retrieves image tags
      */
-    imageSearchRaw(requestParameters: ImageApiImageSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageSummaryList>>;
+    imageSearchTagsRaw(requestParameters: ImageApiImageSearchTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchTagsResult>>;
     /**
-     * Searches images, given criteria.
-     * Searches images
+     * Retrieves image tags following search parameters.
+     * Retrieves image tags
      */
-    imageSearch(requestParameters?: ImageApiImageSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageSummaryList>;
+    imageSearchTags(requestParameters: ImageApiImageSearchTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchTagsResult>;
     /**
      * Sets the computed embeddings of an image for a given extension.
      * Sets the embeddings of an image
@@ -622,12 +821,12 @@ export declare class ImageApi extends runtime.BaseAPI implements ImageApiInterfa
     imageSetFeatures(requestParameters: ImageApiImageSetFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Sets the tags of an image for a given extension.
-     * Sets the tags of an image if necessary
+     * Sets the tags of an image
      */
     imageSetTagsRaw(requestParameters: ImageApiImageSetTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
      * Sets the tags of an image for a given extension.
-     * Sets the tags of an image if necessary
+     * Sets the tags of an image
      */
     imageSetTags(requestParameters: ImageApiImageSetTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**