chainlit 0.7.604rc2__py3-none-any.whl → 1.0.0rc0__py3-none-any.whl

chainlit/types.py

@@ -1,9 +1,12 @@
 from enum import Enum
-from typing import Dict, List, Literal, Optional, TypedDict, Union
+from typing import TYPE_CHECKING, Dict, List, Literal, Optional, TypedDict, Union
 
-from chainlit.client.base import ConversationFilter, MessageDict, Pagination
-from chainlit.element import File
-from chainlit.prompt import Prompt
+if TYPE_CHECKING:
+    from chainlit.element import ElementDict
+    from chainlit.user import UserDict
+    from chainlit.step import StepDict
+
+from chainlit_client import ChatGeneration, CompletionGeneration
 from dataclasses_json import DataClassJsonMixin
 from pydantic import BaseModel
 from pydantic.dataclasses import dataclass
@@ -13,6 +16,27 @@ InputWidgetType = Literal[
 ]
 
 
+class ThreadDict(TypedDict):
+    id: str
+    createdAt: str
+    user: Optional["UserDict"]
+    tags: Optional[List[str]]
+    metadata: Optional[Dict]
+    steps: List["StepDict"]
+    elements: Optional[List["ElementDict"]]
+
+
+class Pagination(BaseModel):
+    first: int
+    cursor: Optional[str] = None
+
+
+class ThreadFilter(BaseModel):
+    feedback: Optional[Literal[-1, 0, 1]] = None
+    userIdentifier: Optional[str] = None
+    search: Optional[str] = None
+
+
 @dataclass
 class FileSpec(DataClassJsonMixin):
     accept: Union[List[str], Dict[str, List[str]]]
@@ -43,23 +67,30 @@ class AskActionSpec(ActionSpec, AskSpec, DataClassJsonMixin):
     """Specification for asking the user an action"""
 
 
-class AskResponse(TypedDict):
-    content: str
-    author: str
+class FileReference(TypedDict):
+    id: str
+
+
+class FileDict(TypedDict):
+    id: str
+    name: str
+    path: str
+    size: int
+    type: str
 
 
 class UIMessagePayload(TypedDict):
-    message: MessageDict
-    files: Optional[List[Dict]]
+    message: "StepDict"
+    fileReferences: Optional[List[FileReference]]
 
 
 @dataclass
 class AskFileResponse:
+    id: str
     name: str
     path: str
     size: int
     type: str
-    content: bytes
 
 
 class AskActionResponse(TypedDict):
@@ -72,24 +103,28 @@ class AskActionResponse(TypedDict):
     collapsed: bool
 
 
-class CompletionRequest(BaseModel):
-    prompt: Prompt
+class GenerationRequest(BaseModel):
+    chatGeneration: Optional[ChatGeneration] = None
+    completionGeneration: Optional[CompletionGeneration] = None
     userEnv: Dict[str, str]
 
+    @property
+    def generation(self):
+        if self.chatGeneration:
+            return self.chatGeneration
+        return self.completionGeneration
 
-class UpdateFeedbackRequest(BaseModel):
-    messageId: str
-    feedback: Literal[-1, 0, 1]
-    feedbackComment: Optional[str] = None
+    def is_chat(self):
+        return self.chatGeneration is not None
 
 
-class DeleteConversationRequest(BaseModel):
-    conversationId: str
+class DeleteThreadRequest(BaseModel):
+    threadId: str
 
 
-class GetConversationsRequest(BaseModel):
+class GetThreadsRequest(BaseModel):
     pagination: Pagination
-    filter: ConversationFilter
+    filter: ThreadFilter
 
 
 class Theme(str, Enum):
@@ -99,8 +134,30 @@ class Theme(str, Enum):
 
 @dataclass
 class ChatProfile(DataClassJsonMixin):
-    """Specification for a chat profile that can be chosen by the user at the conversation start."""
+    """Specification for a chat profile that can be chosen by the user at the thread start."""
 
     name: str
     markdown_description: str
     icon: Optional[str] = None
