sarvam-agents-client 0.1.0__tar.gz

sarvam_agents_client-0.1.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: sarvam-agents-client
+Version: 0.1.0
+Summary: Sarvam Agents API
+Home-page: https://github.com/brahmansh-sarvam/sarvam-agents-sdk
+Author: Sarvam AI
+Author-email: support@sarvam.ai
+License: MIT
+Keywords: OpenAPI,OpenAPI-Generator,Sarvam Agents API
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=1.25.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+    Chat with a Sarvam agent, exchange files with it, and set it up (instructions, skills, knowledge bases, connectors, deploy) from your own code. Authenticate with a service token sent as a Bearer token, and send the header X-Panja-Origin: managed_agents on every request.
+    

sarvam_agents_client-0.1.0/README.md

@@ -0,0 +1,178 @@
+# sarvam-agents-client
+
+Python client for the Sarvam Agents API: chat with an agent, exchange files with it, and set it up
+(instructions, skills, knowledge bases, connectors, deploy) from your own code.
+
+- Python 3.8+
+- Distribution name `sarvam-agents-client`, import name `sarvam_agents`
+
+```sh
+pip install sarvam-agents-client
+```
+
+## Authentication
+
+Every call needs:
+
+- a service token, sent as `Authorization: Bearer <token>`
+- the header `X-Panja-Origin: managed_agents`
+
+The examples read the token and agent id from environment variables:
+
+```sh
+export SARVAM_AGENTS_TOKEN="..."      # never commit this
+export SARVAM_AGENTS_AGENT_ID="..."
+```
+
+The agent must be a managed agent and must be deployed (`AgentsApi.deploy_agent`). Otherwise, sending it a message
+fails with `409 CHAT_CONFLICT`, with `details[0].reason = "AGENT_NOT_DEPLOYED"`.
+
+## Quickstart
+
+```python
+import os
+import uuid
+
+import sarvam_agents as sa
+
+config = sa.Configuration(
+    host="https://chat.sarvamclaw.sarvam.ai",
+    access_token=os.environ["SARVAM_AGENTS_TOKEN"],
+)
+client = sa.ApiClient(config, header_name="X-Panja-Origin", header_value="managed_agents")
+agent_id = os.environ["SARVAM_AGENTS_AGENT_ID"]
+
+agent = sa.AgentsApi(client).get_agent(agent_id)
+print(agent.name, agent.deploy_state)
+
+conversation = sa.ConversationsApi(client).create_conversation(
+    sa.CreateConversationBody(agent_id=agent_id, title="Hello from Python")
+)
+```
+
+## Send a message and stream the reply
+
+Use the helpers in `sarvam_agents.streaming`. They print the reply as it arrives.
+
+The generated `ResponsesApi.create_response` works differently: it waits for the whole turn, which can take
+minutes, then returns the raw event text as one string.
+
+```python
+from sarvam_agents.streaming import stream_response
+
+body = sa.ResponseInput(
+    id=conversation.id,                       # same id again = next turn in the same conversation
+    agent_id=agent_id,
+    message=sa.InputMessage(
+        id=str(uuid.uuid4()),
+        role="user",
+        parts=[sa.MessagePart(type="text", text="What can you help me with?")],
+    ),
+)
+
+with stream_response(client, body) as stream:
+    for event in stream:
+        if event["type"] == "text-delta":
+            print(event["delta"], end="", flush=True)
+        elif event["type"] == "data-file-shared":
+            print("\n[file]", event["data"]["filename"])
+        elif event["type"] == "error":
+            print("\n[error]", event.get("errorText"))
+```
+
+Each event is a dict. Its `type` is one of:
+
+- `start`
+- `text-delta`
+- `data-file-shared`
+- `data-clarify-request`
+- `data-stopped`
+- `error`
+- `finish`
+
+**Reconnect after a dropped connection.** The stream remembers two things: `stream.response_id` and
+`stream.last_event_id`. Pass them to `reconnect` and the reply continues from that point:
+
+```python
+from sarvam_agents.streaming import reconnect
+
+with reconnect(client, conversation.id, stream.response_id, stream.last_event_id) as stream:
+    for event in stream:
+        ...
+```
+
+The server restarts the reply at the start of a block. So if you were partway through a text block, throw that
+partial text away and use what arrives instead.
+
+**Answer a question from the agent.** When the agent asks you something, the stream sends a
+`data-clarify-request` event. Answer it with:
+
+```python
+from sarvam_agents.streaming import answer_clarify
+
+answer_clarify(client, conversation.id, sa.ClarifyBody(request_id=request_id, answers={...}))
+```
+
+It returns a stream just like `stream_response`.
+
+**Timeout.** The default timeout is 10 s to connect and 60 s per read. The server sends a ping every 15 seconds,
+so a working stream never trips it. To change it, pass `timeout=(connect, read)`.
+
+## Files
+
+Attaching a file takes three steps:
+
+1. `ArtifactsApi.mint_upload_url` gives you an upload URL.
+2. `PUT` the file bytes to that URL, with no bearer token.
+3. Call `ArtifactsApi.commit_artifact` with the file's sha256.
+
+Then add it to the message as a `file` part:
+
+```python
+sa.MessagePart(
+    type="file",
+    media_type=mime,
+    filename=name,
+    provider_metadata={"custom": {"artifactId": record.artifact_id, "filename": name}},
+)
+```
+
+To get the agent's files:
+
+- `ArtifactsApi.list_conversation_artifacts` lists them.
+- `ArtifactsApi.download_url` gives you a link to download one.
+
+## Setting up the agent
+
+| Task | Call |
+|---|---|
+| Instructions | `AgentsApi.get_instructions` / `put_instructions` |
+| Deploy | `AgentsApi.deploy_agent` / `undeploy_agent` |
+| Skills | `SkillsApi.list_agent_skills`, `bind_skill`, `unbind_skill`, `create_skill_for_agent` |
+| Knowledge bases | `CollectionsApi.list_agent_collections`, `bind_agent_to_collection`, `init_file_upload` → PUT → `complete_file_upload` → poll `get_file` |
+| Connectors | `AppsApi.list_apps`, `list_agent_apps`, `bind_app`, `unbind_app`, `connect_app` |
+
+Every endpoint is listed in [docs/](docs/), one page per API class.
+
+## Errors
+
+Any 4xx or 5xx response raises `sarvam_agents.ApiException`, and the streaming helpers do the same. The exception
+carries the HTTP status in `.status` and the JSON error in `.body`.
+
+```python
+try:
+    sa.AgentsApi(client).deploy_agent(agent_id)
+except sa.ApiException as e:
+    print(e.status, e.body)
+```
+
+## Regenerating
+
+Most of this package is generated by OpenAPI Generator. The steps to regenerate it are in
+[regen/README.md](regen/README.md).
+
+These files are written by hand, and regeneration leaves them alone:
+
+- `sarvam_agents/streaming.py`
+- `tests/`
+- this README

