Class Skills (1.153.1) 

Skills(api_client_: google.genai._api_client.BaseApiClient)

Class for managing Skills in the Skill Registry.

Properties

revisions

Returns the revisions sub-module.

Methods

create

create(
    *,
    display_name: str,
    description: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.common.CreateSkillConfig,
            vertexai._genai.types.common.CreateSkillConfigDict,
        ]
    ] = None
) -> typing.Union[
    vertexai._genai.types.common.Skill, vertexai._genai.types.common.SkillOperation
]

Creates a new Skill.

Parameters
Name Description
display_name str

Required. The display name of the Skill.
description str

Required. The description of the Skill.
config CreateSkillConfigOrDict

Optional. The configuration for creating the Skill.
Returns
Type Description
Skill The created Skill if wait_for_completion is True. SkillOperation: The operation for creating the Skill if wait_for_completion is False.

delete

delete(
    *,
    name: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.common.DeleteSkillConfig,
            vertexai._genai.types.common.DeleteSkillConfigDict,
        ]
    ] = None
) -> typing.Optional[vertexai._genai.types.common.DeleteSkillOperation]

Deletes a Skill.

Parameters
Name Description
name str

Required. The resource name of the Skill to delete. Format: projects/{project}/locations/{location}/skills/{skill}
config DeleteSkillConfigOrDict

Optional. Additional configuration for the delete operation.
Returns
Type Description
DeleteSkillOperation The pending LRO if wait_for_completion is False, otherwise None (blocks until done).

get

get(
    *,
    name: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.common.GetSkillConfig,
            vertexai._genai.types.common.GetSkillConfigDict,
        ]
    ] = None
) -> vertexai._genai.types.common.Skill

Gets a Skill.

list

list(
    *,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.common.ListSkillsConfig,
            vertexai._genai.types.common.ListSkillsConfigDict,
        ]
    ] = None
) -> typing.Iterator[vertexai._genai.types.common.Skill]

Lists Skills in the Skill Registry.

Parameter
Name Description
config ListSkillsConfigOrDict

Optional. Additional configuration for listing Skills.
Returns
Type Description
Iterator[Skill] An iterator (Pager) of Skills.

retrieve

retrieve(
    *,
    query: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.common.RetrieveSkillsConfig,
            vertexai._genai.types.common.RetrieveSkillsConfigDict,
        ]
    ] = None
) -> vertexai._genai.types.common.RetrieveSkillsResponse

Retrieves skills semantically matched to a query.

update

update(
    *,
    name: str,
    config: typing.Optional[
        typing.Union[
            vertexai._genai.types.common.UpdateSkillConfig,
            vertexai._genai.types.common.UpdateSkillConfigDict,
        ]
    ] = None
) -> typing.Union[
    vertexai._genai.types.common.Skill, vertexai._genai.types.common.SkillOperation
]

Updates an existing Skill.

Parameters
Name Description
name str

Required. The resource name of the Skill to update. Format: projects/{project}/locations/{location}/skills/{skill}
config UpdateSkillConfigOrDict

Optional. The configuration for updating the Skill.
Returns
Type Description
Skill The updated Skill if wait_for_completion is True. SkillOperation: The operation for updating the Skill if wait_for_completion is False.