Skip to content

Update log_prompt docstring #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexkuzmik merged 1 commit into from
May 23, 2023
Merged

Update log_prompt docstring #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions src/comet_llm/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,8 @@ def log_prompt(
duration: Optional[float] = None,
) -> None:
"""
Returns a Comet API Key Secret that can be used instead of a clear-text API Key when creating an
Experiment or API object. The Comet API Key Secret is a string that represents the location of
the secret in the GCP Secret Manager without containing the API Key. This means
`get_api_key_from_secret_manager` doesn't need permission or access to GCP Secret Manager.

Logs a single prompt and output to Comet platform.

Args:
prompt: JSONEncodable (required) input prompt to LLM.
outputs: JSONEncodable (required), outputs from LLM.
Expand All @@ -57,6 +54,7 @@ def log_prompt(
start_timestamp: float (optional) start timestamp of prompt call
end_timestamp: float (optional) end timestamp of prompt call
duration: float (optional) duration of prompt call

Example:

```python
Expand Down