Class: LockstepSdk::TranscriptionValidationRequestItemModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/transcription_validation_request_item_model.rb

Overview

Represents a transcription validation request item to be validated.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ TranscriptionValidationRequestItemModel

Initialize the TranscriptionValidationRequestItemModel using the provided prototype



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 25

def initialize(params = {})
    @transcription_validation_request_item_id = params.dig(:transcription_validation_request_item_id)
    @transcription_validation_request_id = params.dig(:transcription_validation_request_id)
    @group_key = params.dig(:group_key)
    @file_hash = params.dig(:file_hash)
    @file_name = params.dig(:file_name)
    @file_ext = params.dig(:file_ext)
    @file_location = params.dig(:file_location)
    @transcription_result = params.dig(:transcription_result)
    @process_start = params.dig(:process_start)
    @process_end = params.dig(:process_end)
    @retry_count = params.dig(:retry_count)
    @feedback_result = params.dig(:feedback_result)
    @feedback_sent = params.dig(:feedback_sent)
    @status_code = params.dig(:status_code)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
end

Instance Attribute Details

#created ⇒ Date-time

Returns The date on which this transcription validation request item was created.

Returns:

  • (Date-time) —

    The date on which this transcription validation request item was created.



104
105
106
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 104

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The ID number of the user who created this transcription validation request item.

Returns:

  • (Uuid) —

    The ID number of the user who created this transcription validation request item.



108
109
110
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 108

def created_user_id
  @created_user_id
end

#feedback_result ⇒ String

Returns Feedback result specified by the client when the transcription result is not correct. This feedback result will be sent back to the transcription services to retrain and improve models over time.

Returns:

  • (String) —

    Feedback result specified by the client when the transcription result is not correct. This feedback result will be sent back to the transcription services to retrain and improve models over time.



92
93
94
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 92

def feedback_result
  @feedback_result
end

#feedback_sent ⇒ Date-time

Returns Date when feedback result was sent back to transcription service.

Returns:

  • (Date-time) —

    Date when feedback result was sent back to transcription service.



96
97
98
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 96

def feedback_sent
  @feedback_sent
end

#file_ext ⇒ String

Returns Original extension name of the file on disk.

Returns:

  • (String) —

    Original extension name of the file on disk.



68
69
70
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 68

def file_ext
  @file_ext
end

#file_hash ⇒ String

Returns Generated hash of the file being validated.

Returns:

  • (String) —

    Generated hash of the file being validated.



60
61
62
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 60

def file_hash
  @file_hash
end

#file_location ⇒ String

Returns Location of file in blob storage to be validated.

Returns:

  • (String) —

    Location of file in blob storage to be validated.



72
73
74
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 72

def file_location
  @file_location
end

#file_name ⇒ String

Returns Original name of the file on disk, without its extension.

Returns:

  • (String) —

    Original name of the file on disk, without its extension.



64
65
66
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 64

def file_name
  @file_name
end

#group_key ⇒ Uuid

Returns Group account transcription validation request item is associated with.

Returns:

  • (Uuid) —

    Group account transcription validation request item is associated with.



56
57
58
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 56

def group_key
  @group_key
end

#modified ⇒ Date-time

Returns The date on which this transcription validation request item was last modified.

Returns:

  • (Date-time) —

    The date on which this transcription validation request item was last modified.



112
113
114
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 112

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The ID number of the user who most recently modified this transcription validation request item.

Returns:

  • (Uuid) —

    The ID number of the user who most recently modified this transcription validation request item.



116
117
118
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 116

def modified_user_id
  @modified_user_id
end

#process_end ⇒ Date-time

Returns Transcription process end date.

Returns:

  • (Date-time) —

    Transcription process end date



84
85
86
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 84

def process_end
  @process_end
end

#process_start ⇒ Date-time

Returns Transcription process start date.

Returns:

  • (Date-time) —

    Transcription process start date



80
81
82
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 80

def process_start
  @process_start
end

#retry_count ⇒ Int32

Returns Amount of times item was processed to retrieve the transcription data.

Returns:

  • (Int32) —

    Amount of times item was processed to retrieve the transcription data



88
89
90
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 88

def retry_count
  @retry_count
end

#status_code ⇒ String

Returns A code identifying the status of this transcription validation request item. Recognized Transcription Validation Request status codes are: * ‘New` - Represents a transcription validation request item that is considered new and needs work to complete * `In Progress` - Represents a transcription validation request item that is currently being worked on * `Failed` - Represents a transcription validation request item that could not complete the validation process * `Complete` - Represents a transcription validation request item that is considered complete and does not need any further work.

Returns:

  • (String) —

    A code identifying the status of this transcription validation request item. Recognized Transcription Validation Request status codes are: * ‘New` - Represents a transcription validation request item that is considered new and needs work to complete * `In Progress` - Represents a transcription validation request item that is currently being worked on * `Failed` - Represents a transcription validation request item that could not complete the validation process * `Complete` - Represents a transcription validation request item that is considered complete and does not need any further work



100
101
102
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 100

def status_code
  @status_code
end

#transcription_result ⇒ String

Returns Transcription result.

Returns:

  • (String) —

    Transcription result



76
77
78
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 76

def transcription_result
  @transcription_result
end

#transcription_validation_request_id ⇒ Uuid

Returns The ID number of the transcription validation request this item belongs to.

Returns:

  • (Uuid) —

    The ID number of the transcription validation request this item belongs to.



52
53
54
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 52

def transcription_validation_request_id
  @transcription_validation_request_id
end

#transcription_validation_request_item_id ⇒ Uuid

Returns The unique identifier of the transcription validation request item.

Returns:

  • (Uuid) —

    The unique identifier of the transcription validation request item.



48
49
50
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 48

def transcription_validation_request_item_id
  @transcription_validation_request_item_id
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 120

def as_json(options={})
    {
        'transcriptionValidationRequestItemId' => @transcription_validation_request_item_id,
        'transcriptionValidationRequestId' => @transcription_validation_request_id,
        'groupKey' => @group_key,
        'fileHash' => @file_hash,
        'fileName' => @file_name,
        'fileExt' => @file_ext,
        'fileLocation' => @file_location,
        'transcriptionResult' => @transcription_result,
        'processStart' => @process_start,
        'processEnd' => @process_end,
        'retryCount' => @retry_count,
        'feedbackResult' => @feedback_result,
        'feedbackSent' => @feedback_sent,
        'statusCode' => @status_code,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



145
146
147
 
# File 'lib/lockstep_sdk/models/transcription_validation_request_item_model.rb', line 145

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end