From 57ec452c0944ba3e0319ce56ef86e3e68f4bac6e Mon Sep 17 00:00:00 2001 From: pranavvuppala Date: Tue, 4 Jun 2024 22:54:17 +0530 Subject: [PATCH] docs : Update docstrings for OpenAI base.py (#22221) - [x] **PR title**: Update docstrings for OpenAI base.py -**Description:** Updated the docstring of few OpenAI functions for a better understanding of the function. - **Issue:** #21983 --------- Co-authored-by: Bagatur --- .../agents/openai_assistant/base.py | 23 +++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/libs/community/langchain_community/agents/openai_assistant/base.py b/libs/community/langchain_community/agents/openai_assistant/base.py index fc977d7c00c25..7b2bfd81c40ae 100644 --- a/libs/community/langchain_community/agents/openai_assistant/base.py +++ b/libs/community/langchain_community/agents/openai_assistant/base.py @@ -61,7 +61,12 @@ def _get_openai_async_client() -> openai.AsyncOpenAI: def _convert_file_ids_into_attachments(file_ids: list) -> list: """ Convert file_ids into attachments - File search and Code interpreter will be turned on by default + File search and Code interpreter will be turned on by default. + + Args: + file_ids (list): List of file_ids that need to be converted into attachments. + Returns: + A list of attachments that are converted from file_ids. """ attachments = [] for id in file_ids: @@ -77,7 +82,15 @@ def _convert_file_ids_into_attachments(file_ids: list) -> list: def _is_assistants_builtin_tool( tool: Union[Dict[str, Any], Type[BaseModel], Callable, BaseTool], ) -> bool: - """Determine if tool corresponds to OpenAI Assistants built-in.""" + """ + Determine if tool corresponds to OpenAI Assistants built-in. + + Args: + tool : Tool that needs to be determined + Returns: + A boolean response of true or false indicating if the tool corresponds to + OpenAI Assistants built-in. + """ assistants_builtin_tools = ("code_interpreter", "retrieval") return ( isinstance(tool, dict) @@ -93,6 +106,12 @@ def _get_assistants_tool( Note that OpenAI assistants supports several built-in tools, such as "code_interpreter" and "retrieval." + + Args: + tool: Tools or functions that need to be converted to OpenAI tools. + Returns: + A dictionary of tools that are converted into OpenAI tools. + """ if _is_assistants_builtin_tool(tool): return tool # type: ignore