Class: Openai::AssistantObj

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/assistant_obj.rb

Overview

A object model struct of assistant

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AssistantObj

Returns a new instance of AssistantObj.



27
28
29
30
31
 
# File 'lib/openai/assistant_obj.rb', line 27

def initialize(**args)
  args.each do |k, v|
    instance_variable_set("@#{k}", v) unless v.nil?
  end
end

Instance Attribute Details

#created_at ⇒ Integer

Returns The Unix timestamp (in seconds) for when the assistant was created.

Returns:

  • (Integer) —

    The Unix timestamp (in seconds) for when the assistant was created.



11
12
13
 
# File 'lib/openai/assistant_obj.rb', line 11

def created_at
  @created_at
end

#description ⇒ String

Returns The description of the assistant. The maximum length is 512 characters.

Returns:

  • (String) —

    The description of the assistant. The maximum length is 512 characters.



15
16
17
 
# File 'lib/openai/assistant_obj.rb', line 15

def description
  @description
end

#file_ids ⇒ String

Returns A list of file IDs attached to this assistant.

Returns:

  • (String) —

    A list of file IDs attached to this assistant.



23
24
25
 
# File 'lib/openai/assistant_obj.rb', line 23

def file_ids
  @file_ids
end

#id ⇒ String

Returns The identifier, which can be referenced in API endpoints.

Returns:

  • (String) —

    The identifier, which can be referenced in API endpoints.



7
8
9
 
# File 'lib/openai/assistant_obj.rb', line 7

def id
  @id
end

#instructions ⇒ String

Returns The system instructions that the assistant uses. The maximum length is 32768 characters.

Returns:

  • (String) —

    The system instructions that the assistant uses. The maximum length is 32768 characters.



19
20
21
 
# File 'lib/openai/assistant_obj.rb', line 19

def instructions
  @instructions
end

#metadata ⇒ String

Returns Set of 16 key-value pairs that can be attached to an object.

Returns:

  • (String) —

    Set of 16 key-value pairs that can be attached to an object.



25
26
27
 
# File 'lib/openai/assistant_obj.rb', line 25

def metadata
  @metadata
end

#model ⇒ String

Returns ID of the model to use. Use the List models API to see all available models.

Returns:

  • (String) —

    ID of the model to use. Use the List models API to see all available models



17
18
19
 
# File 'lib/openai/assistant_obj.rb', line 17

def model
  @model
end

#name ⇒ String

Returns The name of the assistant. The maximum length is 256 characters.

Returns:

  • (String) —

    The name of the assistant. The maximum length is 256 characters.



13
14
15
 
# File 'lib/openai/assistant_obj.rb', line 13

def name
  @name
end

#object ⇒ String

Returns The object type, which is always assistant.

Returns:

  • (String) —

    The object type, which is always assistant.



9
10
11
 
# File 'lib/openai/assistant_obj.rb', line 9

def object
  @object
end

#tools ⇒ String

Returns A list of tool enabled on the assistant.

Returns:

  • (String) —

    A list of tool enabled on the assistant.



21
22
23
 
# File 'lib/openai/assistant_obj.rb', line 21

def tools
  @tools
end