Skip to content
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
add docs for relevance
  • Loading branch information
needuv committed Oct 25, 2024
commit ce01a37f27e3ba47f8a94d14db480bc8b8134a78
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,18 @@ def __call__(
response: str,
context: str,
) -> Dict[str, float]:
"""Evaluate groundedness for given input of query, response, context

:keyword query: The query to be evaluated.
:paramtype query: str
:keyword response: The response to be evaluated.
:paramtype response: str
:keyword context: The context to be evaluated.
:paramtype context: str
:return: The relevance score.
:rtype: Dict[str, float]
"""

...

@overload
Expand All @@ -71,6 +83,15 @@ def __call__(
conversation: Conversation,
**kwargs,
) -> Dict[str, Union[float, Dict[str, List[float]]]]:
"""Evaluate relevance for a conversation

:keyword conversation: The conversation to evaluate. Expected to contain a list of conversation turns under the
key "messages", and potentially a global context under the key "context". Conversation turns are expected
to be dictionaries with keys "content", "role", and possibly "context".
:paramtype conversation: Optional[~azure.ai.evaluation.Conversation]
:return: The relevance score.
:rtype: Dict[str, Union[float, Dict[str, List[float]]]]
"""
...


Expand Down