Class: Vellum::PromptDeploymentExpandMetaRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model_name: OMIT, usage: OMIT, cost: OMIT, finish_reason: OMIT, latency: OMIT, deployment_release_tag: OMIT, prompt_version_id: OMIT, additional_properties: nil) ⇒ Vellum::PromptDeploymentExpandMetaRequest

Parameters:

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 50

def initialize(model_name: OMIT, usage: OMIT, cost: OMIT, finish_reason: OMIT, latency: OMIT, deployment_release_tag: OMIT, prompt_version_id: OMIT, additional_properties: nil)
  @model_name = model_name if model_name != OMIT
  @usage = usage if usage != OMIT
  @cost = cost if cost != OMIT
  @finish_reason = finish_reason if finish_reason != OMIT
  @latency = latency if latency != OMIT
  @deployment_release_tag = deployment_release_tag if deployment_release_tag != OMIT
  @prompt_version_id = prompt_version_id if prompt_version_id != OMIT
  @additional_properties = additional_properties
  @_field_set = { "model_name": model_name, "usage": usage, "cost": cost, "finish_reason": finish_reason, "latency": latency, "deployment_release_tag": deployment_release_tag, "prompt_version_id": prompt_version_id }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



28
29
30
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 28

def additional_properties
  @additional_properties
end

#cost ⇒ Object (readonly)

increase latency for some model hosts.



15
16
17
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 15

def cost
  @cost
end

#deployment_release_tag ⇒ Boolean (readonly)

Returns If enabled, the response will include the release tag of the Prompt Deployment.

Returns:

  • (Boolean) —

    If enabled, the response will include the release tag of the Prompt Deployment.



23
24
25
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 23

def deployment_release_tag
  @deployment_release_tag
end

#finish_reason ⇒ Object (readonly)

the execution finished.



18
19
20
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 18

def finish_reason
  @finish_reason
end

#latency ⇒ Object (readonly)

the Prompt Deployment.



21
22
23
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 21

def latency
  @latency
end

#model_name ⇒ Object (readonly)

Model invoked by the Prompt.



9
10
11
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 9

def model_name
  @model_name
end

#prompt_version_id ⇒ Object (readonly)

deployment.



26
27
28
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 26

def prompt_version_id
  @prompt_version_id
end

#usage ⇒ Object (readonly)

increase latency for some model hosts.



12
13
14
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 12

def usage
  @usage
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::PromptDeploymentExpandMetaRequest

Parameters:

  • json_object (String)

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 67

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  model_name = parsed_json["model_name"]
  usage = parsed_json["usage"]
  cost = parsed_json["cost"]
  finish_reason = parsed_json["finish_reason"]
  latency = parsed_json["latency"]
  deployment_release_tag = parsed_json["deployment_release_tag"]
  prompt_version_id = parsed_json["prompt_version_id"]
  new(
    model_name: model_name,
    usage: usage,
    cost: cost,
    finish_reason: finish_reason,
    latency: latency,
    deployment_release_tag: deployment_release_tag,
    prompt_version_id: prompt_version_id,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


100
101
102
103
104
105
106
107
108
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 100

def self.validate_raw(obj:)
  obj.model_name&.is_a?(Boolean) != false || raise("Passed value for field obj.model_name is not the expected type, validation failed.")
  obj.usage&.is_a?(Boolean) != false || raise("Passed value for field obj.usage is not the expected type, validation failed.")
  obj.cost&.is_a?(Boolean) != false || raise("Passed value for field obj.cost is not the expected type, validation failed.")
  obj.finish_reason&.is_a?(Boolean) != false || raise("Passed value for field obj.finish_reason is not the expected type, validation failed.")
  obj.latency&.is_a?(Boolean) != false || raise("Passed value for field obj.latency is not the expected type, validation failed.")
  obj.deployment_release_tag&.is_a?(Boolean) != false || raise("Passed value for field obj.deployment_release_tag is not the expected type, validation failed.")
  obj.prompt_version_id&.is_a?(Boolean) != false || raise("Passed value for field obj.prompt_version_id is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


91
92
93
 
# File 'lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb', line 91

def to_json
  @_field_set&.to_json
end