langsmith.client.Client.update_prompt#

Client.update_prompt(prompt_identifier: str, *, description: str | None = None, readme: str | None = None, tags: Sequence[str] | None = None, is_public: bool | None = None, is_archived: bool | None = None) → Dict[str, Any][source]#

Update a prompt’s metadata.

To update the content of a prompt, use push_prompt or create_commit instead.

Parameters:

prompt_identifier (str) – The identifier of the prompt to update.
description (Optional[str]) – New description for the prompt.
readme (Optional[str]) – New readme for the prompt.
tags (Optional[Sequence[str]]) – New list of tags for the prompt.
is_public (Optional[bool]) – New public status for the prompt.
is_archived (Optional[bool]) – New archived status for the prompt.

Returns:

The updated prompt data as returned by the server.

Return type:

Dict[str, Any]

Raises:

ValueError – If the prompt_identifier is empty.
HTTPError – If the server request fails.