+
+
+FeedbackStrategy = Literal["BINARY"]
+
+
+class FeedbackDict(TypedDict):
+    value: Literal[-1, 0, 1]
+    strategy: FeedbackStrategy
+    comment: Optional[str]
+
+
+@dataclass
+class Feedback:
+    forId: str
+    value: Literal[-1, 0, 1]
+    strategy: FeedbackStrategy = "BINARY"
+    id: Optional[str] = None
+    comment: Optional[str] = None
+
+
+class UpdateFeedbackRequest(BaseModel):
+    feedback: Feedback

chainlit/user.py

@@ -0,0 +1,32 @@
+from typing import Dict, Literal, TypedDict
+
+from dataclasses_json import DataClassJsonMixin
+from pydantic.dataclasses import Field, dataclass
+
+Provider = Literal[
+    "credentials", "header", "github", "google", "azure-ad", "okta", "auth0", "descope"
+]
+
+
+class UserDict(TypedDict):
+    id: str
+    identifier: str
+    metadata: Dict
+
+
+# Used when logging-in a user
+@dataclass
+class User(DataClassJsonMixin):
+    identifier: str
+    metadata: Dict = Field(default_factory=dict)
+
+
+@dataclass
+class PersistedUserFields:
+    id: str
+    createdAt: str
+
+
+@dataclass
+class PersistedUser(User, PersistedUserFields):
+    pass

chainlit/user_session.py

@@ -1,8 +1,4 @@
-from typing import TYPE_CHECKING, Dict, Optional, TypedDict, Union
-
-if TYPE_CHECKING:
-    from chainlit.message import Message
-    from chainlit.client.base import AppUser, PersistedAppUser
+from typing import Dict
 
 from chainlit.context import context
 