sarvam_agents_client-0.1.0/pyproject.toml

@@ -0,0 +1,89 @@
+[tool.poetry]
+name = "sarvam_agents"
+version = "0.1.0"
+description = "Sarvam Agents API"
+authors = ["Sarvam AI <support@sarvam.ai>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/brahmansh-sarvam/sarvam-agents-sdk"
+keywords = ["OpenAPI", "OpenAPI-Generator", "Sarvam Agents API"]
+include = ["sarvam_agents/py.typed"]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+urllib3 = ">= 1.25.3 < 3.0.0"
+python-dateutil = ">= 2.8.2"
+pydantic = ">= 2"
+typing-extensions = ">= 4.7.1"
+
+[tool.poetry.dev-dependencies]
+pytest = ">= 7.2.1"
+pytest-cov = ">= 2.8.1"
+tox = ">= 3.9.0"
+flake8 = ">= 4.0.0"
+types-python-dateutil = ">= 2.8.19.14"
+mypy = ">= 1.5"
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = [
+  "sarvam_agents",
+  #"test",  # auto-generated tests
+  "tests", # hand-written tests
+]
+# TODO: enable "strict" once all these individual checks are passing
+# strict = true
+
+# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+## Getting these passing should be easy
+strict_equality = true
+extra_checks = true
+
+## Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+## These shouldn't be too much additional work, but may be tricky to
+## get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+### These next few are various gradations of forcing use of type annotations
+#disallow_untyped_calls = true
+#disallow_incomplete_defs = true
+#disallow_untyped_defs = true
+#
+### This one isn't too hard to get passing, but return on investment is lower
+#no_implicit_reexport = true
+#
+### This one can be tricky to get passing if you use a lot of untyped libraries
+#warn_return_any = true
+
+[[tool.mypy.overrides]]
+module = [
+  "sarvam_agents.configuration",
+]
+warn_unused_ignores = true
+strict_equality = true
+extra_checks = true
+check_untyped_defs = true
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+disallow_untyped_calls = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_reexport = true
+warn_return_any = true

sarvam_agents_client-0.1.0/sarvam_agents/__init__.py

@@ -0,0 +1,179 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Sarvam Agents API
+
+    Chat with a Sarvam agent, exchange files with it, and set it up (instructions, skills, knowledge bases, connectors, deploy) from your own code. Authenticate with a service token sent as a Bearer token, and send the header X-Panja-Origin: managed_agents on every request.
+
+    The version of the OpenAPI document: 0.1.0
+    Contact: support@sarvam.ai
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "0.1.0"
+
+# import apis into sdk package
+from sarvam_agents.api.agent_conversations_api import AgentConversationsApi
+from sarvam_agents.api.agents_api import AgentsApi
+from sarvam_agents.api.apps_api import AppsApi
+from sarvam_agents.api.artifacts_api import ArtifactsApi
+from sarvam_agents.api.clarify_api import ClarifyApi
+from sarvam_agents.api.collections_api import CollectionsApi
+from sarvam_agents.api.conversations_api import ConversationsApi
+from sarvam_agents.api.crons_api import CronsApi
+from sarvam_agents.api.messages_api import MessagesApi
+from sarvam_agents.api.queue_api import QueueApi
+from sarvam_agents.api.responses_api import ResponsesApi
+from sarvam_agents.api.skills_api import SkillsApi
+
+# import ApiClient
+from sarvam_agents.api_response import ApiResponse
+from sarvam_agents.api_client import ApiClient
+from sarvam_agents.configuration import Configuration
+from sarvam_agents.exceptions import OpenApiException
+from sarvam_agents.exceptions import ApiTypeError
+from sarvam_agents.exceptions import ApiValueError
+from sarvam_agents.exceptions import ApiKeyError
+from sarvam_agents.exceptions import ApiAttributeError
+from sarvam_agents.exceptions import ApiException
+
+# import models into sdk package
+from sarvam_agents.models.add_message_body import AddMessageBody
+from sarvam_agents.models.add_message_body_parts_inner import AddMessageBodyPartsInner
+from sarvam_agents.models.agent_channel_ref import AgentChannelRef
+from sarvam_agents.models.agent_conversation_detail import AgentConversationDetail
+from sarvam_agents.models.agent_conversation_view import AgentConversationView
+from sarvam_agents.models.agent_create import AgentCreate
+from sarvam_agents.models.agent_resource import AgentResource
+from sarvam_agents.models.agent_search_channel import AgentSearchChannel
+from sarvam_agents.models.agent_template_resource import AgentTemplateResource
+from sarvam_agents.models.agent_update import AgentUpdate
+from sarvam_agents.models.api_key_body import ApiKeyBody
+from sarvam_agents.models.app_category import AppCategory
+from sarvam_agents.models.app_connect_response import AppConnectResponse
+from sarvam_agents.models.app_resource import AppResource
+from sarvam_agents.models.app_tool_view import AppToolView
+from sarvam_agents.models.app_tools_response import AppToolsResponse
+from sarvam_agents.models.app_view import AppView
+from sarvam_agents.models.artifact_response import ArtifactResponse
+from sarvam_agents.models.bind_collection_body import BindCollectionBody
+from sarvam_agents.models.body import Body
+from sarvam_agents.models.capabilities import Capabilities
+from sarvam_agents.models.chat_error import ChatError
+from sarvam_agents.models.citation_batch_read import CitationBatchRead
+from sarvam_agents.models.citation_read import CitationRead
+from sarvam_agents.models.citation_region import CitationRegion
+from sarvam_agents.models.citation_resolve_read import CitationResolveRead
+from sarvam_agents.models.clarify_body import ClarifyBody
+from sarvam_agents.models.collection_binding_view import CollectionBindingView
+from sarvam_agents.models.collection_create import CollectionCreate
+from sarvam_agents.models.collection_resource import CollectionResource
+from sarvam_agents.models.collection_update import CollectionUpdate
+from sarvam_agents.models.commit_body import CommitBody
+from sarvam_agents.models.connect_body import ConnectBody
+from sarvam_agents.models.connector_option import ConnectorOption
+from sarvam_agents.models.conversation_artifact import ConversationArtifact
+from sarvam_agents.models.conversation_artifacts_response import ConversationArtifactsResponse
+from sarvam_agents.models.conversation_detail import ConversationDetail
+from sarvam_agents.models.conversation_view import ConversationView
+from sarvam_agents.models.create_conversation_body import CreateConversationBody
+from sarvam_agents.models.creator_filter_option import CreatorFilterOption
+from sarvam_agents.models.creator_filter_options import CreatorFilterOptions
+from sarvam_agents.models.cron_create import CronCreate
+from sarvam_agents.models.cron_read import CronRead
+from sarvam_agents.models.cron_resource import CronResource
+from sarvam_agents.models.cron_run_read import CronRunRead
+from sarvam_agents.models.cron_update import CronUpdate
+from sarvam_agents.models.currentscope import Currentscope
+from sarvam_agents.models.delivery_target import DeliveryTarget
+from sarvam_agents.models.download_url_response import DownloadUrlResponse
+from sarvam_agents.models.edit_queued_input import EditQueuedInput
+from sarvam_agents.models.entity_category import EntityCategory
+from sarvam_agents.models.entity_filter_options import EntityFilterOptions
+from sarvam_agents.models.entity_filter_options_categories_inner import EntityFilterOptionsCategoriesInner
+from sarvam_agents.models.entity_list_agent_resource import EntityListAgentResource
+from sarvam_agents.models.entity_list_agent_template_resource import EntityListAgentTemplateResource
+from sarvam_agents.models.entity_list_app_resource import EntityListAppResource
+from sarvam_agents.models.entity_list_collection_resource import EntityListCollectionResource
+from sarvam_agents.models.entity_list_cron_resource import EntityListCronResource
+from sarvam_agents.models.entity_list_skill_resource import EntityListSkillResource
+from sarvam_agents.models.entity_type import EntityType
+from sarvam_agents.models.error_detail import ErrorDetail
+from sarvam_agents.models.error_detail_item import ErrorDetailItem
+from sarvam_agents.models.export_body import ExportBody
+from sarvam_agents.models.export_response import ExportResponse
+from sarvam_agents.models.feedback_body import FeedbackBody
+from sarvam_agents.models.feedback_result import FeedbackResult
+from sarvam_agents.models.field_highlight import FieldHighlight
+from sarvam_agents.models.file_complete_body import FileCompleteBody
+from sarvam_agents.models.file_error import FileError
+from sarvam_agents.models.file_init_body import FileInitBody
+from sarvam_agents.models.file_init_response import FileInitResponse
+from sarvam_agents.models.file_node_view import FileNodeView
+from sarvam_agents.models.file_parsed_response import FileParsedResponse
+from sarvam_agents.models.file_part import FilePart
+from sarvam_agents.models.file_progress import FileProgress
+from sarvam_agents.models.file_queued_response import FileQueuedResponse
+from sarvam_agents.models.file_raw_response import FileRawResponse
+from sarvam_agents.models.file_read import FileRead
+from sarvam_agents.models.file_write_body import FileWriteBody
+from sarvam_agents.models.http_validation_error import HTTPValidationError
+from sarvam_agents.models.highlight_range import HighlightRange
+from sarvam_agents.models.inline_create_skill_body import InlineCreateSkillBody
+from sarvam_agents.models.input_message import InputMessage
+from sarvam_agents.models.instructions_body import InstructionsBody
+from sarvam_agents.models.instructions_response import InstructionsResponse
+from sarvam_agents.models.message_part import MessagePart
+from sarvam_agents.models.messages_response import MessagesResponse
+from sarvam_agents.models.mint_upload_url403_response import MintUploadUrl403Response
+from sarvam_agents.models.page_agent_conversation_view import PageAgentConversationView
+from sarvam_agents.models.page_app_view import PageAppView
+from sarvam_agents.models.page_collection_binding_view import PageCollectionBindingView
+from sarvam_agents.models.page_conversation_view import PageConversationView
+from sarvam_agents.models.page_cron_run_read import PageCronRunRead
+from sarvam_agents.models.page_file_node_view import PageFileNodeView
+from sarvam_agents.models.page_file_read import PageFileRead
+from sarvam_agents.models.page_search_result import PageSearchResult
+from sarvam_agents.models.page_skill_view import PageSkillView
+from sarvam_agents.models.product_gate_waitlisted import ProductGateWaitlisted
+from sarvam_agents.models.publish_request import PublishRequest
+from sarvam_agents.models.queue_message_input import QueueMessageInput
+from sarvam_agents.models.queue_message_result import QueueMessageResult
+from sarvam_agents.models.queued_turn_view import QueuedTurnView
+from sarvam_agents.models.reason import Reason
+from sarvam_agents.models.requiredscope import Requiredscope
+from sarvam_agents.models.resourcetype import Resourcetype
+from sarvam_agents.models.response_complete_file_upload import ResponseCompleteFileUpload
+from sarvam_agents.models.response_detail import ResponseDetail
+from sarvam_agents.models.response_input import ResponseInput
+from sarvam_agents.models.scope import Scope
+from sarvam_agents.models.search_body import SearchBody
+from sarvam_agents.models.search_result import SearchResult
+from sarvam_agents.models.server_side_ingest_error import ServerSideIngestError
+from sarvam_agents.models.server_side_ingest_file import ServerSideIngestFile
+from sarvam_agents.models.server_side_ingest_response import ServerSideIngestResponse
+from sarvam_agents.models.skill_detail_view import SkillDetailView
+from sarvam_agents.models.skill_resource import SkillResource
+from sarvam_agents.models.skill_update import SkillUpdate
+from sarvam_agents.models.skill_upload_descriptor import SkillUploadDescriptor
+from sarvam_agents.models.skill_upload_response import SkillUploadResponse
+from sarvam_agents.models.skill_view import SkillView
+from sarvam_agents.models.source_create_skill_body import SourceCreateSkillBody
+from sarvam_agents.models.stop_response import StopResponse
+from sarvam_agents.models.template_connector_tag import TemplateConnectorTag
+from sarvam_agents.models.template_works_with import TemplateWorksWith
+from sarvam_agents.models.text_part import TextPart
+from sarvam_agents.models.trigger_cron_body import TriggerCronBody
+from sarvam_agents.models.trigger_response import TriggerResponse
+from sarvam_agents.models.ui_message import UIMessage
+from sarvam_agents.models.update_conversation_body import UpdateConversationBody
+from sarvam_agents.models.update_skill_body import UpdateSkillBody
+from sarvam_agents.models.upload_url_body import UploadUrlBody
+from sarvam_agents.models.upload_url_response import UploadUrlResponse
+from sarvam_agents.models.validation_error import ValidationError
+from sarvam_agents.models.validation_error_loc_inner import ValidationErrorLocInner

sarvam_agents_client-0.1.0/sarvam_agents/api/__init__.py

@@ -0,0 +1,16 @@
+# flake8: noqa
+
+# import apis into api package
+from sarvam_agents.api.agent_conversations_api import AgentConversationsApi
+from sarvam_agents.api.agents_api import AgentsApi
+from sarvam_agents.api.apps_api import AppsApi
+from sarvam_agents.api.artifacts_api import ArtifactsApi
+from sarvam_agents.api.clarify_api import ClarifyApi
+from sarvam_agents.api.collections_api import CollectionsApi
+from sarvam_agents.api.conversations_api import ConversationsApi
+from sarvam_agents.api.crons_api import CronsApi
+from sarvam_agents.api.messages_api import MessagesApi
+from sarvam_agents.api.queue_api import QueueApi
+from sarvam_agents.api.responses_api import ResponsesApi
+from sarvam_agents.api.skills_api import SkillsApi
+