document response fields (microsoft#1199)

whiskyboy · Aug 28, 2023 · 80182d1 · 80182d1
1 parent 7d6d1d2
commit 80182d1
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/flaml/autogen/oai/completion.py b/flaml/autogen/oai/completion.py
@@ -746,7 +746,11 @@ def yes_or_no_filter(context, config, response):
                 Also, the "prompt" or "messages" parameter can contain a template (str or Callable) which will be instantiated with the context.
 
         Returns:
-            Responses from OpenAI API.
+            Responses from OpenAI API, with additional fields.
+                - `cost`: the total cost.
+            When `config_list` is provided, the response will contain a few more fields:
+                - `config_id`: the index of the config in the config_list that is used to generate the response.
+                - `pass_filter`: whether the response passes the filter function. None if no filter is provided.
         """
         if ERROR:
             raise ERROR