{chainlit-0.7.604rc2.dist-info → chainlit-1.0.0rc0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: chainlit
-Version: 0.7.604rc2
+Version: 1.0.0rc0
 Summary: A faster way to build chatbot UIs.
 Home-page: https://github.com/Chainlit/chainlit
 License: Apache-2.0 license
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: aiofiles (>=23.1.0,<24.0.0)
 Requires-Dist: asyncer (>=0.0.2,<0.0.3)
+Requires-Dist: chainlit_client (==0.1.0rc4)
 Requires-Dist: click (>=8.1.3,<9.0.0)
 Requires-Dist: dataclasses_json (>=0.5.7,<0.6.0)
 Requires-Dist: fastapi (>=0.100,<0.101)
@@ -46,13 +47,7 @@ Description-Content-Type: text/markdown
 
 Chainlit is an open-source async Python framework that makes it incredibly fast to build Chat GPT like applications with your **own business logic and data**.
 
-Key features:
-
-- [💬 Multi Modal chats](https://docs.chainlit.io/chat-experience/elements)
-- [💭 Chain of Thought visualisation](https://docs.chainlit.io/observability-iteration/chain-of-thought)
-- [💾 Data persistence + human feedback](https://docs.chainlit.io/chat-data/overview)
-- [🛝 In context Prompt Playground](https://docs.chainlit.io/observability-iteration/prompt-playground/overview)
-- [👤 Authentication](https://docs.chainlit.io/authentication/overview)
+Contact us [here](https://forms.gle/BX3UNBLmTF75KgZVA) for **Enterprise Support** and to get early access to the **Analytics & Observability** product.
 
 https://github.com/Chainlit/chainlit/assets/13104895/8882af90-fdfa-4b24-8200-1ee96c6c7490
 
@@ -85,11 +80,16 @@ Create a new file `demo.py` with the following code:
 import chainlit as cl
 
 
+@cl.step
+def tool():
+    return "Response from the tool!"
+
+
 @cl.on_message  # this function will be called every time a user inputs a message in the UI
 async def main(message: cl.Message):
     """
     This function is called every time a user inputs a message in the UI.
-    It sends back an intermediate response from Tool 1, followed by the final answer.
+    It sends back an intermediate response from the tool, followed by the final answer.
 
     Args:
         message: The user's message.
@@ -98,15 +98,11 @@ async def main(message: cl.Message):
         None.
     """
 
-    # Send an intermediate response from Tool 1.
-    await cl.Message(
-        author="Tool 1",
-        content=f"Response from tool1",
-        parent_id=message.id,
-    ).send()
+    # Call the tool
+    tool()
 
     # Send the final answer.
-    await cl.Message(content=f"This is the final answer").send()
+    await cl.Message(content="This is the final answer").send()
 ```
 
 Now run it!
@@ -126,7 +122,6 @@ Chainlit is compatible with all Python programs and libraries. That being said,
 - [OpenAI Assistant](https://github.com/Chainlit/cookbook/tree/main/openai-assistant)
 - [Llama Index](https://docs.chainlit.io/integrations/llama-index)
 - [Haystack](https://docs.chainlit.io/integrations/haystack)
-- [Langflow](https://docs.chainlit.io/integrations/langflow)
 
 ## 🎨 Custom Frontend
 
@@ -145,22 +140,8 @@ To build and connect your own frontend, check out our [Custom Frontend Cookbook]
 
 You can find various examples of Chainlit apps [here](https://github.com/Chainlit/cookbook) that leverage tools and services such as OpenAI, Anthropiс, LangChain, LlamaIndex, ChromaDB, Pinecone and more.
 
-## 🛣 Roadmap
-
-- [x] Selectable chat profiles (at the beginning of a chat)
-- [ ] One click chat sharing
-- New clients:
-  - [x] Custom React app
-  - [ ] Slack
-  - [ ] Discord
-  - [ ] Website embbed
-
 Tell us what you would like to see added in Chainlit using the Github issues or on [Discord](https://discord.gg/k73SQ3FyUh).
 
-## 🏢 Enterprise support
-
-For entreprise grade features and self hosting, please visit this [page](https://docs.chainlit.io/cloud/persistence/enterprise) and fill the form.
-
 ## 💁 Contributing
 
 As an open-source initiative in a rapidly evolving domain, we welcome contributions, be it through the addition of new features or the improvement of documentation.

chainlit-1.0.0rc0.dist-info/RECORD

@@ -0,0 +1,60 @@
+chainlit/__init__.py,sha256=yz2t0aQP7HV48o5XwSDzcn1UTQDTpbDLOoyQWjyS5oI,8998
+chainlit/__main__.py,sha256=7Vg3w3T3qDuz4KDu5lQhLH6lQ3cYdume7gHH7Z1V97U,87
+chainlit/action.py,sha256=k-GsblVHI4DnDWFyF-RZgq3KfdfAFICFh2OBeU4w8N8,1410
+chainlit/auth.py,sha256=q06SthxJAqCDYZuGOIYaye3CL4o3ldC-NIXASpeZUA8,2681
+chainlit/cache.py,sha256=Bv3dT4eHhE6Fq3c6Do0ZTpiyoXgXYewdxTgpYghEd9g,1361
+chainlit/chat_settings.py,sha256=2ByenmwS8O6jQjDVJjhhbLrBPGA5aY2F7R3VvQQxXPk,877
+chainlit/cli/__init__.py,sha256=aMynTbqbJEvxkoIzDjsdKL6wJ0HFgLfVrbxFkwqp1FU,4733
+chainlit/cli/utils.py,sha256=mE2d9oOk-B2b9ZvDV1zENoDWxjfMriGP7bVwEFduZP4,717
+chainlit/config.py,sha256=2DaQ51jHKHdwAH0yNbB3HkJhccU99eOqDXxvk19A1jU,10577
+chainlit/context.py,sha256=Su3eabnD2sgLNx5IwlxEpG4pev64GLi-GlvbE5Mw7sM,2264
+chainlit/data/__init__.py,sha256=dcmfMBPlzv4D5Vp3lBg4s9cEanx9E_OWmsIlzL4qbdQ,12876
+chainlit/data/acl.py,sha256=hx7Othkx12EitonyZD4iFIRVHwxBmBY2TKdwjPuZMSo,461
+chainlit/element.py,sha256=9dVK7frFjJvmmONWAZTU1LWvim3c4woisy9zX9iEH-s,10010
+chainlit/emitter.py,sha256=97HHD5jI62mtF8FfR_8m4okrm1AqL7jM-zDBqbIfjpE,10693
+chainlit/frontend/dist/assets/index-6aee009a.js,sha256=k_thBwlPbxngnLq6BIWODptjQdLB69AC_t70RSb9xc4,3103190
+chainlit/frontend/dist/assets/index-8942cb2d.css,sha256=iULLLdx-rywLKpSdrJuSZwAF22WLkNdLKypNpaN5PQY,6557
+chainlit/frontend/dist/assets/logo_dark-bc7401f6.svg,sha256=vHQB9g-n5OqOmuH3Fduuc7ZMg0EmMsGyO9cEnYwLbHg,8889
+chainlit/frontend/dist/assets/logo_light-f19fc2ea.svg,sha256=8Z_C6t-0V9QL9ldmLjaLfp2REcGDuaTeNynj6-6muNI,8891
+chainlit/frontend/dist/assets/react-plotly-2f07c02a.js,sha256=SktlbpTd6VvpHSPCRj2JTK79rsQ4y4gFLEk9XC-icaU,3739251
+chainlit/frontend/dist/favicon.svg,sha256=0Cy8x28obT5eWW3nxZRhsEvu6_zMqrqbg0y6hT3D0Q0,6455
+chainlit/frontend/dist/index.html,sha256=x7AoiD4tsnIAs4Y76CX7Na_1CzEPNU3iSk2UINMjmwA,959
+chainlit/haystack/__init__.py,sha256=uZ77YiPy-qleSTi3dQCDO9HE6S6F6GpJWmh7jO4cxXA,217
+chainlit/haystack/callbacks.py,sha256=0tbevNVa5hqN7Num6PGwm_DU_-ZdhfsVp9srKciotNE,4055
+chainlit/hello.py,sha256=LwENQWo5s5r8nNDn4iKSV77vX60Ky5r_qGjQhyi7qlY,416
+chainlit/input_widget.py,sha256=1Z1qn3YwaZ7upqqxZXtbfDxBlVobDjbZ3HtlNOj-U3E,4880
+chainlit/langchain/__init__.py,sha256=zErMw0_3ufSGeF9ye7X0ZX3wDat4mTOx97T40ePDO2g,217
+chainlit/langchain/callbacks.py,sha256=P1w2DRv2G_q5rHEp2nWvLKm6gBUWlA2VQgJB0iUO2XA,24035
+chainlit/langflow/__init__.py,sha256=wxhxdsl1yxdsRyNTgZticxFF_8VFtJJ4OdIy3tnEIyM,817
+chainlit/llama_index/__init__.py,sha256=c7wIUZmKTtZPU9zpdGpKTHctQaBWTuRGqTN0kkIkBcg,218
+chainlit/llama_index/callbacks.py,sha256=BAFyoL2VkoG5pt6_GHMJ58Xu39_T-trhBYL14XVsvWU,5595
+chainlit/logger.py,sha256=wTwRSZsLfXwWy6U4351IgWAm4KCMThgxm9EZpjGUEr4,373
+chainlit/markdown.py,sha256=L2IPPWxIlrhJZcKPfO1akomHdN3sgC2EvC2ilxR8MQs,1624
+chainlit/message.py,sha256=-5GTkSwvzwkeEXyO5jpoz5BDSjn8w5Kf5UKJoUOZXrE,17470
+chainlit/oauth_providers.py,sha256=M-kV0rq4HwhDHvzdVc7YvAV4xPj5ecHvWniMMUTJAOM,15209
+chainlit/playground/__init__.py,sha256=igNRcBgqLKPTjOQtTNhhGNJFmZn-Dl1fHRQzQSjDGTQ,80
+chainlit/playground/config.py,sha256=a6fnIU2IrYQDKU6zHF8qUD3ssUBD9UiTEN10pMxgnGY,998
+chainlit/playground/provider.py,sha256=mO4mC--c4LXOYWBvNWse90iTD3288yd5TVuIeqSVOgg,5173
+chainlit/playground/providers/__init__.py,sha256=L4Y7Udpexm769Jnf-mIeN-YGh6xaaMjF3rPxSfReiN4,225
+chainlit/playground/providers/anthropic.py,sha256=Fcozvo4I_hguOuQbI4XgdR8Y03SNNv9PhHZrVXm_4ZE,3447
+chainlit/playground/providers/huggingface.py,sha256=AmBmIzvfqBjswEI40jifb0OrMQkTk5rXCkGX7nMJ-bk,2130
+chainlit/playground/providers/langchain.py,sha256=paASoTD1JCwOh7sXuajtrDcYuMcWC1AnITa_Co7uQFU,2813
+chainlit/playground/providers/openai.py,sha256=61Rr_JqfrI5x3CoTdQUvcMm_Q2aXwIuD9aHKvfXvlEY,12593
+chainlit/playground/providers/vertexai.py,sha256=TwFyhNmbStUso0ShvoRzOQ5b4l8ErG1szxqjv4IRXE0,3678
+chainlit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+chainlit/secret.py,sha256=0MXq8YxTeL93K8IyAew5UgZmIIw9_yJ_Kg4iML6cdVM,296
+chainlit/server.py,sha256=KdjRGquRdDcimDuCHd0h78t2cVPvqJ82fKWMeBsZUJ0,20672
+chainlit/session.py,sha256=x5Wsid7yO3O6tbQCKLP-cP19wRK-NsnX0bkftL9S8ls,8336
+chainlit/socket.py,sha256=vPdAkSoIEKvGu3LuG7y7JP6IZFgFAk5dPW-t1aK6DB8,9066
+chainlit/step.py,sha256=qwQ7dfduxSMKeLh9yGMiFsqTOZmYiVO732i67EGrUCk,11806
+chainlit/sync.py,sha256=G1n-7-3WgXsN8y1bJkEyws_YwmHZIyDZoZUwhprigag,1235
+chainlit/telemetry.py,sha256=sIZzYk0YEmtWbOS8B5tf6aQfW-uKzwvVtajpbj8bLMw,3210
+chainlit/types.py,sha256=zEuxivoNAZg_3BzcWwGPpqz1xX8AoZQYpyWm9e8ZGTk,3361
+chainlit/user.py,sha256=Cw4uGz0ffivWFszv8W__EHwkvTHQ3Lj9hqpRCPxFujo,619
+chainlit/user_session.py,sha256=nyPx8vSICP8BhpPcW5h9vbHVf9ixj39SrkvJBUI_6zs,1368
+chainlit/utils.py,sha256=3HzhfZ4XJhBIe9sJ_3Lxv3lMH4mFXsi6nLBGqm8Gtdw,2571
+chainlit/version.py,sha256=iosXhlXclBwBqlADFKEilxAC2wWKbtuBKi87AmPi7s8,196
+chainlit-1.0.0rc0.dist-info/METADATA,sha256=jPxlnQwZUKwRRIVv2KgPJ8G9FwSIv9-ieu9SI6rUQb4,5508
+chainlit-1.0.0rc0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+chainlit-1.0.0rc0.dist-info/entry_points.txt,sha256=FrkqdjrFl8juSnvBndniyX7XuKojmUwO4ghRh-CFMQc,45
+chainlit-1.0.0rc0.dist-info/RECORD,,

chainlit/client/base.py

@@ -1,169 +0,0 @@
-from typing import (
-    Any,
-    Dict,
-    Generic,
-    List,
-    Literal,
-    Mapping,
-    Optional,
-    TypedDict,
-    TypeVar,
-)
-
-from chainlit.logger import logger
-from chainlit.prompt import Prompt
-from dataclasses_json import DataClassJsonMixin
-from pydantic import BaseModel, Field
-from pydantic.dataclasses import dataclass
-from python_graphql_client import GraphqlClient
-
-ElementType = Literal[
-    "image", "avatar", "text", "pdf", "tasklist", "audio", "video", "file", "plotly"
-]
-ElementDisplay = Literal["inline", "side", "page"]
-ElementSize = Literal["small", "medium", "large"]
-
-Role = Literal["USER", "ADMIN", "OWNER", "ANONYMOUS"]
-Provider = Literal[
-    "credentials", "header", "github", "google", "azure-ad", "okta", "auth0", "descope"
-]
-
-
-class AppUserDict(TypedDict):
-    id: str
-    username: str
-
-
-# Used when logging-in a user
-@dataclass
-class AppUser(DataClassJsonMixin):
-    username: str
-    role: Role = "USER"
-    tags: List[str] = Field(default_factory=list)
-    image: Optional[str] = None
-    provider: Optional[Provider] = None
-
-
-@dataclass
-class PersistedAppUserFields:
-    id: str
-    createdAt: int
-
-
-@dataclass
-class PersistedAppUser(AppUser, PersistedAppUserFields):
-    pass
-
-
-class MessageDict(TypedDict):
-    conversationId: Optional[str]
-    id: str
-    createdAt: Optional[int]
-    content: str
-    author: str
-    prompt: Optional[Prompt]
-    language: Optional[str]
-    parentId: Optional[str]
-    indent: Optional[int]
-    authorIsUser: Optional[bool]
-    waitForAnswer: Optional[bool]
-    isError: Optional[bool]
-    humanFeedback: Optional[int]
-    disableHumanFeedback: Optional[bool]
-
-
-class ElementDict(TypedDict):
-    id: str
-    conversationId: Optional[str]
-    type: ElementType
-    url: str
-    objectKey: Optional[str]
-    name: str
-    display: ElementDisplay
-    size: Optional[ElementSize]
-    language: Optional[str]
-    forIds: Optional[List[str]]
-    mime: Optional[str]
-
-
-class ConversationDict(TypedDict):
-    id: Optional[str]
-    metadata: Optional[Dict]
-    createdAt: Optional[int]
-    appUser: Optional[AppUserDict]
-    messages: List[MessageDict]
-    elements: Optional[List[ElementDict]]
-
-
-@dataclass
-class PageInfo:
-    hasNextPage: bool
-    endCursor: Optional[str]
-
-
-T = TypeVar("T")
-
-
-@dataclass
-class PaginatedResponse(DataClassJsonMixin, Generic[T]):
-    pageInfo: PageInfo
-    data: List[T]
-
-
-class Pagination(BaseModel):
-    first: int
-    cursor: Optional[str] = None
-
-
-class ConversationFilter(BaseModel):
-    feedback: Optional[Literal[-1, 0, 1]] = None
-    username: Optional[str] = None
-    search: Optional[str] = None
-
-
-class ChainlitGraphQLClient:
-    def __init__(self, api_key: str, chainlit_server: str):
-        self.headers = {"content-type": "application/json"}
-        if api_key:
-            self.headers["x-api-key"] = api_key
-        else:
-            raise ValueError("Cannot instantiate Cloud Client without CHAINLIT_API_KEY")
-
-        graphql_endpoint = f"{chainlit_server}/api/graphql"
-        self.graphql_client = GraphqlClient(
-            endpoint=graphql_endpoint, headers=self.headers
-        )
-
-    async def query(self, query: str, variables: Dict[str, Any] = {}) -> Dict[str, Any]:
-        """
-        Execute a GraphQL query.
-
-        :param query: The GraphQL query string.
-        :param variables: A dictionary of variables for the query.
-        :return: The response data as a dictionary.
-        """
-        return await self.graphql_client.execute_async(query=query, variables=variables)
-
-    def check_for_errors(self, response: Dict[str, Any], raise_error: bool = False):
-        if "errors" in response:
-            if raise_error:
-                raise Exception(
-                    f"{response['errors'][0]['message']}. Path: {str(response['errors'][0]['path'])}"
-                )
-            logger.error(response["errors"][0])
-            return True
-        return False
-
-    async def mutation(
-        self, mutation: str, variables: Mapping[str, Any] = {}
-    ) -> Dict[str, Any]:
-        """
-        Execute a GraphQL mutation.
-
-        :param mutation: The GraphQL mutation string.
-        :param variables: A dictionary of variables for the mutation.
-        :return: The response data as a dictionary.
-        """
-        return await self.graphql_client.execute_async(
-            query=mutation, variables=variables
-        )