Skip to content

Commit

Permalink
docs : Update docstrings for OpenAI base.py (#22221)
Browse files Browse the repository at this point in the history
- [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 <baskaryan@gmail.com>
  • Loading branch information
2 people authored and hinthornw committed Jun 20, 2024
1 parent 8f59c47 commit 57ec452
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions libs/community/langchain_community/agents/openai_assistant/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)
Expand All @@ -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
Expand Down

0 comments on commit 57ec452

Please sign in to comment.