Class: Imagekitio::Models::FileUploadResponse::AITag

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/imagekitio/models/file_upload_response.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(ai_tags: nil, audio_codec: nil, bit_rate: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, duration: nil, embedded_metadata: nil, extension_status: nil, file_id: nil, file_path: nil, file_type: nil, height: nil, is_private_file: nil, is_published: nil, metadata: nil, name: nil, selected_fields_schema: nil, size: nil, tags: nil, thumbnail_url: nil, url: nil, version_info: nil, video_codec: nil, width: nil) ⇒ Object

Some parameter documentations has been truncated, see Imagekitio::Models::FileUploadResponse for more details.

Object containing details of a successful upload.

Parameters:

  • ai_tags (Array<Imagekitio::Models::FileUploadResponse::AITag>, nil) (defaults to: nil) —

    An array of tags assigned to the uploaded file by auto tagging.

  • audio_codec (String) (defaults to: nil) —

    The audio codec used in the video (only for video).

  • bit_rate (Integer) (defaults to: nil) —

    The bit rate of the video in kbps (only for video).

  • custom_coordinates (String, nil) (defaults to: nil) —

    Value of custom coordinates associated with the image in the format ‘x,y,width,h

  • custom_metadata (Hash{Symbol=>Object}) (defaults to: nil) —

    A key-value data associated with the asset. Use ‘responseField` in API request t

  • description (String) (defaults to: nil) —

    Optional text to describe the contents of the file. Can be set by the user or th

  • duration (Integer) (defaults to: nil) —

    The duration of the video in seconds (only for video).

  • embedded_metadata (Hash{Symbol=>Object}) (defaults to: nil) —

    Consolidated embedded metadata associated with the file. It includes exif, iptc,

  • extension_status (Imagekitio::Models::FileUploadResponse::ExtensionStatus) (defaults to: nil) —

    Extension names with their processing status at the time of completion of the re

  • file_id (String) (defaults to: nil) —

    Unique fileId. Store this fileld in your database, as this will be used to perfo

  • file_path (String) (defaults to: nil) —

    The relative path of the file in the media library e.g. ‘/marketing-assets/new-b

  • file_type (String) (defaults to: nil) —

    Type of the uploaded file. Possible values are ‘image`, `non-image`.

  • height (Float) (defaults to: nil) —

    Height of the image in pixels (Only for images)

  • is_private_file (Boolean) (defaults to: nil) —

    Is the file marked as private. It can be either ‘true` or `false`. Send `isPriva

  • is_published (Boolean) (defaults to: nil) —

    Is the file published or in draft state. It can be either ‘true` or `false`. Sen

  • metadata (Imagekitio::Models::Metadata) (defaults to: nil) —

    Legacy metadata. Send ‘metadata` in `responseFields` in API request to get metad

  • name (String) (defaults to: nil) —

    Name of the asset.

  • selected_fields_schema (Hash{Symbol=>Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema}) (defaults to: nil) —

    This field is included in the response only if the Path policy feature is availa

  • size (Float) (defaults to: nil) —

    Size of the image file in Bytes.

  • tags (Array<String>, nil) (defaults to: nil) —

    The array of tags associated with the asset. If no tags are set, it will be ‘nul

  • thumbnail_url (String) (defaults to: nil) —

    In the case of an image, a small thumbnail URL.

  • url (String) (defaults to: nil) —

    A publicly accessible URL of the file.

  • version_info (Imagekitio::Models::FileUploadResponse::VersionInfo) (defaults to: nil) —

    An object containing the file or file version’s ‘id` (versionId) and `name`.

  • video_codec (String) (defaults to: nil) —

    The video codec used in the video (only for video).

  • width (Float) (defaults to: nil) —

    Width of the image in pixels (Only for Images)



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/imagekitio/models/file_upload_response.rb', line 257

class AITag < Imagekitio::Internal::Type::BaseModel
  # @!attribute confidence
  #   Confidence score of the tag.
  #
  #   @return [Float, nil]
  optional :confidence, Float

  # @!attribute name
  #   Name of the tag.
  #
  #   @return [String, nil]
  optional :name, String

  # @!attribute source
  #   Array of `AITags` associated with the image. If no `AITags` are set, it will be
  #   null. These tags can be added using the `google-auto-tagging` or
  #   `aws-auto-tagging` extensions.
  #
  #   @return [String, nil]
  optional :source, String

  # @!method initialize(confidence: nil, name: nil, source: nil)
  #   Some parameter documentations has been truncated, see
  #   {Imagekitio::Models::FileUploadResponse::AITag} for more details.
  #
  #   @param confidence [Float] Confidence score of the tag.
  #
  #   @param name [String] Name of the tag.
  #
  #   @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be
end

Instance Attribute Details

#confidence ⇒ Float?

Confidence score of the tag.

Returns:

  • (Float, nil) 


262
 
# File 'lib/imagekitio/models/file_upload_response.rb', line 262

optional :confidence, Float

#name ⇒ String?

Name of the tag.

Returns:

  • (String, nil) 


268
 
# File 'lib/imagekitio/models/file_upload_response.rb', line 268

optional :name, String

#source ⇒ String?

Array of ‘AITags` associated with the image. If no `AITags` are set, it will be null. These tags can be added using the `google-auto-tagging` or `aws-auto-tagging` extensions.

Returns:

  • (String, nil) 


276
 
# File 'lib/imagekitio/models/file_upload_response.rb', line 276

optional :source, String