langchain-githubcopilot-chat 0.1.0__py3-none-any.whl

langchain_githubcopilot_chat/document_loaders.py

@@ -0,0 +1,73 @@
+"""GithubcopilotChat document loader."""
+
+from typing import Iterator
+
+from langchain_core.document_loaders.base import BaseLoader
+from langchain_core.documents import Document
+
+
+class GithubcopilotChatLoader(BaseLoader):
+    # TODO: Replace all TODOs in docstring. See example docstring:
+    # https://github.com/langchain-ai/langchain/blob/869523ad728e6b76d77f170cce13925b4ebc3c1e/libs/community/langchain_community/document_loaders/recursive_url_loader.py#L54
+    """
+    GithubcopilotChat document loader integration
+
+    # TODO: Replace with relevant packages, env vars.
+    Setup:
+        Install ``langchain-githubcopilot-chat`` and set environment variable ``GITHUBCOPILOTCHAT_API_KEY``.
+
+        .. code-block:: bash
+
+            pip install -U langchain-githubcopilot-chat
+            export GITHUBCOPILOTCHAT_API_KEY="your-api-key"
+
+    # TODO: Replace with relevant init params.
+    Instantiate:
+        .. code-block:: python
+
+            from langchain_community.document_loaders import GithubcopilotChatLoader
+
+            loader = GithubcopilotChatLoader(
+                # required params = ...
+                # other params = ...
+            )
+
+    Lazy load:
+        .. code-block:: python
+
+            docs = []
+            docs_lazy = loader.lazy_load()
+
+            # async variant:
+            # docs_lazy = await loader.alazy_load()
+
+            for doc in docs_lazy:
+                docs.append(doc)
+            print(docs[0].page_content[:100])
+            print(docs[0].metadata)
+
+        .. code-block:: python
+
+            TODO: Example output
+
+    # TODO: Delete if async load is not implemented
+    Async load:
+        .. code-block:: python
+
+            docs = await loader.aload()
+            print(docs[0].page_content[:100])
+            print(docs[0].metadata)
+
+        .. code-block:: python
+
+            TODO: Example output
+
+    """  # noqa: E501
+
+    # TODO: This method must be implemented to load documents.
+    # Do not implement load(), a default implementation is already available.
+    def lazy_load(self) -> Iterator[Document]:
+        raise NotImplementedError()
+
+    # TODO: Implement if you would like to change default BaseLoader implementation
+    # async def alazy_load(self) -> AsyncIterator[Document]:

langchain_githubcopilot_chat/embeddings.py

@@ -0,0 +1,96 @@
+from typing import List
+
+from langchain_core.embeddings import Embeddings
+
+
+class GithubcopilotChatEmbeddings(Embeddings):
+    """GithubcopilotChat embedding model integration.
+
+    # TODO: Replace with relevant packages, env vars.
+    Setup:
+        Install ``langchain-githubcopilot-chat`` and set environment variable
+        ``GITHUBCOPILOTCHAT_API_KEY``.
+
+        .. code-block:: bash
+
+            pip install -U langchain-githubcopilot-chat
+            export GITHUBCOPILOTCHAT_API_KEY="your-api-key"
+
+    # TODO: Populate with relevant params.
+    Key init args — completion params:
+        model: str
+            Name of GithubcopilotChat model to use.
+
+    See full list of supported init args and their descriptions in the params section.
+
+    # TODO: Replace with relevant init params.
+    Instantiate:
+        .. code-block:: python
+
+            from langchain_githubcopilot_chat import GithubcopilotChatEmbeddings
+
+            embed = GithubcopilotChatEmbeddings(
+                model="...",
+                # api_key="...",
+                # other params...
+            )
+
+    Embed single text:
+        .. code-block:: python
+
+            input_text = "The meaning of life is 42"
+            embed.embed_query(input_text)
+
+        .. code-block:: python
+
+            # TODO: Example output.
+
+    # TODO: Delete if token-level streaming isn't supported.
+    Embed multiple text:
+        .. code-block:: python
+
+             input_texts = ["Document 1...", "Document 2..."]
+            embed.embed_documents(input_texts)
+
+        .. code-block:: python
+
+            # TODO: Example output.
+
+    # TODO: Delete if native async isn't supported.
+    Async:
+        .. code-block:: python
+
+            await embed.aembed_query(input_text)
+
+            # multiple:
+            # await embed.aembed_documents(input_texts)
+
+        .. code-block:: python
+
+            # TODO: Example output.
+
+    """
+
+    def __init__(self, model: str):
+        self.model = model
+
+    def embed_documents(self, texts: List[str]) -> List[List[float]]:
+        """Embed search docs."""
+        return [[0.5, 0.6, 0.7] for _ in texts]
+
+    def embed_query(self, text: str) -> List[float]:
+        """Embed query text."""
+        return self.embed_documents([text])[0]
+
+    # optional: add custom async implementations here
+    # you can also delete these, and the base class will
+    # use the default implementation, which calls the sync
+    # version in an async executor:
+
+    # async def aembed_documents(self, texts: List[str]) -> List[List[float]]:
+    #     """Asynchronous Embed search docs."""
+    #     ...
+
+    # async def aembed_query(self, text: str) -> List[float]:
+    #     """Asynchronous Embed query text."""
+    #     ...

