comet_llm
init ΒΆ
init(
api_key: Optional[str] = None,
workspace: Optional[str] = None,
project: Optional[str] = None,
) -> None
An easy, safe, interactive way to set and save your settings.
Will ask for your api_key if not already set. Your api_key will not be shown.
Will save the config to .comet.config file. Default location is "~/" (home) or COMET_CONFIG, if set.
Parameters:
api_key
(Optional[str]
, default:None
) βComet API key.
workspace
(Optional[str]
, default:None
) βComet workspace to use for logging.
project
(Optional[str]
, default:None
) βProject name to create in comet workspace.
log_prompt ΒΆ
log_prompt(
prompt: str,
output: str,
workspace: Optional[str] = None,
project: Optional[str] = None,
tags: Optional[List[str]] = None,
api_key: Optional[str] = None,
prompt_template: Optional[str] = None,
prompt_template_variables: Optional[
Dict[str, Union[str, bool, float, None]]
] = None,
metadata: Optional[Dict[str, Union[str, bool, float, None]]] = None,
timestamp: Optional[float] = None,
duration: Optional[float] = None,
) -> Optional[llm_result.LLMResult]
Logs a single prompt and output to Comet platform.
Parameters:
prompt
(str
) βInput prompt to LLM.
output
(str
) βOutput from LLM.
workspace
(Optional[str]
, default:None
) βComet workspace to use for logging.
project
(Optional[str]
, default:None
) βProject name to create in comet workspace.
tags
(Optional[List[str]]
, default:None
) βUser-defined tags attached to a prompt call.
api_key
(Optional[str]
, default:None
) βComet API key.
prompt_template
(Optional[str]
, default:None
) βUser-defined template used for creating a prompt.
prompt_template_variables
(Optional[Dict[str, Union[str, bool, float, None]]]
, default:None
) βDictionary with data used in prompt_template to build a prompt.
metadata
(Optional[Dict[str, Union[str, bool, float, None]]]
, default:None
) βUser-defined dictionary with additional metadata to the call.
timestamp
(Optional[float]
, default:None
) βTimestamp of prompt call in seconds
duration
(Optional[float]
, default:None
) βDuration of prompt call
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
|
log_user_feedback ΒΆ
log_user_feedback(id: str, score: float, api_key: Optional[str] = None) -> None
Logs user feedback for the provided Prompt or Chain ID. This will overwrite any previously set value.
Parameters:
id
(str
) βThe ID of the Prompt or Chain.
score
(float
) βThe feedback score, can be either 0, 0.0, 1, or 1.0.
api_key
(Optional[str]
, default:None
) βComet API key.
start_chain ΒΆ
start_chain(
inputs: Dict[str, JSONEncodable],
api_key: Optional[str] = None,
workspace: Optional[str] = None,
project: Optional[str] = None,
metadata: Optional[Dict[str, Dict[str, JSONEncodable]]] = None,
tags: Optional[List[str]] = None,
) -> None
Creates global Chain object that tracks created Spans.
Parameters:
inputs
(Dict[str, JSONEncodable]
) βChain inputs.
workspace
(Optional[str]
, default:None
) βComet workspace to use for logging.
project
(Optional[str]
, default:None
) βProject name to create in comet workspace.
tags
(Optional[List[str]]
, default:None
) βUser-defined tags attached to a prompt call.
api_key
(Optional[str]
, default:None
) βComet API key.
metadata
(Optional[Dict[str, Dict[str, JSONEncodable]]]
, default:None
) βUser-defined dictionary with additional metadata to the call.
tags
(Optional[List[str]]
, default:None
) βUser-defined tags attached to the chain
Span ΒΆ
Span(
inputs: JSONEncodable,
category: str,
name: Optional[str] = None,
metadata: Optional[Dict[str, JSONEncodable]] = None,
)
A single unit of Chain that has its own context. Spans can be nested, in that case inner one exist in the context of the outer(parent) one. Outer Span is considered to be a parent for an inner one.
Parameters:
inputs
(JSONEncodable
) βSpan inputs.
category
(str
) βSpan category.
name
(Optional[str]
, default:None
) βSpan name. If not set will be generated automatically.
metadata
(Optional[Dict[str, JSONEncodable]]
, default:None
) βSpan metadata.
set_outputs ΒΆ
set_outputs(
outputs: Dict[str, JSONEncodable],
metadata: Optional[Dict[str, JSONEncodable]] = None,
) -> None
Sets outputs to span object.
Parameters:
outputs
(Dict[str, JSONEncodable]
) βOutputs.
metadata
(Optional[Dict[str, JSONEncodable]]
, default:None
) βSpan metadata. If metadata dictionary was passed to init method, it will be updated.
end_chain ΒΆ
end_chain(
outputs: Dict[str, JSONEncodable],
metadata: Optional[Dict[str, JSONEncodable]] = None,
) -> Optional[llm_result.LLMResult]
Commits global chain and logs the result to Comet.
Parameters:
outputs
(Dict[str, JSONEncodable]
) βChain outputs.
metadata
(Optional[Dict[str, JSONEncodable]]
, default:None
) βUser-defined dictionary with additional metadata to the call. This metadata will be deep merged with the metadata passed to start_chain if it was provided.
tags
βUser-defined tags attached to the chain