Class: OpenAI::Resources::Skills

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/skills.rb,
lib/openai/resources/skills/content.rb,
lib/openai/resources/skills/versions.rb,
lib/openai/resources/skills/versions/content.rb,
sig/openai/resources/skills.rbs,
sig/openai/resources/skills/content.rbs,
sig/openai/resources/skills/versions.rbs,
sig/openai/resources/skills/versions/content.rbs

Defined Under Namespace

Classes: Content, Versions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Skills

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Skills.

Parameters:



152
153
154
155
156
 
# File 'lib/openai/resources/skills.rb', line 152

def initialize(client:)
  @client = client
  @content = OpenAI::Resources::Skills::Content.new(client: client)
  @versions = OpenAI::Resources::Skills::Versions.new(client: client)
end

Instance Attribute Details

#content ⇒ OpenAI::Resources::Skills::Content (readonly)

Returns:



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

def content
  @content
end

#versions ⇒ OpenAI::Resources::Skills::Versions (readonly)

Returns:



10
11
12
 
# File 'lib/openai/resources/skills.rb', line 10

def versions
  @versions
end

Instance Method Details

#create(files: nil, request_options: {}) ⇒ OpenAI::Models::Skill

Create a new skill.

String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

Parameters:

  • files (Array<Pathname, StringIO, IO, String, OpenAI::FilePart>, Pathname, StringIO, IO, String, OpenAI::FilePart) —

    Skill files to upload (directory upload) or a single zip file.

    String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/openai/resources/skills.rb', line 32

def create(params = {})
  parsed, options = OpenAI::SkillCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "skills",
    headers: {"content-type" => "multipart/form-data"},
    body: parsed,
    model: OpenAI::Skill,
    security: {bearer_auth: true},
    options: options
  )
end

#delete(skill_id, request_options: {}) ⇒ OpenAI::Models::DeletedSkill

Delete a skill by its ID.

Parameters:

  • skill_id (String) —

    The identifier of the skill to delete.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



139
140
141
142
143
144
145
146
147
 
# File 'lib/openai/resources/skills.rb', line 139

def delete(skill_id, params = {})
  @client.request(
    method: :delete,
    path: ["skills/%1$s", skill_id],
    model: OpenAI::DeletedSkill,
    security: {bearer_auth: true},
    options: params[:request_options]
  )
end

#list(after: nil, limit: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Skill>

List all skills for the current project.

Parameters:

  • after (String) —

    Identifier for the last item from the previous pagination request

  • limit (Integer) —

    Number of items to retrieve

  • order (Symbol, OpenAI::Models::SkillListParams::Order) —

    Sort order of results by timestamp. Use asc for ascending order or desc for descending order.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/openai/resources/skills.rb', line 113

def list(params = {})
  parsed, options = OpenAI::SkillListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "skills",
    query: query,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Skill,
    security: {bearer_auth: true},
    options: options
  )
end

#retrieve(skill_id, request_options: {}) ⇒ OpenAI::Models::Skill

Get a skill by its ID.

Parameters:

  • skill_id (String) —

    The identifier of the skill to retrieve.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



57
58
59
60
61
62
63
64
65
 
# File 'lib/openai/resources/skills.rb', line 57

def retrieve(skill_id, params = {})
  @client.request(
    method: :get,
    path: ["skills/%1$s", skill_id],
    model: OpenAI::Skill,
    security: {bearer_auth: true},
    options: params[:request_options]
  )
end

#update(skill_id, default_version:, request_options: {}) ⇒ OpenAI::Models::Skill

Update the default version pointer for a skill.

Parameters:

  • skill_id (String) —

    The identifier of the skill.

  • default_version (String) —

    The skill version number to set as default.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/openai/resources/skills.rb', line 82

def update(skill_id, params)
  parsed, options = OpenAI::SkillUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["skills/%1$s", skill_id],
    body: parsed,
    model: OpenAI::Skill,
    security: {bearer_auth: true},
    options: options
  )
end