langchain_githubcopilot_chat/retrievers.py

@@ -0,0 +1,107 @@
+"""GithubcopilotChat retrievers."""
+
+from typing import Any, List
+
+from langchain_core.callbacks import CallbackManagerForRetrieverRun
+from langchain_core.documents import Document
+from langchain_core.retrievers import BaseRetriever
+
+
+class GithubcopilotChatRetriever(BaseRetriever):
+    # TODO: Replace all TODOs in docstring. See example docstring:
+    # https://github.com/langchain-ai/langchain/blob/master/libs/community/langchain_community/retrievers/tavily_search_api.py#L17
+    """GithubcopilotChat retriever.
+
+    # TODO: Replace with relevant packages, env vars, etc.
+    Setup:
+        Install ``langchain-githubcopilot-chat`` and set environment variable
+        ``GITHUBCOPILOTCHAT_API_KEY``.
+
+        .. code-block:: bash
+
+            pip install -U langchain-githubcopilot-chat
+            export GITHUBCOPILOTCHAT_API_KEY="your-api-key"
+
+    # TODO: Populate with relevant params.
+    Key init args:
+        arg 1: type
+            description
+        arg 2: type
+            description
+
+    # TODO: Replace with relevant init params.
+    Instantiate:
+        .. code-block:: python
+
+            from langchain-githubcopilot-chat import GithubcopilotChatRetriever
+
+            retriever = GithubcopilotChatRetriever(
+                # ...
+            )
+
+    Usage:
+        .. code-block:: python
+
+            query = "..."
+
+            retriever.invoke(query)
+
+        .. code-block:: none
+
+            # TODO: Example output.
+
+    Use within a chain:
+        .. code-block:: python
+
+            from langchain_core.output_parsers import StrOutputParser
+            from langchain_core.prompts import ChatPromptTemplate
+            from langchain_core.runnables import RunnablePassthrough
+            from langchain_openai import ChatOpenAI
+
+            prompt = ChatPromptTemplate.from_template(
+                \"\"\"Answer the question based only on the context provided.
+
+            Context: {context}
+
+            Question: {question}\"\"\"
+            )
+
+            llm = ChatOpenAI(model="gpt-3.5-turbo-0125")
+
+            def format_docs(docs):
+                return "\\n\\n".join(doc.page_content for doc in docs)
+
+            chain = (
+                {"context": retriever | format_docs, "question": RunnablePassthrough()}
+                | prompt
+                | llm
+                | StrOutputParser()
+            )
+
+            chain.invoke("...")
+
+        .. code-block:: none
+
+             # TODO: Example output.
+
+    """
+
+    k: int = 3
+
+    # TODO: This method must be implemented to retrieve documents.
+    def _get_relevant_documents(
+        self, query: str, *, run_manager: CallbackManagerForRetrieverRun, **kwargs: Any
+    ) -> List[Document]:
+        k = kwargs.get("k", self.k)
+        return [
+            Document(page_content=f"Result {i} for query: {query}") for i in range(k)
+        ]
+
+    # optional: add custom async implementations here
+    # async def _aget_relevant_documents(
+    #     self,
+    #     query: str,
+    #     *,
+    #     run_manager: AsyncCallbackManagerForRetrieverRun,
+    #     **kwargs: Any,
+    # ) -> List[Document]: ...

langchain_githubcopilot_chat/toolkits.py

