langsmith.client.Client.push_prompt#

Client.push_prompt(prompt_identifier: str, *, object: Any | None = None, parent_commit_hash: str = 'latest', is_public: bool | None = None, description: str | None = None, readme: str | None = None, tags: Sequence[str] | None = None) → str[source]#

Push a prompt to the LangSmith API.

Can be used to update prompt metadata or prompt content.

If the prompt does not exist, it will be created. If the prompt exists, it will be updated.

Parameters:

  • prompt_identifier (str) – The identifier of the prompt.

  • object (Optional[Any]) – The LangChain object to push.

  • parent_commit_hash (str) – The parent commit hash. Defaults to “latest”.

  • is_public (Optional[bool]) – Whether the prompt should be public. If None (default), the current visibility status is maintained for existing prompts. For new prompts, None defaults to private. Set to True to make public, or False to make private.

  • description (Optional[str]) – A description of the prompt. Defaults to an empty string.

  • readme (Optional[str]) – A readme for the prompt. Defaults to an empty string.

  • tags (Optional[Sequence[str]]) – A list of tags for the prompt. Defaults to an empty list.

Returns:

The URL of the prompt.

Return type:

str

On this page