@@ -0,0 +1,72 @@
+"""GithubcopilotChat toolkits."""
+
+from typing import List
+
+from langchain_core.tools import BaseTool, BaseToolkit
+
+
+class GithubcopilotChatToolkit(BaseToolkit):
+    # TODO: Replace all TODOs in docstring. See example docstring:
+    # https://github.com/langchain-ai/langchain/blob/c123cb2b304f52ab65db4714eeec46af69a861ec/libs/community/langchain_community/agent_toolkits/sql/toolkit.py#L19
+    """GithubcopilotChat toolkit.
+
+    # TODO: Replace with relevant packages, env vars, etc.
+    Setup:
+        Install ``langchain-githubcopilot-chat`` and set environment variable ``GITHUBCOPILOTCHAT_API_KEY``.
+
+        .. code-block:: bash
+
+            pip install -U langchain-githubcopilot-chat
+            export GITHUBCOPILOTCHAT_API_KEY="your-api-key"
+
+    # TODO: Populate with relevant params.
+    Key init args:
+        arg 1: type
+            description
+        arg 2: type
+            description
+
+    # TODO: Replace with relevant init params.
+    Instantiate:
+        .. code-block:: python
+
+            from langchain-githubcopilot-chat import GithubcopilotChatToolkit
+
+            toolkit = GithubcopilotChatToolkit(
+                # ...
+            )
+
+    Tools:
+        .. code-block:: python
+
+            toolkit.get_tools()
+
+        .. code-block:: none
+
+            # TODO: Example output.
+
+    Use within an agent:
+        .. code-block:: python
+
+            from langgraph.prebuilt import create_react_agent
+
+            agent_executor = create_react_agent(llm, tools)
+
+            example_query = "..."
+
+            events = agent_executor.stream(
+                {"messages": [("user", example_query)]},
+                stream_mode="values",
+            )
+            for event in events:
+                event["messages"][-1].pretty_print()
+
+        .. code-block:: none
+
+             # TODO: Example output.
+
+    """  # noqa: E501
+
+    # TODO: This method must be implemented to list tools.
+    def get_tools(self) -> List[BaseTool]:
+        raise NotImplementedError()

langchain_githubcopilot_chat/tools.py

@@ -0,0 +1,94 @@
+"""GithubcopilotChat tools."""
+
+from typing import Optional, Type
+
+from langchain_core.callbacks import (
+    CallbackManagerForToolRun,
+)
+from langchain_core.tools import BaseTool
+from pydantic import BaseModel, Field
+
+
+class GithubcopilotChatToolInput(BaseModel):
+    """Input schema for GithubcopilotChat tool.
+
+    This docstring is **not** part of what is sent to the model when performing tool
+    calling. The Field default values and descriptions **are** part of what is sent to
+    the model when performing tool calling.
+    """
+
+    # TODO: Add input args and descriptions.
+    a: int = Field(..., description="first number to add")
+    b: int = Field(..., description="second number to add")
+
+
+class GithubcopilotChatTool(BaseTool):  # type: ignore[override]
+    """GithubcopilotChat tool.
+
+    Setup:
+        # TODO: Replace with relevant packages, env vars.
+        Install ``langchain-githubcopilot-chat`` and set environment variable ``GITHUBCOPILOTCHAT_API_KEY``.
+
+        .. code-block:: bash
+
+            pip install -U langchain-githubcopilot-chat
+            export GITHUBCOPILOTCHAT_API_KEY="your-api-key"
+
+    Instantiation:
+        .. code-block:: python
+
+            tool = GithubcopilotChatTool(
+                # TODO: init params
+            )
+
+    Invocation with args:
+        .. code-block:: python
+
+            # TODO: invoke args
+            tool.invoke({...})
+
+        .. code-block:: python
+
+            # TODO: output of invocation
+
+    Invocation with ToolCall:
+
+        .. code-block:: python
+
+            # TODO: invoke args
+            tool.invoke({"args": {...}, "id": "1", "name": tool.name, "type": "tool_call"})
+
+        .. code-block:: python
+
+            # TODO: output of invocation
+
+    """  # noqa: E501
+
+    # TODO: Set tool name and description
+    name: str = "TODO: Tool name"
+    """The name that is passed to the model when performing tool calling."""
+    description: str = "TODO: Tool description."
+    """The description that is passed to the model when performing tool calling."""
+    args_schema: Type[BaseModel] = GithubcopilotChatToolInput
+    """The schema that is passed to the model when performing tool calling."""
+
+    # TODO: Add any other init params for the tool.
+    # param1: Optional[str]
+    # """param1 determines foobar"""
+
+    # TODO: Replaced (a, b) with real tool arguments.
+    def _run(
+        self, a: int, b: int, *, run_manager: Optional[CallbackManagerForToolRun] = None
+    ) -> str:
+        return str(a + b + 80)
+
+    # TODO: Implement if tool has native async functionality, otherwise delete.
+
+    # async def _arun(
+    #     self,
+    #     a: int,
+    #     b: int,
+    #     *,
+    #     run_manager: Optional[AsyncCallbackManagerForToolRun] = None,
+    # ) -> str:
+    #     ...