diff --git a/.fern/metadata.json b/.fern/metadata.json index 9f92fc3a..babb5a81 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -12,10 +12,10 @@ }, "pyproject_python_version": "^3.10" }, - "originGitCommit": "3bad6dc94b415e5291ffa6b5e67e06422c97660b", + "originGitCommit": "ee05bfd8ef5595c252169f3e0605ef888837982f", "originGitCommitIsDirty": true, "invokedBy": "ci", - "requestedVersion": "4.0.0", + "requestedVersion": "4.0.1", "ciProvider": "github", - "sdkVersion": "4.0.0" + "sdkVersion": "4.0.1" } \ No newline at end of file diff --git a/.fern/replay.lock b/.fern/replay.lock index 53504c8f..7a0ec765 100644 --- a/.fern/replay.lock +++ b/.fern/replay.lock @@ -60,14 +60,20 @@ generations: cli_version: unknown generator_versions: fernapi/fern-python-sdk: 5.39.2 -current_generation: 7247ff4caba2352760890211cfbc4f2ed84cb298 + - commit_sha: eecb98bb49bcd8feb5a0bb72fccc129fb67ce30a + tree_hash: f55769ea51db795402ba5f22b4faac5ce8cbbea0 + timestamp: 2026-10-18T19:43:24.235Z + cli_version: unknown + generator_versions: + fernapi/fern-python-sdk: 5.39.2 +current_generation: eecb98bb49bcd8feb5a0bb72fccc129fb67ce30a patches: - id: patch-082f322d content_hash: sha256:80c233468a0236864659e748ffa647c6c6a89435d3fca6dec28965e48b901c46 original_commit: 082f322d1bd077cff00e3630500ac6187251a000 original_message: Let an ontology field opt out, and fix the README (#348) original_author: Pavlo Paliychuk - base_generation: 7247ff4caba2352760890211cfbc4f2ed84cb298 + base_generation: eecb98bb49bcd8feb5a0bb72fccc129fb67ce30a files: - README.md patch_content: | diff --git a/README.md b/README.md index c861b306..c057a883 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ The Zep Python library provides convenient access to the Zep APIs from Python. - [Environments](#environments) - [Async Client](#async-client) - [Exception Handling](#exception-handling) +- [Streaming](#streaming) - [Pagination](#pagination) - [Advanced](#advanced) - [Access Raw Response Data](#access-raw-response-data) @@ -67,9 +68,9 @@ client = Zep( ) client.agent.create( - agent_id="agent_id", - name="name", - security_domain="security_domain", + agent_id="payments-agent", + name="Refund a duplicate charge", + security_domain="customer:support", ) ``` @@ -102,9 +103,9 @@ client = AsyncZep( async def main() -> None: await client.agent.create( - agent_id="agent_id", - name="name", - security_domain="security_domain", + agent_id="payments-agent", + name="Refund a duplicate charge", + security_domain="customer:support", ) @@ -126,6 +127,25 @@ except ApiError as e: print(e.body) ``` +## Streaming + +The SDK supports streaming responses, as well, the response will be a generator that you can loop over. + +```python +from zep_cloud import Zep + +client = Zep( + api_key="", +) + +client.graph.query_stream( + graph_uuids=[ + "graph_uuids" + ], + query="query", +) +``` + ## Pagination Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object. diff --git a/poetry.lock b/poetry.lock index b31a28a2..26753e08 100644 --- a/poetry.lock +++ b/poetry.lock @@ -289,14 +289,14 @@ files = [ [[package]] name = "certifi" -version = "2026.7.22" +version = "2026.10.18" description = "Python package for providing Mozilla's CA Bundle." optional = false python-versions = ">=3.7" groups = ["main"] files = [ - {file = "certifi-2026.7.22-py3-none-any.whl", hash = "sha256:62f22742b58a1a33014a2b6b706588a8d7e2a88ae7bd1a6ebe8c992928483775"}, - {file = "certifi-2026.7.22.tar.gz", hash = "sha256:741e2c3b351ddf169a738da9f2c048608ff7f2c5cc02f1ebc6b118bb090d5d55"}, + {file = "certifi-2026.10.18-py3-none-any.whl", hash = "sha256:73191c47aaa79da394e8fee2dbc2ec827432cab56311122c9e47abf79e390f62"}, + {file = "certifi-2026.10.18.tar.gz", hash = "sha256:b9995d97b64d0431a5af837d8ca8cd6238104d1f319f04bd93ea43124d6c861e"}, ] [[package]] @@ -855,20 +855,16 @@ files = [ [[package]] name = "pluggy" -version = "1.6.0" +version = "1.7.0" description = "plugin and hook calling mechanisms for python" optional = false -python-versions = ">=3.9" +python-versions = ">=3.10" groups = ["dev"] files = [ - {file = "pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746"}, - {file = "pluggy-1.6.0.tar.gz", hash = "sha256:7dcc130b76258d33b90f61b658791dede3486c3e6bfb003ee5c9bfb396dd22f3"}, + {file = "pluggy-1.7.0-py3-none-any.whl", hash = "sha256:7dd7b0d8832ba3cb632c306926ded123429211b83641b35dc5c41ad2d34f9bec"}, + {file = "pluggy-1.7.0.tar.gz", hash = "sha256:d1eaa46ebb595891b860ab086b4d09c8588af65ebd4361b8e8f4bb8920b90ba8"}, ] -[package.extras] -dev = ["pre-commit", "tox"] -testing = ["coverage", "pytest", "pytest-benchmark"] - [[package]] name = "propcache" version = "0.5.4" diff --git a/pyproject.toml b/pyproject.toml index 8d017284..e92a3902 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,12 +1,12 @@ [project] name = "zep-cloud" dynamic = ["version"] -version = "4.0.0" +version = "4.0.1" [tool.poetry] name = "zep-cloud" -version = "4.0.0" -description = "" +version = "4.0.1" +description = "The Python SDK for Zep, the context layer for AI agents." readme = "README.md" authors = [] keywords = [] diff --git a/reference.md b/reference.md index f554c037..4e9f82e0 100644 --- a/reference.md +++ b/reference.md @@ -22,9 +22,9 @@ client = Zep( ) client.agent.create( - agent_id="agent_id", - name="name", - security_domain="security_domain", + agent_id="payments-agent", + name="Refund a duplicate charge", + security_domain="customer:support", ) ``` @@ -138,7 +138,7 @@ client.agent.list()
-**deployment_id:** `typing.Optional[str]` — Filters to the exact deployment identifier. +**deployment_id:** `typing.Optional[str]` — The developer supplies filters to the exact deployment identifier.
@@ -156,7 +156,7 @@ client.agent.list() **search:** `typing.Optional[str]` -Filters to Agents whose name, Agent identifier, deployment identifier, +The developer supplies filters to Agents whose name, Agent identifier, deployment identifier, or deployment version contains this text. Matching is case-insensitive. @@ -440,6 +440,20 @@ client.agent.update(
+#### 📝 Description + +
+
+ +
+
+ +Declare a breaking Agent deployment change. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -460,7 +474,7 @@ client = Zep( client.agent.declare_breaking_change( agent_uuid="agent_uuid", expected_revision=1, - version="version", + version="2026.09.01", ) ``` @@ -486,6 +500,9 @@ client.agent.declare_breaking_change(
**expected_revision:** `int` + +The developer supplies the current Agent revision for optimistic concurrency. +It must be at least 1.
@@ -493,7 +510,7 @@ client.agent.declare_breaking_change(
-**version:** `str` +**version:** `str` — The developer supplies the new deployment version. It must differ from the current version.
@@ -517,6 +534,20 @@ client.agent.declare_breaking_change(
+#### 📝 Description + +
+
+ +
+
+ +Get Agent context. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -560,7 +591,7 @@ client.agent.get_context(
-**environments:** `typing.Optional[typing.List[AgentContextResource]]` +**environments:** `typing.Optional[typing.List[AgentContextResource]]` — The developer supplies environment names used by the Skill. At most 32.
@@ -568,7 +599,7 @@ client.agent.get_context(
-**kind:** `typing.Optional[str]` +**kind:** `typing.Optional[str]` — The developer supplies a Skill kind. At most 64.
@@ -576,7 +607,7 @@ client.agent.get_context(
-**max_characters:** `typing.Optional[int]` +**max_characters:** `typing.Optional[int]` — The developer sets the maximum number of characters in the context response.
@@ -584,7 +615,7 @@ client.agent.get_context(
-**models:** `typing.Optional[typing.List[AgentContextResource]]` +**models:** `typing.Optional[typing.List[AgentContextResource]]` — The developer supplies models used for this evaluation. At most 32.
@@ -592,7 +623,7 @@ client.agent.get_context(
-**objective:** `typing.Optional[str]` +**objective:** `typing.Optional[str]` — The developer supplies the task-instance objective. At most 512.
@@ -600,7 +631,7 @@ client.agent.get_context(
-**task_family:** `typing.Optional[str]` +**task_family:** `typing.Optional[str]` — The developer supplies the task-family slug. At most 128.
@@ -608,7 +639,7 @@ client.agent.get_context(
-**tools:** `typing.Optional[typing.List[AgentContextResource]]` +**tools:** `typing.Optional[typing.List[AgentContextResource]]` — The developer supplies tool names used by the Skill. At most 32.
@@ -616,7 +647,7 @@ client.agent.get_context(
-**trace_uuid:** `typing.Optional[str]` +**trace_uuid:** `typing.Optional[str]` — The developer supplies the UUID of the source Trace.
@@ -1724,6 +1755,244 @@ client.graph.lookup()
+
+
+ + +
client.graph.query_stream(...) -> typing.Iterator[bytes] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set `generate_answer` to `true` to also get an answer that a model writes from the records, with the cited graph items. Set `stream` to `true` to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns `404 not_found`. To get access, contact support@getzep.com. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from zep_cloud import Zep +from zep_cloud.environment import ZepEnvironment + +client = Zep( + api_key="", + environment=ZepEnvironment.DEFAULT, +) + +client.graph.query_stream( + graph_uuids=[ + "graph_uuids" + ], + query="query", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**graph_uuids:** `typing.List[str]` — The graph UUIDs to query. The current release accepts one UUID. + +
+
+ +
+
+ +**query:** `str` — The natural-language question about the graph. + +
+
+ +
+
+ +**stream:** `typing.Literal` — When true, return the retrieval calls as server-sent events. + +
+
+ +
+
+ +**generate_answer:** `typing.Optional[bool]` + +When true, a model also writes an answer from the retrieved records. +The default is false: the response has the records and no answer. + +
+
+ +
+
+ +**guidance:** `typing.Optional[str]` — Optional caller guidance for the answer. The agent treats it as untrusted text. + +
+
+ +
+
+ +**mode:** `typing.Optional[GraphQueryRequestMode]` — The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.graph.query(...) -> GraphQueryResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set `generate_answer` to `true` to also get an answer that a model writes from the records, with the cited graph items. Set `stream` to `true` to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns `404 not_found`. To get access, contact support@getzep.com. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from zep_cloud import Zep +from zep_cloud.environment import ZepEnvironment + +client = Zep( + api_key="", + environment=ZepEnvironment.DEFAULT, +) + +client.graph.query_stream( + graph_uuids=[ + "graph_uuids" + ], + query="query", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**graph_uuids:** `typing.List[str]` — The graph UUIDs to query. The current release accepts one UUID. + +
+
+ +
+
+ +**query:** `str` — The natural-language question about the graph. + +
+
+ +
+
+ +**stream:** `typing.Literal` — When true, return the retrieval calls as server-sent events. + +
+
+ +
+
+ +**generate_answer:** `typing.Optional[bool]` + +When true, a model also writes an answer from the retrieved records. +The default is false: the response has the records and no answer. + +
+
+ +
+
+ +**guidance:** `typing.Optional[str]` — Optional caller guidance for the answer. The agent treats it as untrusted text. + +
+
+ +
+
+ +**mode:** `typing.Optional[GraphQueryRequestMode]` — The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ +
@@ -7578,6 +7847,20 @@ client.user.set_summary_instructions(
+#### 📝 Description + +
+
+ +
+
+ +Get Agent Learning State. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -7646,7 +7929,21 @@ client.agent.learning.get(
-#### 🔌 Usage +#### 📝 Description + +
+
+ +
+
+ +List durable learning-run outcomes for an Agent. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ +#### 🔌 Usage
@@ -7730,6 +8027,20 @@ client.agent.learning.list_runs(
+#### 📝 Description + +
+
+ +
+
+ +Get Agent Literal Policy. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -7789,6 +8100,20 @@ client.agent.literal_policy.get(
+#### 📝 Description + +
+
+ +
+
+ +Update Agent Literal Policy. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -7810,18 +8135,18 @@ client.agent.literal_policy.update( agent_uuid="agent_uuid", allowlisted_classes=AgentLiteralPolicyClasses( environments=[ - "environments" + "environment_name" ], tools=[ - "tools" + "command_name" ], ), allowlisted_values=AgentLiteralPolicyValues( environments=[ - "environments" + "production" ], tools=[ - "tools" + "refund_payment" ], ), default="parameterize", @@ -7898,6 +8223,20 @@ client.agent.literal_policy.update(
+#### 📝 Description + +
+
+ +
+
+ +Create Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -7942,7 +8281,7 @@ client.agent.skill.create(
-**definition:** `SkillDefinition` +**definition:** `SkillDefinition` — The developer supplies the structured content of the Skill.
@@ -7951,6 +8290,9 @@ client.agent.skill.create(
**skill_id:** `typing.Optional[str]` + +The developer can set a stable ID for the Skill. If omitted, the service +assigns one.
@@ -7982,7 +8324,7 @@ client.agent.skill.create(
-Submit a portable Skill archive. The completed Task returns `{"result":{"skill_uuid":""}}`. Approve that Skill before retrieval. +Submit a portable Skill archive. The completed Task returns `{"result":{"skill_uuid":""}}`. Approve that Skill before retrieval. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -8044,6 +8386,20 @@ client.agent.skill.import_package(...)
+#### 📝 Description + +
+
+ +
+
+ +List Agent Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -8103,7 +8459,7 @@ client.agent.skill.list(
-**environments:** `typing.Optional[typing.List[str]]` +**environments:** `typing.Optional[typing.List[str]]` — The developer filters results by environment names.
@@ -8111,7 +8467,7 @@ client.agent.skill.list(
-**kind:** `typing.Optional[str]` +**kind:** `typing.Optional[str]` — The developer supplies a Skill kind.
@@ -8119,7 +8475,7 @@ client.agent.skill.list(
-**task_family:** `typing.Optional[str]` +**task_family:** `typing.Optional[str]` — The developer supplies the task-family slug.
@@ -8127,7 +8483,7 @@ client.agent.skill.list(
-**tools:** `typing.Optional[typing.List[str]]` +**tools:** `typing.Optional[typing.List[str]]` — The developer supplies tool names used by the Skill.
@@ -8151,6 +8507,20 @@ client.agent.skill.list(
+#### 📝 Description + +
+
+ +
+
+ +Search Agent Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -8170,7 +8540,7 @@ client = Zep( client.agent.skill.search( agent_uuid="agent_uuid", - query="query", + query="How do I refund a duplicate charge?", ) ``` @@ -8195,7 +8565,7 @@ client.agent.skill.search(
-**query:** `str` +**query:** `str` — The developer supplies a search query for Skills.
@@ -8219,7 +8589,7 @@ client.agent.skill.search(
-**environments:** `typing.Optional[typing.List[str]]` +**environments:** `typing.Optional[typing.List[str]]` — The developer supplies environment names used by the Skill.
@@ -8227,7 +8597,7 @@ client.agent.skill.search(
-**include_markdown:** `typing.Optional[bool]` +**include_markdown:** `typing.Optional[bool]` — The developer sets this to true to include the Skill instructions in Markdown.
@@ -8235,7 +8605,7 @@ client.agent.skill.search(
-**kind:** `typing.Optional[str]` +**kind:** `typing.Optional[str]` — The developer supplies a Skill kind.
@@ -8256,7 +8626,7 @@ sections. `full` returns the stored SKILL.md with its evidence markers.
-**task_family:** `typing.Optional[str]` +**task_family:** `typing.Optional[str]` — The developer supplies the task-family slug.
@@ -8264,7 +8634,7 @@ sections. `full` returns the stored SKILL.md with its evidence markers.
-**tools:** `typing.Optional[typing.List[str]]` +**tools:** `typing.Optional[typing.List[str]]` — The developer supplies tool names used by the Skill.
@@ -8288,6 +8658,20 @@ sections. `full` returns the stored SKILL.md with its evidence markers.
+#### 📝 Description + +
+
+ +
+
+ +Get Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -8356,6 +8740,20 @@ client.agent.skill.get(
+#### 📝 Description + +
+
+ +
+
+ +Approve Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -8409,7 +8807,7 @@ client.agent.skill.approve(
-**expected_version:** `int` +**expected_version:** `int` — The developer supplies the current Skill version to protect against concurrent edits.
@@ -8433,6 +8831,20 @@ client.agent.skill.approve(
+#### 📝 Description + +
+
+ +
+
+ +Retire Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -8486,7 +8898,7 @@ client.agent.skill.retire(
-**expected_version:** `int` +**expected_version:** `int` — The developer supplies the current Skill version to protect against concurrent edits.
@@ -8510,6 +8922,20 @@ client.agent.skill.retire(
+#### 📝 Description + +
+
+ +
+
+ +Create Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -8564,7 +8990,7 @@ client.agent.skill.create_version(
-**definition:** `SkillDefinition` +**definition:** `SkillDefinition` — The developer supplies the structured content for the new Skill version.
@@ -8572,7 +8998,7 @@ client.agent.skill.create_version(
-**expected_version:** `int` +**expected_version:** `int` — The developer supplies the current Skill version to protect against concurrent edits.
@@ -8597,6 +9023,20 @@ client.agent.skill.create_version(
+#### 📝 Description + +
+
+ +
+
+ +Plan an Agent split. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -8619,21 +9059,21 @@ client.agent.split.plan( destinations=[ AgentSplitPlanDestinationRequest( agent=CreateAgentRequest( - agent_id="agent_id", - name="name", - security_domain="security_domain", + agent_id="payments-agent", + name="Refund a duplicate charge", + security_domain="customer:support", ), skills=[ AgentSplitPlanSkillSelectionRequest( - skill_uuid="skill_uuid", - skill_version_uuid="skill_version_uuid", + skill_uuid="6a906e70-50ca-4e43-a874-5fcae02a71fa", + skill_version_uuid="6a906e70-50ca-4e43-a874-5fcae02a71fa", version=1, ) ], ) ], expected_revision=1, - rationale="rationale", + rationale="Keep payment refunds separate from charge disputes.", review_acknowledged=True, ) @@ -8659,7 +9099,7 @@ client.agent.split.plan(
-**destinations:** `typing.List[AgentSplitPlanDestinationRequest]` +**destinations:** `typing.List[AgentSplitPlanDestinationRequest]` — The developer lists 1 to 100 destination Agents.
@@ -8667,7 +9107,7 @@ client.agent.split.plan(
-**expected_revision:** `int` +**expected_revision:** `int` — The developer supplies the current revision used for optimistic concurrency. At least 1.
@@ -8676,6 +9116,9 @@ client.agent.split.plan(
**rationale:** `str` + +The developer explains the requested change. The limit is 2,000 +characters.
@@ -8683,7 +9126,7 @@ client.agent.split.plan(
-**review_acknowledged:** `bool` +**review_acknowledged:** `bool` — The developer sets this to true to confirm that the review is complete.
@@ -8802,8 +9245,8 @@ client = Zep( client.agent.task_family.rename( agent_uuid="agent_uuid", - from_slug="from_slug", - to_slug="to_slug", + from_slug="support/refund", + to_slug="support/refund", ) ``` @@ -8869,7 +9312,7 @@ client.agent.task_family.rename(
-List trace imports that belong to this Agent. +List trace imports that belong to this Agent. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -8958,7 +9401,7 @@ client.agent.trace_import.list(
-Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with `import`. A one-time import returns HTTP 202 with `import`, `run`, and `task`. Example request: `{"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}`. +Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with `import`. A one-time import returns HTTP 202 with `import`, `run`, and `task`. Example request: `{"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -9007,7 +9450,7 @@ client.agent.trace_import.create(
-**connection_uuid:** `typing.Optional[str]` — ConnectionUUID identifies the project trace connection. +**connection_uuid:** `typing.Optional[str]` — The developer selects the configured provider connection.
@@ -9047,7 +9490,7 @@ client.agent.trace_import.create(
-**provider_project_id:** `typing.Optional[str]` — ProviderProjectID is the source provider project identifier. +**provider_project_id:** `typing.Optional[str]` — The developer selects the project to import from the provider.
@@ -9103,7 +9546,7 @@ client.agent.trace_import.create(
-Read one trace import. The response does not include its source cursor. +Read one trace import. The response does not include its source cursor. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -9185,7 +9628,7 @@ client.agent.trace_import.get(
-Set `traces=delete` to queue asynchronous Trace deletion. The default keeps Traces. Example query: `?traces=delete`. +Set `traces=delete` to queue asynchronous Trace deletion. The default keeps Traces. Example query: `?traces=delete`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -9275,7 +9718,7 @@ client.agent.trace_import.delete(
-Use `expected_revision` to reject a stale update. Example request: `{"expected_revision":1,"name":"Updated support traces"}`. +Use `expected_revision` to reject a stale update. Example request: `{"expected_revision":1,"name":"Updated support traces"}`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -9421,7 +9864,7 @@ client.agent.trace_import.update(
-Pause a scheduled trace import. One-time imports cannot be paused. +Pause a scheduled trace import. One-time imports cannot be paused. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -9503,7 +9946,7 @@ client.agent.trace_import.pause(
-Resume a scheduled trace import. Zep verifies credentials first when they caused the pause. +Resume a scheduled trace import. Zep verifies credentials first when they caused the pause. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -9597,7 +10040,7 @@ client = Zep( client.agent.trace.create( agent_uuid="agent_uuid", - objective="objective", + objective="Refund a duplicate charge.", ) ``` @@ -9622,7 +10065,11 @@ client.agent.trace.create(
-**objective:** `str` — The task-instance objective captured for this attempt. +**objective:** `str` + +The developer describes the task instance. The create request requires a non-empty value but +does not check its size. An AppendAgentTraceEventRequest returns 400 if the Trace objective +exceeds 8 KiB (8,192 bytes).
@@ -9630,7 +10077,10 @@ client.agent.trace.create(
-**learn_from:** `typing.Optional[bool]` — Whether eligible evidence may participate in learning. Defaults to true. +**learn_from:** `typing.Optional[bool]` + +The developer supplies whether eligible evidence may participate in learning. Defaults to +true.
@@ -9646,7 +10096,7 @@ client.agent.trace.create(
-**parent_trace_uuid:** `typing.Optional[str]` — The parent Trace UUID when this attempt retries an earlier attempt. +**parent_trace_uuid:** `typing.Optional[str]` — The developer supplies the parent Trace UUID when this attempt retries an earlier attempt.
@@ -9656,8 +10106,13 @@ client.agent.trace.create( **task_family:** `typing.Optional[str]` -The task-family slug. Optional when inferred task families are enabled -for the account: the service assigns one after the Trace closes. +The developer may set a task-family slug. If the developer omits it, Agent Skills assigns the +Trace to a task family automatically. If Agent Skills cannot assign a task family, the +`task_family_inference` field of the Trace is `unassigned`. A BYOM configuration requires `task_family`. A +strict-residency deployment requires `task_family`. Without task_family in either case, the +API returns 400 `invalid_request` with the message `task_family is required`. The slug must +contain 1 to 128 lowercase letters, digits, `.`, `_`, `/`, or `-`. It must start with a +lowercase letter or digit.
@@ -9665,7 +10120,10 @@ for the account: the service assigns one after the Trace closes.
-**trace_id:** `typing.Optional[str]` — The optional customer-assigned identifier, unique within the Agent. +**trace_id:** `typing.Optional[str]` + +The developer may set an identifier that is unique within the Agent. A retry with the same +create parameters returns 200 and the existing Trace. Different parameters return 409.
@@ -9788,7 +10246,10 @@ client.agent.trace.list(
-**outcome:** `typing.Optional[AgentTraceOutcome]` — Filters to one reported outcome. +**outcome:** `typing.Optional[AgentTraceOutcome]` + +The developer supplies filters to one reported outcome. Valid values are succeeded, failed, +partial, abandoned, unknown.
@@ -10010,6 +10471,7 @@ client.agent.trace.update( agent_uuid="agent_uuid", trace_uuid="trace_uuid", expected_revision=1, + task_family="support/refund", ) ``` @@ -10344,7 +10806,8 @@ client.agent.trace.correct_task_family( agent_uuid="agent_uuid", trace_uuid="trace_uuid", expected_revision=1, - reason="reason", + reason="acknowledged_gap", + task_family="support/refund", ) ``` @@ -10501,6 +10964,20 @@ client.agent.trace.list_events(
+#### 📝 Description + +
+
+ +
+
+ +A tool call and its result can share a tool_call_id. For example, append {"event_type":"tool_call","tool_call_id":"call_8f2b","content":"Search orders","context":{"tools":[{"name":"search_orders"}]}} and {"event_type":"tool_result","tool_call_id":"call_8f2b","content":"Order results","context":{"tools":[{"name":"search_orders"}]}}. +
+
+
+
+ #### 🔌 Usage
@@ -10571,6 +11048,9 @@ client.agent.trace.append_event(
**context:** `typing.Optional[AgentTraceEventContext]` + +Context gives the model, the tools, and the environments of the event. context.tools is the tool +that the event calls or returns, and Skills learning reads it. A tool event can omit the tool name.
@@ -10586,7 +11066,7 @@ client.agent.trace.append_event(
-**metadata:** `typing.Optional[typing.Dict[str, typing.Any]]` +**metadata:** `typing.Optional[typing.Dict[str, typing.Any]]` — Metadata is developer data. Skills learning does not read it.
@@ -10618,6 +11098,19 @@ client.agent.trace.append_event(
+**tool_call_id:** `typing.Optional[str]` + +ToolCallID is the ID that the agent framework gives a tool call. Use the same ID on +the tool_call and tool_result events. It is valid only on these event types. A result +without a matching call is valid. OpenAI uses tool_calls[].id, Anthropic uses the +tool_use block id, and LangChain uses ToolMessage.tool_call_id. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -10950,6 +11443,20 @@ client.agent.trace.list_summary_versions(
+#### 📝 Description + +
+
+ +
+
+ +List Agent Verifiers. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -11065,6 +11572,20 @@ client.agent.verifier.list(
+#### 📝 Description + +
+
+ +
+
+ +Get Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -11133,6 +11654,20 @@ client.agent.verifier.get(
+#### 📝 Description + +
+
+ +
+
+ +Update Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -11242,6 +11777,20 @@ client.agent.verifier.update(
+#### 📝 Description + +
+
+ +
+
+ +Invalidate Agent Verifier Evidence. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -11262,7 +11811,7 @@ client = Zep( client.agent.verifier.invalidate_evidence( agent_uuid="agent_uuid", verifier_uuid="verifier_uuid", - reason="reason", + reason="acknowledged_gap", verifier_revisions=[ 1 ], @@ -11298,7 +11847,7 @@ client.agent.verifier.invalidate_evidence(
-**reason:** `str` — Why evidence from these verifier revisions is invalid. +**reason:** `str` — The developer supplies why evidence from these verifier revisions is invalid.
@@ -11330,6 +11879,20 @@ client.agent.verifier.invalidate_evidence(
+#### 📝 Description + +
+
+ +
+
+ +Revoke Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -11408,6 +11971,20 @@ client.agent.verifier.revoke(
+#### 📝 Description + +
+
+ +
+
+ +List Agent Skill Candidate Reviews. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -11483,6 +12060,20 @@ client.agent.skill.candidate.list(
+#### 📝 Description + +
+
+ +
+
+ +Get Agent Skill Candidate Review. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -11574,7 +12165,7 @@ client.agent.skill.evaluation.create_for_candidate( review_uuid="review_uuid", candidate_uuid="candidate_uuid", evaluated_by="customer", - evaluator_version="evaluator_version", + evaluator_version="v1.0.0", expected_revision=1, verdict="succeeded", ) @@ -11618,6 +12209,9 @@ client.agent.skill.evaluation.create_for_candidate(
**evaluated_by:** `CreateAgentSkillCandidateEvaluationRequestEvaluatedBy` + +The developer selects the evaluation source. Valid values are customer, tool, +offline_corpus, policy.
@@ -11625,7 +12219,7 @@ client.agent.skill.evaluation.create_for_candidate(
-**evaluator_version:** `str` +**evaluator_version:** `str` — The developer supplies the version of the evaluation rule.
@@ -11633,7 +12227,7 @@ client.agent.skill.evaluation.create_for_candidate(
-**expected_revision:** `int` +**expected_revision:** `int` — The developer supplies the current revision used for optimistic concurrency. At least 1.
@@ -11642,6 +12236,9 @@ client.agent.skill.evaluation.create_for_candidate(
**verdict:** `CreateAgentSkillCandidateEvaluationRequestVerdict` + +The developer supplies evaluation verdict. Valid values are succeeded, failed, partial, +unknown.
@@ -11649,7 +12246,7 @@ client.agent.skill.evaluation.create_for_candidate(
-**controlled_test:** `typing.Optional[bool]` +**controlled_test:** `typing.Optional[bool]` — The developer sets this to true when a controlled test produced the result.
@@ -11657,7 +12254,7 @@ client.agent.skill.evaluation.create_for_candidate(
-**environment:** `typing.Optional[str]` +**environment:** `typing.Optional[str]` — The developer supplies the environment for this evaluation.
@@ -11665,7 +12262,7 @@ client.agent.skill.evaluation.create_for_candidate(
-**evidence_reference:** `typing.Optional[str]` +**evidence_reference:** `typing.Optional[str]` — The developer links this evaluation to an evidence record.
@@ -11673,7 +12270,7 @@ client.agent.skill.evaluation.create_for_candidate(
-**metrics:** `typing.Optional[typing.Dict[str, float]]` +**metrics:** `typing.Optional[typing.Dict[str, float]]` — The developer supplies evaluation metrics.
@@ -11697,6 +12294,20 @@ client.agent.skill.evaluation.create_for_candidate(
+#### 📝 Description + +
+
+ +
+
+ +Record Agent Skill Evaluation. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -11718,7 +12329,7 @@ client.agent.skill.evaluation.create( agent_uuid="agent_uuid", skill_uuid="skill_uuid", evaluated_by="customer", - evaluator_version="evaluator_version", + evaluator_version="v1.0.0", skill_version=1, verdict="succeeded", ) @@ -11754,6 +12365,9 @@ client.agent.skill.evaluation.create(
**evaluated_by:** `CreateAgentSkillEvaluationRequestEvaluatedBy` + +The developer selects the evaluation source. Valid values are customer, tool, +offline_corpus, policy.
@@ -11761,7 +12375,7 @@ client.agent.skill.evaluation.create(
-**evaluator_version:** `str` +**evaluator_version:** `str` — The developer supplies the evaluation rule version. It can contain up to 255 characters.
@@ -11769,7 +12383,7 @@ client.agent.skill.evaluation.create(
-**skill_version:** `int` +**skill_version:** `int` — The developer supplies the Skill version to evaluate. It must be at least 1.
@@ -11778,6 +12392,9 @@ client.agent.skill.evaluation.create(
**verdict:** `CreateAgentSkillEvaluationRequestVerdict` + +The developer supplies evaluation verdict. Valid values are succeeded, failed, partial, +unknown.
@@ -11785,7 +12402,7 @@ client.agent.skill.evaluation.create(
-**controlled_test:** `typing.Optional[bool]` +**controlled_test:** `typing.Optional[bool]` — The developer sets this to true when a controlled test produced the result.
@@ -11793,7 +12410,7 @@ client.agent.skill.evaluation.create(
-**environment:** `typing.Optional[str]` +**environment:** `typing.Optional[str]` — The developer supplies the environment for this evaluation. At most 1024.
@@ -11801,7 +12418,7 @@ client.agent.skill.evaluation.create(
-**evidence_reference:** `typing.Optional[str]` +**evidence_reference:** `typing.Optional[str]` — The developer links this evaluation to an evidence record.
@@ -11809,7 +12426,7 @@ client.agent.skill.evaluation.create(
-**metrics:** `typing.Optional[typing.Dict[str, float]]` +**metrics:** `typing.Optional[typing.Dict[str, float]]` — The developer supplies evaluation metrics.
@@ -11817,7 +12434,7 @@ client.agent.skill.evaluation.create(
-**use_uuid:** `typing.Optional[str]` +**use_uuid:** `typing.Optional[str]` — The developer can link this evaluation to a recorded Skill use.
@@ -11850,7 +12467,7 @@ client.agent.skill.evaluation.create(
-Find a destination Skill by its source Agent, Skill, and version. The endpoint returns 404 until an automatic publication is ready or after it is invalidated. +Find a destination Skill by its source Agent, Skill, and version. The endpoint returns 404 until an automatic publication is ready or after it is invalidated. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -11950,7 +12567,7 @@ client.agent.skill.publication.lookup(
-Get the publication that created a destination Skill. Use its source version and policy identity to verify a copied Skill. The endpoint returns 404 for unpublished and invalidated Skills. +Get the publication that created a destination Skill. Use its source version and policy identity to verify a copied Skill. The endpoint returns 404 for unpublished and invalidated Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -12025,6 +12642,20 @@ client.agent.skill.publication.get(
+#### 📝 Description + +
+
+ +
+
+ +List Agent Skill Evidence. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -12110,6 +12741,20 @@ client.agent.skill.evidence.list(
+#### 📝 Description + +
+
+ +
+
+ +List Agent Skill Relationships. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -12203,6 +12848,20 @@ client.agent.skill.relation.list(
+#### 📝 Description + +
+
+ +
+
+ +Restore Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -12257,7 +12916,7 @@ client.agent.skill.version.restore_version(
-**expected_version:** `int` +**expected_version:** `int` — The developer supplies the current Skill version to protect against concurrent edits.
@@ -12265,7 +12924,7 @@ client.agent.skill.version.restore_version(
-**version:** `int` +**version:** `int` — The developer supplies the Skill version to restore.
@@ -12289,6 +12948,20 @@ client.agent.skill.version.restore_version(
+#### 📝 Description + +
+
+ +
+
+ +List Agent Skill Versions. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -12381,6 +13054,20 @@ client.agent.skill.version.list(
+#### 📝 Description + +
+
+ +
+
+ +Compare Agent Skill Versions. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -12435,7 +13122,7 @@ client.agent.skill.version.compare(
-**from_version:** `int` +**from_version:** `int` — The developer supplies the source version to compare. It must be at least 1.
@@ -12443,7 +13130,7 @@ client.agent.skill.version.compare(
-**to_version:** `int` +**to_version:** `int` — The developer supplies the destination version to compare. It must be at least 1.
@@ -12467,6 +13154,20 @@ client.agent.skill.version.compare(
+#### 📝 Description + +
+
+ +
+
+ +Get Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -12553,6 +13254,20 @@ client.agent.skill.version.get(
+#### 📝 Description + +
+
+ +
+
+ +Create Agent Skill Use. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -12573,8 +13288,8 @@ client = Zep( client.agent.skill.use.create( agent_uuid="agent_uuid", skill_uuid="skill_uuid", - search_id="search_id", - trace_uuid="trace_uuid", + search_id="eyJ2IjoxLCJyZXF1ZXN0X2lkIjoiNmE5MDZlNzAtNTBjYS00ZTQzLWE4NzQtNWZjYWUwMmE3MWZhIn0.signature", + trace_uuid="6a906e70-50ca-4e43-a874-5fcae02a71fa", usage="selected", ) @@ -12608,7 +13323,7 @@ client.agent.skill.use.create(
-**search_id:** `str` +**search_id:** `str` — The developer supplies the signed search token returned by Skill search.
@@ -12616,7 +13331,7 @@ client.agent.skill.use.create(
-**trace_uuid:** `str` +**trace_uuid:** `str` — The developer supplies the UUID of the source Trace.
@@ -12625,6 +13340,9 @@ client.agent.skill.use.create(
**usage:** `CreateAgentSkillUseRequestUsage` + +The developer supplies how the Skill was used. Valid values are selected, used, +partially_used, ignored, inapplicable.
@@ -12633,6 +13351,9 @@ client.agent.skill.use.create(
**outcome:** `typing.Optional[AddAgentSkillUseOutcomeRequest]` + +The developer records the outcome of the attempt. Valid values are +succeeded, failed, partial, abandoned, and unknown.
@@ -12640,7 +13361,7 @@ client.agent.skill.use.create(
-**reason_code:** `typing.Optional[str]` +**reason_code:** `typing.Optional[str]` — The developer supplies a reason code for this outcome. It can contain up to 255 characters.
@@ -12664,6 +13385,20 @@ client.agent.skill.use.create(
+#### 📝 Description + +
+
+ +
+
+ +Record Agent Skill Feedback. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -12751,6 +13486,20 @@ client.agent.skill.use.add_outcome(
+#### 📝 Description + +
+
+ +
+
+ +Export an Agent Skill version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -12828,6 +13577,20 @@ client.agent.skill.export.create(
+#### 📝 Description + +
+
+ +
+
+ +Download an Agent Skill export. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. +
+
+
+
+ #### 🔌 Usage
@@ -12923,7 +13686,7 @@ client.agent.skill.export.get(
-List runs that belong to this trace import. +List runs that belong to this trace import. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -13021,7 +13784,7 @@ client.agent.trace_import.run.list(
-Create a pending run and its Task. This operation does not start the run. +Create a pending run and its Task. This operation does not start the run. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -13103,7 +13866,7 @@ client.agent.trace_import.run.create(
-Read one run that belongs to this trace import. +Read one run that belongs to this trace import. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -13195,7 +13958,7 @@ client.agent.trace_import.run.get(
-List trace results for this run. Run items do not include source payload. +List trace results for this run. Run items do not include source payload. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com.
@@ -16468,7 +17231,7 @@ client.trace_connection.trace.get(
-**provider_project_id:** `str` — ProviderProjectID is the provider project identifier. +**provider_project_id:** `str` — The developer supplies the project ID from the selected provider.
@@ -16566,7 +17329,7 @@ client.trace_connection.trace.list(
-**provider_project_id:** `str` — ProviderProjectID is the provider project identifier. +**provider_project_id:** `str` — The developer supplies the project ID from the selected provider.
diff --git a/src/zep_cloud/__init__.py b/src/zep_cloud/__init__.py index cee48966..727a3738 100644 --- a/src/zep_cloud/__init__.py +++ b/src/zep_cloud/__init__.py @@ -209,6 +209,34 @@ GraphDataType, GraphDeleteResult, GraphPage, + GraphQueryCitations, + GraphQueryEdge, + GraphQueryErrorEvent, + GraphQueryHandle, + GraphQueryHandleItemType, + GraphQueryListing, + GraphQueryNode, + GraphQueryPlan, + GraphQueryPlanEvent, + GraphQueryPlanStep, + GraphQueryReasoningEvent, + GraphQueryResponse, + GraphQueryResultEvent, + GraphQueryResults, + GraphQueryStartedEvent, + GraphQueryStreamEvent, + GraphQueryStreamEvent_Error, + GraphQueryStreamEvent_Plan, + GraphQueryStreamEvent_Reasoning, + GraphQueryStreamEvent_Result, + GraphQueryStreamEvent_Started, + GraphQueryStreamEvent_ToolCall, + GraphQueryStreamEvent_ToolError, + GraphQueryStreamEvent_ToolResult, + GraphQueryToolCallEvent, + GraphQueryToolErrorEvent, + GraphQueryToolErrorEventReason, + GraphQueryToolResultEvent, Hyperedge, HyperedgeEdge, HyperedgeInput, @@ -357,8 +385,10 @@ ConflictError, ContentTooLargeError, ForbiddenError, + InternalServerError, NotFoundError, ServiceUnavailableError, + TooManyRequestsError, UnauthorizedError, UnprocessableEntityError, ) @@ -385,6 +415,7 @@ GraphContextRequestRecencyBias, GraphListRequestOrder, GraphListRequestOrderBy, + GraphQueryRequestMode, SearchEdgesRequestReranker, SearchEpisodesRequestReranker, SearchNodesRequestReranker, @@ -614,6 +645,35 @@ "GraphListRequestOrder": ".graph", "GraphListRequestOrderBy": ".graph", "GraphPage": ".types", + "GraphQueryCitations": ".types", + "GraphQueryEdge": ".types", + "GraphQueryErrorEvent": ".types", + "GraphQueryHandle": ".types", + "GraphQueryHandleItemType": ".types", + "GraphQueryListing": ".types", + "GraphQueryNode": ".types", + "GraphQueryPlan": ".types", + "GraphQueryPlanEvent": ".types", + "GraphQueryPlanStep": ".types", + "GraphQueryReasoningEvent": ".types", + "GraphQueryRequestMode": ".graph", + "GraphQueryResponse": ".types", + "GraphQueryResultEvent": ".types", + "GraphQueryResults": ".types", + "GraphQueryStartedEvent": ".types", + "GraphQueryStreamEvent": ".types", + "GraphQueryStreamEvent_Error": ".types", + "GraphQueryStreamEvent_Plan": ".types", + "GraphQueryStreamEvent_Reasoning": ".types", + "GraphQueryStreamEvent_Result": ".types", + "GraphQueryStreamEvent_Started": ".types", + "GraphQueryStreamEvent_ToolCall": ".types", + "GraphQueryStreamEvent_ToolError": ".types", + "GraphQueryStreamEvent_ToolResult": ".types", + "GraphQueryToolCallEvent": ".types", + "GraphQueryToolErrorEvent": ".types", + "GraphQueryToolErrorEventReason": ".types", + "GraphQueryToolResultEvent": ".types", "Hyperedge": ".types", "HyperedgeEdge": ".types", "HyperedgeInput": ".types", @@ -636,6 +696,7 @@ "IngestionTraceStatus": ".types", "IngestionTraceStep": ".types", "Instructions": ".types", + "InternalServerError": ".errors", "LookupBatchResponse": ".types", "LookupItem": ".types", "LookupItemResourceType": ".types", @@ -729,6 +790,7 @@ "ThreadSummaryListFilters": ".types", "ThreadSummaryPage": ".types", "ThreadSummarySearchFilters": ".types", + "TooManyRequestsError": ".errors", "TraceConnection": ".types", "TraceConnectionPage": ".types", "TraceConnectionProvider": ".types", @@ -1027,6 +1089,35 @@ def __dir__(): "GraphListRequestOrder", "GraphListRequestOrderBy", "GraphPage", + "GraphQueryCitations", + "GraphQueryEdge", + "GraphQueryErrorEvent", + "GraphQueryHandle", + "GraphQueryHandleItemType", + "GraphQueryListing", + "GraphQueryNode", + "GraphQueryPlan", + "GraphQueryPlanEvent", + "GraphQueryPlanStep", + "GraphQueryReasoningEvent", + "GraphQueryRequestMode", + "GraphQueryResponse", + "GraphQueryResultEvent", + "GraphQueryResults", + "GraphQueryStartedEvent", + "GraphQueryStreamEvent", + "GraphQueryStreamEvent_Error", + "GraphQueryStreamEvent_Plan", + "GraphQueryStreamEvent_Reasoning", + "GraphQueryStreamEvent_Result", + "GraphQueryStreamEvent_Started", + "GraphQueryStreamEvent_ToolCall", + "GraphQueryStreamEvent_ToolError", + "GraphQueryStreamEvent_ToolResult", + "GraphQueryToolCallEvent", + "GraphQueryToolErrorEvent", + "GraphQueryToolErrorEventReason", + "GraphQueryToolResultEvent", "Hyperedge", "HyperedgeEdge", "HyperedgeInput", @@ -1049,6 +1140,7 @@ def __dir__(): "IngestionTraceStatus", "IngestionTraceStep", "Instructions", + "InternalServerError", "LookupBatchResponse", "LookupItem", "LookupItemResourceType", @@ -1142,6 +1234,7 @@ def __dir__(): "ThreadSummaryListFilters", "ThreadSummaryPage", "ThreadSummarySearchFilters", + "TooManyRequestsError", "TraceConnection", "TraceConnectionPage", "TraceConnectionProvider", diff --git a/src/zep_cloud/agent/client.py b/src/zep_cloud/agent/client.py index f461ea91..7b3c090a 100644 --- a/src/zep_cloud/agent/client.py +++ b/src/zep_cloud/agent/client.py @@ -115,9 +115,9 @@ def create( api_key="YOUR_API_KEY", ) client.agent.create( - agent_id="agent_id", - name="name", - security_domain="security_domain", + agent_id="payments-agent", + name="Refund a duplicate charge", + security_domain="customer:support", ) """ _response = self._raw_client.create( @@ -168,13 +168,13 @@ def list( Filters to the exact developer-assigned Agent identifier. deployment_id : typing.Optional[str] - Filters to the exact deployment identifier. + The developer supplies filters to the exact deployment identifier. metadata : typing.Optional[typing.Dict[str, typing.Any]] Filters to Agents whose metadata contains these key-value pairs. search : typing.Optional[str] - Filters to Agents whose name, Agent identifier, deployment identifier, + The developer supplies filters to Agents whose name, Agent identifier, deployment identifier, or deployment version contains this text. Matching is case-insensitive. status : typing.Optional[AgentStatus] @@ -382,14 +382,19 @@ def declare_breaking_change( request_options: typing.Optional[RequestOptions] = None, ) -> AgentBreakingChange: """ + Declare a breaking Agent deployment change. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID expected_revision : int + The developer supplies the current Agent revision for optimistic concurrency. + It must be at least 1. version : str + The developer supplies the new deployment version. It must differ from the current version. idempotency_key : typing.Optional[str] @@ -411,7 +416,7 @@ def declare_breaking_change( client.agent.declare_breaking_change( agent_uuid="agent_uuid", expected_revision=1, - version="version", + version="2026.09.01", ) """ _response = self._raw_client.declare_breaking_change( @@ -438,26 +443,36 @@ def get_context( request_options: typing.Optional[RequestOptions] = None, ) -> AgentContext: """ + Get Agent context. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID environments : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies environment names used by the Skill. At most 32. kind : typing.Optional[str] + The developer supplies a Skill kind. At most 64. max_characters : typing.Optional[int] + The developer sets the maximum number of characters in the context response. models : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies models used for this evaluation. At most 32. objective : typing.Optional[str] + The developer supplies the task-instance objective. At most 512. task_family : typing.Optional[str] + The developer supplies the task-family slug. At most 128. tools : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies tool names used by the Skill. At most 32. trace_uuid : typing.Optional[str] + The developer supplies the UUID of the source Trace. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -645,9 +660,9 @@ async def create( async def main() -> None: await client.agent.create( - agent_id="agent_id", - name="name", - security_domain="security_domain", + agent_id="payments-agent", + name="Refund a duplicate charge", + security_domain="customer:support", ) @@ -701,13 +716,13 @@ async def list( Filters to the exact developer-assigned Agent identifier. deployment_id : typing.Optional[str] - Filters to the exact deployment identifier. + The developer supplies filters to the exact deployment identifier. metadata : typing.Optional[typing.Dict[str, typing.Any]] Filters to Agents whose metadata contains these key-value pairs. search : typing.Optional[str] - Filters to Agents whose name, Agent identifier, deployment identifier, + The developer supplies filters to Agents whose name, Agent identifier, deployment identifier, or deployment version contains this text. Matching is case-insensitive. status : typing.Optional[AgentStatus] @@ -948,14 +963,19 @@ async def declare_breaking_change( request_options: typing.Optional[RequestOptions] = None, ) -> AgentBreakingChange: """ + Declare a breaking Agent deployment change. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID expected_revision : int + The developer supplies the current Agent revision for optimistic concurrency. + It must be at least 1. version : str + The developer supplies the new deployment version. It must differ from the current version. idempotency_key : typing.Optional[str] @@ -982,7 +1002,7 @@ async def main() -> None: await client.agent.declare_breaking_change( agent_uuid="agent_uuid", expected_revision=1, - version="version", + version="2026.09.01", ) @@ -1012,26 +1032,36 @@ async def get_context( request_options: typing.Optional[RequestOptions] = None, ) -> AgentContext: """ + Get Agent context. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID environments : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies environment names used by the Skill. At most 32. kind : typing.Optional[str] + The developer supplies a Skill kind. At most 64. max_characters : typing.Optional[int] + The developer sets the maximum number of characters in the context response. models : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies models used for this evaluation. At most 32. objective : typing.Optional[str] + The developer supplies the task-instance objective. At most 512. task_family : typing.Optional[str] + The developer supplies the task-family slug. At most 128. tools : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies tool names used by the Skill. At most 32. trace_uuid : typing.Optional[str] + The developer supplies the UUID of the source Trace. request_options : typing.Optional[RequestOptions] Request-specific configuration. diff --git a/src/zep_cloud/agent/learning/client.py b/src/zep_cloud/agent/learning/client.py index 5ed72a7e..839ff065 100644 --- a/src/zep_cloud/agent/learning/client.py +++ b/src/zep_cloud/agent/learning/client.py @@ -30,6 +30,8 @@ def get( self, agent_uuid: str, *, task_family: str, request_options: typing.Optional[RequestOptions] = None ) -> AgentLearningState: """ + Get Agent Learning State. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -71,6 +73,8 @@ def list_runs( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillCompilationOutcome, Pagev4AgentSkillCompilationOutcome]: """ + List durable learning-run outcomes for an Agent. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -133,6 +137,8 @@ async def get( self, agent_uuid: str, *, task_family: str, request_options: typing.Optional[RequestOptions] = None ) -> AgentLearningState: """ + Get Agent Learning State. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -182,6 +188,8 @@ async def list_runs( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillCompilationOutcome, Pagev4AgentSkillCompilationOutcome]: """ + List durable learning-run outcomes for an Agent. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/learning/raw_client.py b/src/zep_cloud/agent/learning/raw_client.py index da3f2e34..911bb935 100644 --- a/src/zep_cloud/agent/learning/raw_client.py +++ b/src/zep_cloud/agent/learning/raw_client.py @@ -30,6 +30,8 @@ def get( self, agent_uuid: str, *, task_family: str, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[AgentLearningState]: """ + Get Agent Learning State. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -131,6 +133,8 @@ def list_runs( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillCompilationOutcome, Pagev4AgentSkillCompilationOutcome]: """ + List durable learning-run outcomes for an Agent. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -194,6 +198,28 @@ def list_runs( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), @@ -227,6 +253,8 @@ async def get( self, agent_uuid: str, *, task_family: str, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[AgentLearningState]: """ + Get Agent Learning State. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -328,6 +356,8 @@ async def list_runs( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillCompilationOutcome, Pagev4AgentSkillCompilationOutcome]: """ + List durable learning-run outcomes for an Agent. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -394,6 +424,28 @@ async def _get_next(): ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), diff --git a/src/zep_cloud/agent/literal_policy/client.py b/src/zep_cloud/agent/literal_policy/client.py index dd9b2e3b..9fb6d6b6 100644 --- a/src/zep_cloud/agent/literal_policy/client.py +++ b/src/zep_cloud/agent/literal_policy/client.py @@ -31,6 +31,8 @@ def with_raw_response(self) -> RawLiteralPolicyClient: def get(self, agent_uuid: str, *, request_options: typing.Optional[RequestOptions] = None) -> AgentLiteralPolicy: """ + Get Agent Literal Policy. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -70,6 +72,8 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> AgentLiteralPolicy: """ + Update Agent Literal Policy. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -107,12 +111,12 @@ def update( client.agent.literal_policy.update( agent_uuid="agent_uuid", allowlisted_classes=AgentLiteralPolicyClasses( - environments=["environments"], - tools=["tools"], + environments=["environment_name"], + tools=["command_name"], ), allowlisted_values=AgentLiteralPolicyValues( - environments=["environments"], - tools=["tools"], + environments=["production"], + tools=["refund_payment"], ), default="parameterize", ) @@ -148,6 +152,8 @@ async def get( self, agent_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AgentLiteralPolicy: """ + Get Agent Literal Policy. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -195,6 +201,8 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> AgentLiteralPolicy: """ + Update Agent Literal Policy. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -241,12 +249,12 @@ async def main() -> None: await client.agent.literal_policy.update( agent_uuid="agent_uuid", allowlisted_classes=AgentLiteralPolicyClasses( - environments=["environments"], - tools=["tools"], + environments=["environment_name"], + tools=["command_name"], ), allowlisted_values=AgentLiteralPolicyValues( - environments=["environments"], - tools=["tools"], + environments=["production"], + tools=["refund_payment"], ), default="parameterize", ) diff --git a/src/zep_cloud/agent/literal_policy/raw_client.py b/src/zep_cloud/agent/literal_policy/raw_client.py index f117cfa8..0dae7f7e 100644 --- a/src/zep_cloud/agent/literal_policy/raw_client.py +++ b/src/zep_cloud/agent/literal_policy/raw_client.py @@ -36,6 +36,8 @@ def get( self, agent_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[AgentLiteralPolicy]: """ + Get Agent Literal Policy. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -133,6 +135,8 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentLiteralPolicy]: """ + Update Agent Literal Policy. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -267,6 +271,8 @@ async def get( self, agent_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[AgentLiteralPolicy]: """ + Get Agent Literal Policy. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -364,6 +370,8 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentLiteralPolicy]: """ + Update Agent Literal Policy. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/raw_client.py b/src/zep_cloud/agent/raw_client.py index 8437164e..8655a777 100644 --- a/src/zep_cloud/agent/raw_client.py +++ b/src/zep_cloud/agent/raw_client.py @@ -225,13 +225,13 @@ def list( Filters to the exact developer-assigned Agent identifier. deployment_id : typing.Optional[str] - Filters to the exact deployment identifier. + The developer supplies filters to the exact deployment identifier. metadata : typing.Optional[typing.Dict[str, typing.Any]] Filters to Agents whose metadata contains these key-value pairs. search : typing.Optional[str] - Filters to Agents whose name, Agent identifier, deployment identifier, + The developer supplies filters to Agents whose name, Agent identifier, deployment identifier, or deployment version contains this text. Matching is case-insensitive. status : typing.Optional[AgentStatus] @@ -720,14 +720,19 @@ def declare_breaking_change( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentBreakingChange]: """ + Declare a breaking Agent deployment change. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID expected_revision : int + The developer supplies the current Agent revision for optimistic concurrency. + It must be at least 1. version : str + The developer supplies the new deployment version. It must differ from the current version. idempotency_key : typing.Optional[str] @@ -846,26 +851,36 @@ def get_context( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentContext]: """ + Get Agent context. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID environments : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies environment names used by the Skill. At most 32. kind : typing.Optional[str] + The developer supplies a Skill kind. At most 64. max_characters : typing.Optional[int] + The developer sets the maximum number of characters in the context response. models : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies models used for this evaluation. At most 32. objective : typing.Optional[str] + The developer supplies the task-instance objective. At most 512. task_family : typing.Optional[str] + The developer supplies the task-family slug. At most 128. tools : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies tool names used by the Skill. At most 32. trace_uuid : typing.Optional[str] + The developer supplies the UUID of the source Trace. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1169,13 +1184,13 @@ async def list( Filters to the exact developer-assigned Agent identifier. deployment_id : typing.Optional[str] - Filters to the exact deployment identifier. + The developer supplies filters to the exact deployment identifier. metadata : typing.Optional[typing.Dict[str, typing.Any]] Filters to Agents whose metadata contains these key-value pairs. search : typing.Optional[str] - Filters to Agents whose name, Agent identifier, deployment identifier, + The developer supplies filters to Agents whose name, Agent identifier, deployment identifier, or deployment version contains this text. Matching is case-insensitive. status : typing.Optional[AgentStatus] @@ -1669,14 +1684,19 @@ async def declare_breaking_change( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentBreakingChange]: """ + Declare a breaking Agent deployment change. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID expected_revision : int + The developer supplies the current Agent revision for optimistic concurrency. + It must be at least 1. version : str + The developer supplies the new deployment version. It must differ from the current version. idempotency_key : typing.Optional[str] @@ -1795,26 +1815,36 @@ async def get_context( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentContext]: """ + Get Agent context. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID environments : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies environment names used by the Skill. At most 32. kind : typing.Optional[str] + The developer supplies a Skill kind. At most 64. max_characters : typing.Optional[int] + The developer sets the maximum number of characters in the context response. models : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies models used for this evaluation. At most 32. objective : typing.Optional[str] + The developer supplies the task-instance objective. At most 512. task_family : typing.Optional[str] + The developer supplies the task-family slug. At most 128. tools : typing.Optional[typing.Sequence[AgentContextResource]] + The developer supplies tool names used by the Skill. At most 32. trace_uuid : typing.Optional[str] + The developer supplies the UUID of the source Trace. request_options : typing.Optional[RequestOptions] Request-specific configuration. diff --git a/src/zep_cloud/agent/skill/candidate/client.py b/src/zep_cloud/agent/skill/candidate/client.py index 2f04acf5..e2d3b234 100644 --- a/src/zep_cloud/agent/skill/candidate/client.py +++ b/src/zep_cloud/agent/skill/candidate/client.py @@ -35,6 +35,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillCandidateReviewSummary, Pagev4AgentSkillCandidateReviewSummary]: """ + List Agent Skill Candidate Reviews. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -76,6 +78,8 @@ def get( self, agent_uuid: str, review_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AgentSkillCandidateReview: """ + Get Agent Skill Candidate Review. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -132,6 +136,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillCandidateReviewSummary, Pagev4AgentSkillCandidateReviewSummary]: """ + List Agent Skill Candidate Reviews. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -184,6 +190,8 @@ async def get( self, agent_uuid: str, review_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AgentSkillCandidateReview: """ + Get Agent Skill Candidate Review. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/skill/candidate/raw_client.py b/src/zep_cloud/agent/skill/candidate/raw_client.py index 849046e1..f25e37a7 100644 --- a/src/zep_cloud/agent/skill/candidate/raw_client.py +++ b/src/zep_cloud/agent/skill/candidate/raw_client.py @@ -37,6 +37,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillCandidateReviewSummary, Pagev4AgentSkillCandidateReviewSummary]: """ + List Agent Skill Candidate Reviews. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -156,6 +158,8 @@ def get( self, agent_uuid: str, review_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[AgentSkillCandidateReview]: """ + Get Agent Skill Candidate Review. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -280,6 +284,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillCandidateReviewSummary, Pagev4AgentSkillCandidateReviewSummary]: """ + List Agent Skill Candidate Reviews. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -402,6 +408,8 @@ async def get( self, agent_uuid: str, review_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[AgentSkillCandidateReview]: """ + Get Agent Skill Candidate Review. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/skill/client.py b/src/zep_cloud/agent/skill/client.py index deca5b85..605b68ed 100644 --- a/src/zep_cloud/agent/skill/client.py +++ b/src/zep_cloud/agent/skill/client.py @@ -65,14 +65,19 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkill: """ + Create Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID definition : SkillDefinition + The developer supplies the structured content of the Skill. skill_id : typing.Optional[str] + The developer can set a stable ID for the Skill. If omitted, the service + assigns one. idempotency_key : typing.Optional[str] @@ -114,7 +119,7 @@ def import_package( request_options: typing.Optional[RequestOptions] = None, ) -> Task: """ - Submit a portable Skill archive. The completed Task returns `{"result":{"skill_uuid":""}}`. Approve that Skill before retrieval. + Submit a portable Skill archive. The completed Task returns `{"result":{"skill_uuid":""}}`. Approve that Skill before retrieval. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -151,6 +156,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillSearchHit, Pagev4AgentSkillSearchHit]: """ + List Agent Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -163,12 +170,16 @@ def list( Opaque page cursor environments : typing.Optional[typing.Sequence[str]] + The developer filters results by environment names. kind : typing.Optional[str] + The developer supplies a Skill kind. task_family : typing.Optional[str] + The developer supplies the task-family slug. tools : typing.Optional[typing.Sequence[str]] + The developer supplies tool names used by the Skill. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -221,12 +232,15 @@ def search( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillSearchHit, AgentSkillSearchResponse]: """ + Search Agent Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID query : str + The developer supplies a search query for Skills. page_size : typing.Optional[int] The maximum number of items in one page. The SDK method returns a pager. In Python, `.items` holds only the first page. In TypeScript, `.data` holds only the first page. To read every page, iterate the pager: use `for` or `list(...)` in Python, or `for await` in TypeScript. In Go, the method returns one page, and `Iterator()` reads all pages. @@ -235,10 +249,13 @@ def search( Opaque page cursor environments : typing.Optional[typing.Sequence[str]] + The developer supplies environment names used by the Skill. include_markdown : typing.Optional[bool] + The developer sets this to true to include the Skill instructions in Markdown. kind : typing.Optional[str] + The developer supplies a Skill kind. markdown_format : typing.Optional[AgentSkillSearchRequestMarkdownFormat] MarkdownFormat selects the form of inline `markdown`. `agent` (the @@ -247,8 +264,10 @@ def search( sections. `full` returns the stored SKILL.md with its evidence markers. task_family : typing.Optional[str] + The developer supplies the task-family slug. tools : typing.Optional[typing.Sequence[str]] + The developer supplies tool names used by the Skill. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -267,7 +286,7 @@ def search( ) response = client.agent.skill.search( agent_uuid="agent_uuid", - query="query", + query="How do I refund a duplicate charge?", ) for item in response: yield item @@ -293,6 +312,8 @@ def get( self, agent_uuid: str, skill_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AgentSkill: """ + Get Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -334,6 +355,8 @@ def approve( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillAdmissionDecision: """ + Approve Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -343,6 +366,7 @@ def approve( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] @@ -386,6 +410,8 @@ def retire( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkill: """ + Retire Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -395,6 +421,7 @@ def retire( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] @@ -439,6 +466,8 @@ def create_version( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillVersion: """ + Create Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -448,8 +477,10 @@ def create_version( Skill UUID definition : SkillDefinition + The developer supplies the structured content for the new Skill version. expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] @@ -584,14 +615,19 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkill: """ + Create Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID definition : SkillDefinition + The developer supplies the structured content of the Skill. skill_id : typing.Optional[str] + The developer can set a stable ID for the Skill. If omitted, the service + assigns one. idempotency_key : typing.Optional[str] @@ -641,7 +677,7 @@ async def import_package( request_options: typing.Optional[RequestOptions] = None, ) -> Task: """ - Submit a portable Skill archive. The completed Task returns `{"result":{"skill_uuid":""}}`. Approve that Skill before retrieval. + Submit a portable Skill archive. The completed Task returns `{"result":{"skill_uuid":""}}`. Approve that Skill before retrieval. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -678,6 +714,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillSearchHit, Pagev4AgentSkillSearchHit]: """ + List Agent Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -690,12 +728,16 @@ async def list( Opaque page cursor environments : typing.Optional[typing.Sequence[str]] + The developer filters results by environment names. kind : typing.Optional[str] + The developer supplies a Skill kind. task_family : typing.Optional[str] + The developer supplies the task-family slug. tools : typing.Optional[typing.Sequence[str]] + The developer supplies tool names used by the Skill. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -757,12 +799,15 @@ async def search( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillSearchHit, AgentSkillSearchResponse]: """ + Search Agent Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID query : str + The developer supplies a search query for Skills. page_size : typing.Optional[int] The maximum number of items in one page. The SDK method returns a pager. In Python, `.items` holds only the first page. In TypeScript, `.data` holds only the first page. To read every page, iterate the pager: use `for` or `list(...)` in Python, or `for await` in TypeScript. In Go, the method returns one page, and `Iterator()` reads all pages. @@ -771,10 +816,13 @@ async def search( Opaque page cursor environments : typing.Optional[typing.Sequence[str]] + The developer supplies environment names used by the Skill. include_markdown : typing.Optional[bool] + The developer sets this to true to include the Skill instructions in Markdown. kind : typing.Optional[str] + The developer supplies a Skill kind. markdown_format : typing.Optional[AgentSkillSearchRequestMarkdownFormat] MarkdownFormat selects the form of inline `markdown`. `agent` (the @@ -783,8 +831,10 @@ async def search( sections. `full` returns the stored SKILL.md with its evidence markers. task_family : typing.Optional[str] + The developer supplies the task-family slug. tools : typing.Optional[typing.Sequence[str]] + The developer supplies tool names used by the Skill. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -808,7 +858,7 @@ async def search( async def main() -> None: response = await client.agent.skill.search( agent_uuid="agent_uuid", - query="query", + query="How do I refund a duplicate charge?", ) async for item in response: yield item @@ -838,6 +888,8 @@ async def get( self, agent_uuid: str, skill_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AgentSkill: """ + Get Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -887,6 +939,8 @@ async def approve( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillAdmissionDecision: """ + Approve Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -896,6 +950,7 @@ async def approve( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] @@ -947,6 +1002,8 @@ async def retire( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkill: """ + Retire Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -956,6 +1013,7 @@ async def retire( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] @@ -1008,6 +1066,8 @@ async def create_version( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillVersion: """ + Create Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -1017,8 +1077,10 @@ async def create_version( Skill UUID definition : SkillDefinition + The developer supplies the structured content for the new Skill version. expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] diff --git a/src/zep_cloud/agent/skill/evaluation/client.py b/src/zep_cloud/agent/skill/evaluation/client.py index 5b06f17b..ec3582d3 100644 --- a/src/zep_cloud/agent/skill/evaluation/client.py +++ b/src/zep_cloud/agent/skill/evaluation/client.py @@ -65,20 +65,30 @@ def create_for_candidate( Candidate UUID evaluated_by : CreateAgentSkillCandidateEvaluationRequestEvaluatedBy + The developer selects the evaluation source. Valid values are customer, tool, + offline_corpus, policy. evaluator_version : str + The developer supplies the version of the evaluation rule. expected_revision : int + The developer supplies the current revision used for optimistic concurrency. At least 1. verdict : CreateAgentSkillCandidateEvaluationRequestVerdict + The developer supplies evaluation verdict. Valid values are succeeded, failed, partial, + unknown. controlled_test : typing.Optional[bool] + The developer sets this to true when a controlled test produced the result. environment : typing.Optional[str] + The developer supplies the environment for this evaluation. evidence_reference : typing.Optional[str] + The developer links this evaluation to an evidence record. metrics : typing.Optional[typing.Dict[str, float]] + The developer supplies evaluation metrics. idempotency_key : typing.Optional[str] @@ -102,7 +112,7 @@ def create_for_candidate( review_uuid="review_uuid", candidate_uuid="candidate_uuid", evaluated_by="customer", - evaluator_version="evaluator_version", + evaluator_version="v1.0.0", expected_revision=1, verdict="succeeded", ) @@ -142,6 +152,8 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillEvaluation: """ + Record Agent Skill Evaluation. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -151,22 +163,33 @@ def create( Skill UUID evaluated_by : CreateAgentSkillEvaluationRequestEvaluatedBy + The developer selects the evaluation source. Valid values are customer, tool, + offline_corpus, policy. evaluator_version : str + The developer supplies the evaluation rule version. It can contain up to 255 characters. skill_version : int + The developer supplies the Skill version to evaluate. It must be at least 1. verdict : CreateAgentSkillEvaluationRequestVerdict + The developer supplies evaluation verdict. Valid values are succeeded, failed, partial, + unknown. controlled_test : typing.Optional[bool] + The developer sets this to true when a controlled test produced the result. environment : typing.Optional[str] + The developer supplies the environment for this evaluation. At most 1024. evidence_reference : typing.Optional[str] + The developer links this evaluation to an evidence record. metrics : typing.Optional[typing.Dict[str, float]] + The developer supplies evaluation metrics. use_uuid : typing.Optional[str] + The developer can link this evaluation to a recorded Skill use. idempotency_key : typing.Optional[str] @@ -189,7 +212,7 @@ def create( agent_uuid="agent_uuid", skill_uuid="skill_uuid", evaluated_by="customer", - evaluator_version="evaluator_version", + evaluator_version="v1.0.0", skill_version=1, verdict="succeeded", ) @@ -257,20 +280,30 @@ async def create_for_candidate( Candidate UUID evaluated_by : CreateAgentSkillCandidateEvaluationRequestEvaluatedBy + The developer selects the evaluation source. Valid values are customer, tool, + offline_corpus, policy. evaluator_version : str + The developer supplies the version of the evaluation rule. expected_revision : int + The developer supplies the current revision used for optimistic concurrency. At least 1. verdict : CreateAgentSkillCandidateEvaluationRequestVerdict + The developer supplies evaluation verdict. Valid values are succeeded, failed, partial, + unknown. controlled_test : typing.Optional[bool] + The developer sets this to true when a controlled test produced the result. environment : typing.Optional[str] + The developer supplies the environment for this evaluation. evidence_reference : typing.Optional[str] + The developer links this evaluation to an evidence record. metrics : typing.Optional[typing.Dict[str, float]] + The developer supplies evaluation metrics. idempotency_key : typing.Optional[str] @@ -299,7 +332,7 @@ async def main() -> None: review_uuid="review_uuid", candidate_uuid="candidate_uuid", evaluated_by="customer", - evaluator_version="evaluator_version", + evaluator_version="v1.0.0", expected_revision=1, verdict="succeeded", ) @@ -342,6 +375,8 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillEvaluation: """ + Record Agent Skill Evaluation. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -351,22 +386,33 @@ async def create( Skill UUID evaluated_by : CreateAgentSkillEvaluationRequestEvaluatedBy + The developer selects the evaluation source. Valid values are customer, tool, + offline_corpus, policy. evaluator_version : str + The developer supplies the evaluation rule version. It can contain up to 255 characters. skill_version : int + The developer supplies the Skill version to evaluate. It must be at least 1. verdict : CreateAgentSkillEvaluationRequestVerdict + The developer supplies evaluation verdict. Valid values are succeeded, failed, partial, + unknown. controlled_test : typing.Optional[bool] + The developer sets this to true when a controlled test produced the result. environment : typing.Optional[str] + The developer supplies the environment for this evaluation. At most 1024. evidence_reference : typing.Optional[str] + The developer links this evaluation to an evidence record. metrics : typing.Optional[typing.Dict[str, float]] + The developer supplies evaluation metrics. use_uuid : typing.Optional[str] + The developer can link this evaluation to a recorded Skill use. idempotency_key : typing.Optional[str] @@ -394,7 +440,7 @@ async def main() -> None: agent_uuid="agent_uuid", skill_uuid="skill_uuid", evaluated_by="customer", - evaluator_version="evaluator_version", + evaluator_version="v1.0.0", skill_version=1, verdict="succeeded", ) diff --git a/src/zep_cloud/agent/skill/evaluation/raw_client.py b/src/zep_cloud/agent/skill/evaluation/raw_client.py index b3f3d8d1..be754194 100644 --- a/src/zep_cloud/agent/skill/evaluation/raw_client.py +++ b/src/zep_cloud/agent/skill/evaluation/raw_client.py @@ -68,20 +68,30 @@ def create_for_candidate( Candidate UUID evaluated_by : CreateAgentSkillCandidateEvaluationRequestEvaluatedBy + The developer selects the evaluation source. Valid values are customer, tool, + offline_corpus, policy. evaluator_version : str + The developer supplies the version of the evaluation rule. expected_revision : int + The developer supplies the current revision used for optimistic concurrency. At least 1. verdict : CreateAgentSkillCandidateEvaluationRequestVerdict + The developer supplies evaluation verdict. Valid values are succeeded, failed, partial, + unknown. controlled_test : typing.Optional[bool] + The developer sets this to true when a controlled test produced the result. environment : typing.Optional[str] + The developer supplies the environment for this evaluation. evidence_reference : typing.Optional[str] + The developer links this evaluation to an evidence record. metrics : typing.Optional[typing.Dict[str, float]] + The developer supplies evaluation metrics. idempotency_key : typing.Optional[str] @@ -220,6 +230,8 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkillEvaluation]: """ + Record Agent Skill Evaluation. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -229,22 +241,33 @@ def create( Skill UUID evaluated_by : CreateAgentSkillEvaluationRequestEvaluatedBy + The developer selects the evaluation source. Valid values are customer, tool, + offline_corpus, policy. evaluator_version : str + The developer supplies the evaluation rule version. It can contain up to 255 characters. skill_version : int + The developer supplies the Skill version to evaluate. It must be at least 1. verdict : CreateAgentSkillEvaluationRequestVerdict + The developer supplies evaluation verdict. Valid values are succeeded, failed, partial, + unknown. controlled_test : typing.Optional[bool] + The developer sets this to true when a controlled test produced the result. environment : typing.Optional[str] + The developer supplies the environment for this evaluation. At most 1024. evidence_reference : typing.Optional[str] + The developer links this evaluation to an evidence record. metrics : typing.Optional[typing.Dict[str, float]] + The developer supplies evaluation metrics. use_uuid : typing.Optional[str] + The developer can link this evaluation to a recorded Skill use. idempotency_key : typing.Optional[str] @@ -390,20 +413,30 @@ async def create_for_candidate( Candidate UUID evaluated_by : CreateAgentSkillCandidateEvaluationRequestEvaluatedBy + The developer selects the evaluation source. Valid values are customer, tool, + offline_corpus, policy. evaluator_version : str + The developer supplies the version of the evaluation rule. expected_revision : int + The developer supplies the current revision used for optimistic concurrency. At least 1. verdict : CreateAgentSkillCandidateEvaluationRequestVerdict + The developer supplies evaluation verdict. Valid values are succeeded, failed, partial, + unknown. controlled_test : typing.Optional[bool] + The developer sets this to true when a controlled test produced the result. environment : typing.Optional[str] + The developer supplies the environment for this evaluation. evidence_reference : typing.Optional[str] + The developer links this evaluation to an evidence record. metrics : typing.Optional[typing.Dict[str, float]] + The developer supplies evaluation metrics. idempotency_key : typing.Optional[str] @@ -542,6 +575,8 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkillEvaluation]: """ + Record Agent Skill Evaluation. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -551,22 +586,33 @@ async def create( Skill UUID evaluated_by : CreateAgentSkillEvaluationRequestEvaluatedBy + The developer selects the evaluation source. Valid values are customer, tool, + offline_corpus, policy. evaluator_version : str + The developer supplies the evaluation rule version. It can contain up to 255 characters. skill_version : int + The developer supplies the Skill version to evaluate. It must be at least 1. verdict : CreateAgentSkillEvaluationRequestVerdict + The developer supplies evaluation verdict. Valid values are succeeded, failed, partial, + unknown. controlled_test : typing.Optional[bool] + The developer sets this to true when a controlled test produced the result. environment : typing.Optional[str] + The developer supplies the environment for this evaluation. At most 1024. evidence_reference : typing.Optional[str] + The developer links this evaluation to an evidence record. metrics : typing.Optional[typing.Dict[str, float]] + The developer supplies evaluation metrics. use_uuid : typing.Optional[str] + The developer can link this evaluation to a recorded Skill use. idempotency_key : typing.Optional[str] diff --git a/src/zep_cloud/agent/skill/evidence/client.py b/src/zep_cloud/agent/skill/evidence/client.py index deafbead..aa0a425e 100644 --- a/src/zep_cloud/agent/skill/evidence/client.py +++ b/src/zep_cloud/agent/skill/evidence/client.py @@ -35,6 +35,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillEvidence, Pagev4AgentSkillEvidence]: """ + List Agent Skill Evidence. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -104,6 +106,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillEvidence, Pagev4AgentSkillEvidence]: """ + List Agent Skill Evidence. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/skill/evidence/raw_client.py b/src/zep_cloud/agent/skill/evidence/raw_client.py index 29970ed9..6950ffc7 100644 --- a/src/zep_cloud/agent/skill/evidence/raw_client.py +++ b/src/zep_cloud/agent/skill/evidence/raw_client.py @@ -35,6 +35,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillEvidence, Pagev4AgentSkillEvidence]: """ + List Agent Skill Evidence. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -169,6 +171,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillEvidence, Pagev4AgentSkillEvidence]: """ + List Agent Skill Evidence. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/skill/export/client.py b/src/zep_cloud/agent/skill/export/client.py index 306d97cf..ebcd1c44 100644 --- a/src/zep_cloud/agent/skill/export/client.py +++ b/src/zep_cloud/agent/skill/export/client.py @@ -33,6 +33,8 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> Task: """ + Export an Agent Skill version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -82,6 +84,8 @@ def get( request_options: typing.Optional[RequestOptions] = None, ) -> typing.Iterator[bytes]: """ + Download an Agent Skill export. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -147,6 +151,8 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> Task: """ + Export an Agent Skill version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -204,6 +210,8 @@ async def get( request_options: typing.Optional[RequestOptions] = None, ) -> typing.AsyncIterator[bytes]: """ + Download an Agent Skill export. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/skill/export/raw_client.py b/src/zep_cloud/agent/skill/export/raw_client.py index cdac8d6c..3cac2b80 100644 --- a/src/zep_cloud/agent/skill/export/raw_client.py +++ b/src/zep_cloud/agent/skill/export/raw_client.py @@ -36,6 +36,8 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[Task]: """ + Export an Agent Skill version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -154,6 +156,8 @@ def get( request_options: typing.Optional[RequestOptions] = None, ) -> typing.Iterator[HttpResponse[typing.Iterator[bytes]]]: """ + Download an Agent Skill export. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -278,6 +282,8 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[Task]: """ + Export an Agent Skill version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -396,6 +402,8 @@ async def get( request_options: typing.Optional[RequestOptions] = None, ) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]: """ + Download an Agent Skill export. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/skill/publication/client.py b/src/zep_cloud/agent/skill/publication/client.py index 36349a60..00ca7b1c 100644 --- a/src/zep_cloud/agent/skill/publication/client.py +++ b/src/zep_cloud/agent/skill/publication/client.py @@ -33,7 +33,7 @@ def lookup( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillPublicationLineage: """ - Find a destination Skill by its source Agent, Skill, and version. The endpoint returns 404 until an automatic publication is ready or after it is invalidated. + Find a destination Skill by its source Agent, Skill, and version. The endpoint returns 404 until an automatic publication is ready or after it is invalidated. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -84,7 +84,7 @@ def get( self, agent_uuid: str, skill_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AgentSkillPublicationLineage: """ - Get the publication that created a destination Skill. Use its source version and policy identity to verify a copied Skill. The endpoint returns 404 for unpublished and invalidated Skills. + Get the publication that created a destination Skill. Use its source version and policy identity to verify a copied Skill. The endpoint returns 404 for unpublished and invalidated Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -143,7 +143,7 @@ async def lookup( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillPublicationLineage: """ - Find a destination Skill by its source Agent, Skill, and version. The endpoint returns 404 until an automatic publication is ready or after it is invalidated. + Find a destination Skill by its source Agent, Skill, and version. The endpoint returns 404 until an automatic publication is ready or after it is invalidated. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -202,7 +202,7 @@ async def get( self, agent_uuid: str, skill_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AgentSkillPublicationLineage: """ - Get the publication that created a destination Skill. Use its source version and policy identity to verify a copied Skill. The endpoint returns 404 for unpublished and invalidated Skills. + Get the publication that created a destination Skill. Use its source version and policy identity to verify a copied Skill. The endpoint returns 404 for unpublished and invalidated Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- diff --git a/src/zep_cloud/agent/skill/publication/raw_client.py b/src/zep_cloud/agent/skill/publication/raw_client.py index df8e1d54..fcb47810 100644 --- a/src/zep_cloud/agent/skill/publication/raw_client.py +++ b/src/zep_cloud/agent/skill/publication/raw_client.py @@ -34,7 +34,7 @@ def lookup( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkillPublicationLineage]: """ - Find a destination Skill by its source Agent, Skill, and version. The endpoint returns 404 until an automatic publication is ready or after it is invalidated. + Find a destination Skill by its source Agent, Skill, and version. The endpoint returns 404 until an automatic publication is ready or after it is invalidated. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -150,7 +150,7 @@ def get( self, agent_uuid: str, skill_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[AgentSkillPublicationLineage]: """ - Get the publication that created a destination Skill. Use its source version and policy identity to verify a copied Skill. The endpoint returns 404 for unpublished and invalidated Skills. + Get the publication that created a destination Skill. Use its source version and policy identity to verify a copied Skill. The endpoint returns 404 for unpublished and invalidated Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -266,7 +266,7 @@ async def lookup( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkillPublicationLineage]: """ - Find a destination Skill by its source Agent, Skill, and version. The endpoint returns 404 until an automatic publication is ready or after it is invalidated. + Find a destination Skill by its source Agent, Skill, and version. The endpoint returns 404 until an automatic publication is ready or after it is invalidated. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -382,7 +382,7 @@ async def get( self, agent_uuid: str, skill_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[AgentSkillPublicationLineage]: """ - Get the publication that created a destination Skill. Use its source version and policy identity to verify a copied Skill. The endpoint returns 404 for unpublished and invalidated Skills. + Get the publication that created a destination Skill. Use its source version and policy identity to verify a copied Skill. The endpoint returns 404 for unpublished and invalidated Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- diff --git a/src/zep_cloud/agent/skill/raw_client.py b/src/zep_cloud/agent/skill/raw_client.py index cb7cf7a5..24ff9364 100644 --- a/src/zep_cloud/agent/skill/raw_client.py +++ b/src/zep_cloud/agent/skill/raw_client.py @@ -50,14 +50,19 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkill]: """ + Create Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID definition : SkillDefinition + The developer supplies the structured content of the Skill. skill_id : typing.Optional[str] + The developer can set a stable ID for the Skill. If omitted, the service + assigns one. idempotency_key : typing.Optional[str] @@ -183,7 +188,7 @@ def import_package( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[Task]: """ - Submit a portable Skill archive. The completed Task returns `{"result":{"skill_uuid":""}}`. Approve that Skill before retrieval. + Submit a portable Skill archive. The completed Task returns `{"result":{"skill_uuid":""}}`. Approve that Skill before retrieval. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -315,6 +320,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillSearchHit, Pagev4AgentSkillSearchHit]: """ + List Agent Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -327,12 +334,16 @@ def list( Opaque page cursor environments : typing.Optional[typing.Sequence[str]] + The developer filters results by environment names. kind : typing.Optional[str] + The developer supplies a Skill kind. task_family : typing.Optional[str] + The developer supplies the task-family slug. tools : typing.Optional[typing.Sequence[str]] + The developer supplies tool names used by the Skill. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -469,12 +480,15 @@ def search( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillSearchHit, AgentSkillSearchResponse]: """ + Search Agent Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID query : str + The developer supplies a search query for Skills. page_size : typing.Optional[int] The maximum number of items in one page. The SDK method returns a pager. In Python, `.items` holds only the first page. In TypeScript, `.data` holds only the first page. To read every page, iterate the pager: use `for` or `list(...)` in Python, or `for await` in TypeScript. In Go, the method returns one page, and `Iterator()` reads all pages. @@ -483,10 +497,13 @@ def search( Opaque page cursor environments : typing.Optional[typing.Sequence[str]] + The developer supplies environment names used by the Skill. include_markdown : typing.Optional[bool] + The developer sets this to true to include the Skill instructions in Markdown. kind : typing.Optional[str] + The developer supplies a Skill kind. markdown_format : typing.Optional[AgentSkillSearchRequestMarkdownFormat] MarkdownFormat selects the form of inline `markdown`. `agent` (the @@ -495,8 +512,10 @@ def search( sections. `full` returns the stored SKILL.md with its evidence markers. task_family : typing.Optional[str] + The developer supplies the task-family slug. tools : typing.Optional[typing.Sequence[str]] + The developer supplies tool names used by the Skill. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -627,6 +646,8 @@ def get( self, agent_uuid: str, skill_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[AgentSkill]: """ + Get Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -736,6 +757,8 @@ def approve( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkillAdmissionDecision]: """ + Approve Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -745,6 +768,7 @@ def approve( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] @@ -857,6 +881,8 @@ def retire( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkill]: """ + Retire Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -866,6 +892,7 @@ def retire( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] @@ -990,6 +1017,8 @@ def create_version( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkillVersion]: """ + Create Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -999,8 +1028,10 @@ def create_version( Skill UUID definition : SkillDefinition + The developer supplies the structured content for the new Skill version. expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] @@ -1132,14 +1163,19 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkill]: """ + Create Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID definition : SkillDefinition + The developer supplies the structured content of the Skill. skill_id : typing.Optional[str] + The developer can set a stable ID for the Skill. If omitted, the service + assigns one. idempotency_key : typing.Optional[str] @@ -1265,7 +1301,7 @@ async def import_package( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[Task]: """ - Submit a portable Skill archive. The completed Task returns `{"result":{"skill_uuid":""}}`. Approve that Skill before retrieval. + Submit a portable Skill archive. The completed Task returns `{"result":{"skill_uuid":""}}`. Approve that Skill before retrieval. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -1397,6 +1433,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillSearchHit, Pagev4AgentSkillSearchHit]: """ + List Agent Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -1409,12 +1447,16 @@ async def list( Opaque page cursor environments : typing.Optional[typing.Sequence[str]] + The developer filters results by environment names. kind : typing.Optional[str] + The developer supplies a Skill kind. task_family : typing.Optional[str] + The developer supplies the task-family slug. tools : typing.Optional[typing.Sequence[str]] + The developer supplies tool names used by the Skill. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1554,12 +1596,15 @@ async def search( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillSearchHit, AgentSkillSearchResponse]: """ + Search Agent Skills. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Agent UUID query : str + The developer supplies a search query for Skills. page_size : typing.Optional[int] The maximum number of items in one page. The SDK method returns a pager. In Python, `.items` holds only the first page. In TypeScript, `.data` holds only the first page. To read every page, iterate the pager: use `for` or `list(...)` in Python, or `for await` in TypeScript. In Go, the method returns one page, and `Iterator()` reads all pages. @@ -1568,10 +1613,13 @@ async def search( Opaque page cursor environments : typing.Optional[typing.Sequence[str]] + The developer supplies environment names used by the Skill. include_markdown : typing.Optional[bool] + The developer sets this to true to include the Skill instructions in Markdown. kind : typing.Optional[str] + The developer supplies a Skill kind. markdown_format : typing.Optional[AgentSkillSearchRequestMarkdownFormat] MarkdownFormat selects the form of inline `markdown`. `agent` (the @@ -1580,8 +1628,10 @@ async def search( sections. `full` returns the stored SKILL.md with its evidence markers. task_family : typing.Optional[str] + The developer supplies the task-family slug. tools : typing.Optional[typing.Sequence[str]] + The developer supplies tool names used by the Skill. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1715,6 +1765,8 @@ async def get( self, agent_uuid: str, skill_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[AgentSkill]: """ + Get Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -1824,6 +1876,8 @@ async def approve( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkillAdmissionDecision]: """ + Approve Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -1833,6 +1887,7 @@ async def approve( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] @@ -1945,6 +2000,8 @@ async def retire( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkill]: """ + Retire Agent Skill. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -1954,6 +2011,7 @@ async def retire( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] @@ -2078,6 +2136,8 @@ async def create_version( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkillVersion]: """ + Create Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -2087,8 +2147,10 @@ async def create_version( Skill UUID definition : SkillDefinition + The developer supplies the structured content for the new Skill version. expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. idempotency_key : typing.Optional[str] diff --git a/src/zep_cloud/agent/skill/relation/client.py b/src/zep_cloud/agent/skill/relation/client.py index f127eb2b..97722944 100644 --- a/src/zep_cloud/agent/skill/relation/client.py +++ b/src/zep_cloud/agent/skill/relation/client.py @@ -39,6 +39,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillRelationship, Pagev4AgentSkillRelationship]: """ + List Agent Skill Relationships. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -114,6 +116,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillRelationship, Pagev4AgentSkillRelationship]: """ + List Agent Skill Relationships. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/skill/relation/raw_client.py b/src/zep_cloud/agent/skill/relation/raw_client.py index 50297a6a..8b9e661b 100644 --- a/src/zep_cloud/agent/skill/relation/raw_client.py +++ b/src/zep_cloud/agent/skill/relation/raw_client.py @@ -39,6 +39,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillRelationship, Pagev4AgentSkillRelationship]: """ + List Agent Skill Relationships. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -181,6 +183,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillRelationship, Pagev4AgentSkillRelationship]: """ + List Agent Skill Relationships. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/skill/use/client.py b/src/zep_cloud/agent/skill/use/client.py index 25ef43b2..6e7c8ff7 100644 --- a/src/zep_cloud/agent/skill/use/client.py +++ b/src/zep_cloud/agent/skill/use/client.py @@ -44,6 +44,8 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillUse: """ + Create Agent Skill Use. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -53,14 +55,21 @@ def create( Skill UUID search_id : str + The developer supplies the signed search token returned by Skill search. trace_uuid : str + The developer supplies the UUID of the source Trace. usage : CreateAgentSkillUseRequestUsage + The developer supplies how the Skill was used. Valid values are selected, used, + partially_used, ignored, inapplicable. outcome : typing.Optional[AddAgentSkillUseOutcomeRequest] + The developer records the outcome of the attempt. Valid values are + succeeded, failed, partial, abandoned, and unknown. reason_code : typing.Optional[str] + The developer supplies a reason code for this outcome. It can contain up to 255 characters. idempotency_key : typing.Optional[str] @@ -82,8 +91,8 @@ def create( client.agent.skill.use.create( agent_uuid="agent_uuid", skill_uuid="skill_uuid", - search_id="search_id", - trace_uuid="trace_uuid", + search_id="eyJ2IjoxLCJyZXF1ZXN0X2lkIjoiNmE5MDZlNzAtNTBjYS00ZTQzLWE4NzQtNWZjYWUwMmE3MWZhIn0.signature", + trace_uuid="6a906e70-50ca-4e43-a874-5fcae02a71fa", usage="selected", ) """ @@ -111,6 +120,8 @@ def add_outcome( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillUseOutcome: """ + Record Agent Skill Feedback. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -123,6 +134,8 @@ def add_outcome( Skill use UUID outcome : AddAgentSkillUseOutcomeRequestOutcome + The developer records the attempt outcome. Valid values are succeeded, + failed, partial, abandoned, and unknown. idempotency_key : typing.Optional[str] @@ -188,6 +201,8 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillUse: """ + Create Agent Skill Use. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -197,14 +212,21 @@ async def create( Skill UUID search_id : str + The developer supplies the signed search token returned by Skill search. trace_uuid : str + The developer supplies the UUID of the source Trace. usage : CreateAgentSkillUseRequestUsage + The developer supplies how the Skill was used. Valid values are selected, used, + partially_used, ignored, inapplicable. outcome : typing.Optional[AddAgentSkillUseOutcomeRequest] + The developer records the outcome of the attempt. Valid values are + succeeded, failed, partial, abandoned, and unknown. reason_code : typing.Optional[str] + The developer supplies a reason code for this outcome. It can contain up to 255 characters. idempotency_key : typing.Optional[str] @@ -231,8 +253,8 @@ async def main() -> None: await client.agent.skill.use.create( agent_uuid="agent_uuid", skill_uuid="skill_uuid", - search_id="search_id", - trace_uuid="trace_uuid", + search_id="eyJ2IjoxLCJyZXF1ZXN0X2lkIjoiNmE5MDZlNzAtNTBjYS00ZTQzLWE4NzQtNWZjYWUwMmE3MWZhIn0.signature", + trace_uuid="6a906e70-50ca-4e43-a874-5fcae02a71fa", usage="selected", ) @@ -263,6 +285,8 @@ async def add_outcome( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillUseOutcome: """ + Record Agent Skill Feedback. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -275,6 +299,8 @@ async def add_outcome( Skill use UUID outcome : AddAgentSkillUseOutcomeRequestOutcome + The developer records the attempt outcome. Valid values are succeeded, + failed, partial, abandoned, and unknown. idempotency_key : typing.Optional[str] diff --git a/src/zep_cloud/agent/skill/use/raw_client.py b/src/zep_cloud/agent/skill/use/raw_client.py index 183e1645..b8240eae 100644 --- a/src/zep_cloud/agent/skill/use/raw_client.py +++ b/src/zep_cloud/agent/skill/use/raw_client.py @@ -47,6 +47,8 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkillUse]: """ + Create Agent Skill Use. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -56,14 +58,21 @@ def create( Skill UUID search_id : str + The developer supplies the signed search token returned by Skill search. trace_uuid : str + The developer supplies the UUID of the source Trace. usage : CreateAgentSkillUseRequestUsage + The developer supplies how the Skill was used. Valid values are selected, used, + partially_used, ignored, inapplicable. outcome : typing.Optional[AddAgentSkillUseOutcomeRequest] + The developer records the outcome of the attempt. Valid values are + succeeded, failed, partial, abandoned, and unknown. reason_code : typing.Optional[str] + The developer supplies a reason code for this outcome. It can contain up to 255 characters. idempotency_key : typing.Optional[str] @@ -139,6 +148,8 @@ def add_outcome( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkillUseOutcome]: """ + Record Agent Skill Feedback. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -151,6 +162,8 @@ def add_outcome( Skill use UUID outcome : AddAgentSkillUseOutcomeRequestOutcome + The developer records the attempt outcome. Valid values are succeeded, + failed, partial, abandoned, and unknown. idempotency_key : typing.Optional[str] @@ -272,6 +285,8 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkillUse]: """ + Create Agent Skill Use. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -281,14 +296,21 @@ async def create( Skill UUID search_id : str + The developer supplies the signed search token returned by Skill search. trace_uuid : str + The developer supplies the UUID of the source Trace. usage : CreateAgentSkillUseRequestUsage + The developer supplies how the Skill was used. Valid values are selected, used, + partially_used, ignored, inapplicable. outcome : typing.Optional[AddAgentSkillUseOutcomeRequest] + The developer records the outcome of the attempt. Valid values are + succeeded, failed, partial, abandoned, and unknown. reason_code : typing.Optional[str] + The developer supplies a reason code for this outcome. It can contain up to 255 characters. idempotency_key : typing.Optional[str] @@ -364,6 +386,8 @@ async def add_outcome( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkillUseOutcome]: """ + Record Agent Skill Feedback. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -376,6 +400,8 @@ async def add_outcome( Skill use UUID outcome : AddAgentSkillUseOutcomeRequestOutcome + The developer records the attempt outcome. Valid values are succeeded, + failed, partial, abandoned, and unknown. idempotency_key : typing.Optional[str] diff --git a/src/zep_cloud/agent/skill/version/client.py b/src/zep_cloud/agent/skill/version/client.py index 0c2fdd5d..fbd59f27 100644 --- a/src/zep_cloud/agent/skill/version/client.py +++ b/src/zep_cloud/agent/skill/version/client.py @@ -42,6 +42,8 @@ def restore_version( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillVersion: """ + Restore Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -51,8 +53,10 @@ def restore_version( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. version : int + The developer supplies the Skill version to restore. idempotency_key : typing.Optional[str] @@ -99,6 +103,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillVersion, Pagev4AgentSkillVersion]: """ + List Agent Skill Versions. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -160,6 +166,8 @@ def compare( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillVersionComparison: """ + Compare Agent Skill Versions. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -169,8 +177,10 @@ def compare( Skill UUID from_version : int + The developer supplies the source version to compare. It must be at least 1. to_version : int + The developer supplies the destination version to compare. It must be at least 1. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -209,6 +219,8 @@ def get( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillVersion: """ + Get Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -276,6 +288,8 @@ async def restore_version( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillVersion: """ + Restore Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -285,8 +299,10 @@ async def restore_version( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. version : int + The developer supplies the Skill version to restore. idempotency_key : typing.Optional[str] @@ -341,6 +357,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillVersion, Pagev4AgentSkillVersion]: """ + List Agent Skill Versions. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -411,6 +429,8 @@ async def compare( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillVersionComparison: """ + Compare Agent Skill Versions. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -420,8 +440,10 @@ async def compare( Skill UUID from_version : int + The developer supplies the source version to compare. It must be at least 1. to_version : int + The developer supplies the destination version to compare. It must be at least 1. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -468,6 +490,8 @@ async def get( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSkillVersion: """ + Get Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/skill/version/raw_client.py b/src/zep_cloud/agent/skill/version/raw_client.py index 3aeecca3..fe0533b8 100644 --- a/src/zep_cloud/agent/skill/version/raw_client.py +++ b/src/zep_cloud/agent/skill/version/raw_client.py @@ -45,6 +45,8 @@ def restore_version( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkillVersion]: """ + Restore Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -54,8 +56,10 @@ def restore_version( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. version : int + The developer supplies the Skill version to restore. idempotency_key : typing.Optional[str] @@ -181,6 +185,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentSkillVersion, Pagev4AgentSkillVersion]: """ + List Agent Skill Versions. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -315,6 +321,8 @@ def compare( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkillVersionComparison]: """ + Compare Agent Skill Versions. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -324,8 +332,10 @@ def compare( Skill UUID from_version : int + The developer supplies the source version to compare. It must be at least 1. to_version : int + The developer supplies the destination version to compare. It must be at least 1. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -437,6 +447,8 @@ def get( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSkillVersion]: """ + Get Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -561,6 +573,8 @@ async def restore_version( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkillVersion]: """ + Restore Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -570,8 +584,10 @@ async def restore_version( Skill UUID expected_version : int + The developer supplies the current Skill version to protect against concurrent edits. version : int + The developer supplies the Skill version to restore. idempotency_key : typing.Optional[str] @@ -697,6 +713,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentSkillVersion, Pagev4AgentSkillVersion]: """ + List Agent Skill Versions. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -834,6 +852,8 @@ async def compare( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkillVersionComparison]: """ + Compare Agent Skill Versions. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -843,8 +863,10 @@ async def compare( Skill UUID from_version : int + The developer supplies the source version to compare. It must be at least 1. to_version : int + The developer supplies the destination version to compare. It must be at least 1. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -956,6 +978,8 @@ async def get( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSkillVersion]: """ + Get Agent Skill Version. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/split/client.py b/src/zep_cloud/agent/split/client.py index 62df3667..0b9abfe1 100644 --- a/src/zep_cloud/agent/split/client.py +++ b/src/zep_cloud/agent/split/client.py @@ -38,18 +38,25 @@ def plan( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSplitPlan: """ + Plan an Agent split. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Source Agent UUID destinations : typing.Sequence[AgentSplitPlanDestinationRequest] + The developer lists 1 to 100 destination Agents. expected_revision : int + The developer supplies the current revision used for optimistic concurrency. At least 1. rationale : str + The developer explains the requested change. The limit is 2,000 + characters. review_acknowledged : bool + The developer sets this to true to confirm that the review is complete. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -76,21 +83,21 @@ def plan( destinations=[ AgentSplitPlanDestinationRequest( agent=CreateAgentRequest( - agent_id="agent_id", - name="name", - security_domain="security_domain", + agent_id="payments-agent", + name="Refund a duplicate charge", + security_domain="customer:support", ), skills=[ AgentSplitPlanSkillSelectionRequest( - skill_uuid="skill_uuid", - skill_version_uuid="skill_version_uuid", + skill_uuid="6a906e70-50ca-4e43-a874-5fcae02a71fa", + skill_version_uuid="6a906e70-50ca-4e43-a874-5fcae02a71fa", version=1, ) ], ) ], expected_revision=1, - rationale="rationale", + rationale="Keep payment refunds separate from charge disputes.", review_acknowledged=True, ) """ @@ -131,18 +138,25 @@ async def plan( request_options: typing.Optional[RequestOptions] = None, ) -> AgentSplitPlan: """ + Plan an Agent split. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Source Agent UUID destinations : typing.Sequence[AgentSplitPlanDestinationRequest] + The developer lists 1 to 100 destination Agents. expected_revision : int + The developer supplies the current revision used for optimistic concurrency. At least 1. rationale : str + The developer explains the requested change. The limit is 2,000 + characters. review_acknowledged : bool + The developer sets this to true to confirm that the review is complete. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -174,21 +188,21 @@ async def main() -> None: destinations=[ AgentSplitPlanDestinationRequest( agent=CreateAgentRequest( - agent_id="agent_id", - name="name", - security_domain="security_domain", + agent_id="payments-agent", + name="Refund a duplicate charge", + security_domain="customer:support", ), skills=[ AgentSplitPlanSkillSelectionRequest( - skill_uuid="skill_uuid", - skill_version_uuid="skill_version_uuid", + skill_uuid="6a906e70-50ca-4e43-a874-5fcae02a71fa", + skill_version_uuid="6a906e70-50ca-4e43-a874-5fcae02a71fa", version=1, ) ], ) ], expected_revision=1, - rationale="rationale", + rationale="Keep payment refunds separate from charge disputes.", review_acknowledged=True, ) diff --git a/src/zep_cloud/agent/split/raw_client.py b/src/zep_cloud/agent/split/raw_client.py index d39d3f43..e2fce28d 100644 --- a/src/zep_cloud/agent/split/raw_client.py +++ b/src/zep_cloud/agent/split/raw_client.py @@ -41,18 +41,25 @@ def plan( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentSplitPlan]: """ + Plan an Agent split. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Source Agent UUID destinations : typing.Sequence[AgentSplitPlanDestinationRequest] + The developer lists 1 to 100 destination Agents. expected_revision : int + The developer supplies the current revision used for optimistic concurrency. At least 1. rationale : str + The developer explains the requested change. The limit is 2,000 + characters. review_acknowledged : bool + The developer sets this to true to confirm that the review is complete. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -176,18 +183,25 @@ async def plan( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentSplitPlan]: """ + Plan an Agent split. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str Source Agent UUID destinations : typing.Sequence[AgentSplitPlanDestinationRequest] + The developer lists 1 to 100 destination Agents. expected_revision : int + The developer supplies the current revision used for optimistic concurrency. At least 1. rationale : str + The developer explains the requested change. The limit is 2,000 + characters. review_acknowledged : bool + The developer sets this to true to confirm that the review is complete. request_options : typing.Optional[RequestOptions] Request-specific configuration. diff --git a/src/zep_cloud/agent/task_family/client.py b/src/zep_cloud/agent/task_family/client.py index 0b9ea48b..02ab359f 100644 --- a/src/zep_cloud/agent/task_family/client.py +++ b/src/zep_cloud/agent/task_family/client.py @@ -115,8 +115,8 @@ def rename( ) client.agent.task_family.rename( agent_uuid="agent_uuid", - from_slug="from_slug", - to_slug="to_slug", + from_slug="support/refund", + to_slug="support/refund", ) """ _response = self._raw_client.rename( @@ -246,8 +246,8 @@ async def rename( async def main() -> None: await client.agent.task_family.rename( agent_uuid="agent_uuid", - from_slug="from_slug", - to_slug="to_slug", + from_slug="support/refund", + to_slug="support/refund", ) diff --git a/src/zep_cloud/agent/trace/client.py b/src/zep_cloud/agent/trace/client.py index 9c8ed299..fbcc1c62 100644 --- a/src/zep_cloud/agent/trace/client.py +++ b/src/zep_cloud/agent/trace/client.py @@ -65,23 +65,32 @@ def create( Agent UUID objective : str - The task-instance objective captured for this attempt. + The developer describes the task instance. The create request requires a non-empty value but + does not check its size. An AppendAgentTraceEventRequest returns 400 if the Trace objective + exceeds 8 KiB (8,192 bytes). learn_from : typing.Optional[bool] - Whether eligible evidence may participate in learning. Defaults to true. + The developer supplies whether eligible evidence may participate in learning. Defaults to + true. metadata : typing.Optional[typing.Dict[str, typing.Any]] Developer metadata used to organize and filter Traces. parent_trace_uuid : typing.Optional[str] - The parent Trace UUID when this attempt retries an earlier attempt. + The developer supplies the parent Trace UUID when this attempt retries an earlier attempt. task_family : typing.Optional[str] - The task-family slug. Optional when inferred task families are enabled - for the account: the service assigns one after the Trace closes. + The developer may set a task-family slug. If the developer omits it, Agent Skills assigns the + Trace to a task family automatically. If Agent Skills cannot assign a task family, the + `task_family_inference` field of the Trace is `unassigned`. A BYOM configuration requires `task_family`. A + strict-residency deployment requires `task_family`. Without task_family in either case, the + API returns 400 `invalid_request` with the message `task_family is required`. The slug must + contain 1 to 128 lowercase letters, digits, `.`, `_`, `/`, or `-`. It must start with a + lowercase letter or digit. trace_id : typing.Optional[str] - The optional customer-assigned identifier, unique within the Agent. + The developer may set an identifier that is unique within the Agent. A retry with the same + create parameters returns 200 and the existing Trace. Different parameters return 409. idempotency_key : typing.Optional[str] @@ -102,7 +111,7 @@ def create( ) client.agent.trace.create( agent_uuid="agent_uuid", - objective="objective", + objective="Refund a duplicate charge.", ) """ _response = self._raw_client.create( @@ -164,7 +173,8 @@ def list( Filters to Traces whose metadata contains these key-value pairs. outcome : typing.Optional[AgentTraceOutcome] - Filters to one reported outcome. + The developer supplies filters to one reported outcome. Valid values are succeeded, failed, + partial, abandoned, unknown. parent_trace_uuid : typing.Optional[str] Filters to direct retries of this parent Trace. @@ -273,6 +283,7 @@ def delete( Trace UUID expected_revision : int + The developer supplies the current revision for optimistic concurrency. idempotency_key : typing.Optional[str] @@ -352,6 +363,7 @@ def update( agent_uuid="agent_uuid", trace_uuid="trace_uuid", expected_revision=1, + task_family="support/refund", ) """ _response = self._raw_client.update( @@ -565,7 +577,8 @@ def correct_task_family( agent_uuid="agent_uuid", trace_uuid="trace_uuid", expected_revision=1, - reason="reason", + reason="acknowledged_gap", + task_family="support/refund", ) """ _response = self._raw_client.correct_task_family( @@ -645,10 +658,13 @@ def append_event( occurred_at: typing.Optional[str] = OMIT, sequence: typing.Optional[int] = OMIT, sources: typing.Optional[typing.Sequence[AgentTraceEventSource]] = OMIT, + tool_call_id: typing.Optional[str] = OMIT, idempotency_key: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AgentTraceEvent: """ + A tool call and its result can share a tool_call_id. For example, append {"event_type":"tool_call","tool_call_id":"call_8f2b","content":"Search orders","context":{"tools":[{"name":"search_orders"}]}} and {"event_type":"tool_result","tool_call_id":"call_8f2b","content":"Order results","context":{"tools":[{"name":"search_orders"}]}}. + Parameters ---------- agent_uuid : str @@ -662,10 +678,13 @@ def append_event( content : typing.Optional[str] context : typing.Optional[AgentTraceEventContext] + Context gives the model, the tools, and the environments of the event. context.tools is the tool + that the event calls or returns, and Skills learning reads it. A tool event can omit the tool name. event_id : typing.Optional[str] metadata : typing.Optional[typing.Dict[str, typing.Any]] + Metadata is developer data. Skills learning does not read it. occurred_at : typing.Optional[str] @@ -673,6 +692,12 @@ def append_event( sources : typing.Optional[typing.Sequence[AgentTraceEventSource]] + tool_call_id : typing.Optional[str] + ToolCallID is the ID that the agent framework gives a tool call. Use the same ID on + the tool_call and tool_result events. It is valid only on these event types. A result + without a matching call is valid. OpenAI uses tool_calls[].id, Anthropic uses the + tool_use block id, and LangChain uses ToolMessage.tool_call_id. + idempotency_key : typing.Optional[str] request_options : typing.Optional[RequestOptions] @@ -707,6 +732,7 @@ def append_event( occurred_at=occurred_at, sequence=sequence, sources=sources, + tool_call_id=tool_call_id, idempotency_key=idempotency_key, request_options=request_options, ) @@ -735,6 +761,7 @@ def delete_event( Event UUID expected_revision : int + The developer supplies the current revision for optimistic concurrency. idempotency_key : typing.Optional[str] @@ -947,23 +974,32 @@ async def create( Agent UUID objective : str - The task-instance objective captured for this attempt. + The developer describes the task instance. The create request requires a non-empty value but + does not check its size. An AppendAgentTraceEventRequest returns 400 if the Trace objective + exceeds 8 KiB (8,192 bytes). learn_from : typing.Optional[bool] - Whether eligible evidence may participate in learning. Defaults to true. + The developer supplies whether eligible evidence may participate in learning. Defaults to + true. metadata : typing.Optional[typing.Dict[str, typing.Any]] Developer metadata used to organize and filter Traces. parent_trace_uuid : typing.Optional[str] - The parent Trace UUID when this attempt retries an earlier attempt. + The developer supplies the parent Trace UUID when this attempt retries an earlier attempt. task_family : typing.Optional[str] - The task-family slug. Optional when inferred task families are enabled - for the account: the service assigns one after the Trace closes. + The developer may set a task-family slug. If the developer omits it, Agent Skills assigns the + Trace to a task family automatically. If Agent Skills cannot assign a task family, the + `task_family_inference` field of the Trace is `unassigned`. A BYOM configuration requires `task_family`. A + strict-residency deployment requires `task_family`. Without task_family in either case, the + API returns 400 `invalid_request` with the message `task_family is required`. The slug must + contain 1 to 128 lowercase letters, digits, `.`, `_`, `/`, or `-`. It must start with a + lowercase letter or digit. trace_id : typing.Optional[str] - The optional customer-assigned identifier, unique within the Agent. + The developer may set an identifier that is unique within the Agent. A retry with the same + create parameters returns 200 and the existing Trace. Different parameters return 409. idempotency_key : typing.Optional[str] @@ -989,7 +1025,7 @@ async def create( async def main() -> None: await client.agent.trace.create( agent_uuid="agent_uuid", - objective="objective", + objective="Refund a duplicate charge.", ) @@ -1054,7 +1090,8 @@ async def list( Filters to Traces whose metadata contains these key-value pairs. outcome : typing.Optional[AgentTraceOutcome] - Filters to one reported outcome. + The developer supplies filters to one reported outcome. Valid values are succeeded, failed, + partial, abandoned, unknown. parent_trace_uuid : typing.Optional[str] Filters to direct retries of this parent Trace. @@ -1180,6 +1217,7 @@ async def delete( Trace UUID expected_revision : int + The developer supplies the current revision for optimistic concurrency. idempotency_key : typing.Optional[str] @@ -1272,6 +1310,7 @@ async def main() -> None: agent_uuid="agent_uuid", trace_uuid="trace_uuid", expected_revision=1, + task_family="support/refund", ) @@ -1509,7 +1548,8 @@ async def main() -> None: agent_uuid="agent_uuid", trace_uuid="trace_uuid", expected_revision=1, - reason="reason", + reason="acknowledged_gap", + task_family="support/refund", ) @@ -1601,10 +1641,13 @@ async def append_event( occurred_at: typing.Optional[str] = OMIT, sequence: typing.Optional[int] = OMIT, sources: typing.Optional[typing.Sequence[AgentTraceEventSource]] = OMIT, + tool_call_id: typing.Optional[str] = OMIT, idempotency_key: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AgentTraceEvent: """ + A tool call and its result can share a tool_call_id. For example, append {"event_type":"tool_call","tool_call_id":"call_8f2b","content":"Search orders","context":{"tools":[{"name":"search_orders"}]}} and {"event_type":"tool_result","tool_call_id":"call_8f2b","content":"Order results","context":{"tools":[{"name":"search_orders"}]}}. + Parameters ---------- agent_uuid : str @@ -1618,10 +1661,13 @@ async def append_event( content : typing.Optional[str] context : typing.Optional[AgentTraceEventContext] + Context gives the model, the tools, and the environments of the event. context.tools is the tool + that the event calls or returns, and Skills learning reads it. A tool event can omit the tool name. event_id : typing.Optional[str] metadata : typing.Optional[typing.Dict[str, typing.Any]] + Metadata is developer data. Skills learning does not read it. occurred_at : typing.Optional[str] @@ -1629,6 +1675,12 @@ async def append_event( sources : typing.Optional[typing.Sequence[AgentTraceEventSource]] + tool_call_id : typing.Optional[str] + ToolCallID is the ID that the agent framework gives a tool call. Use the same ID on + the tool_call and tool_result events. It is valid only on these event types. A result + without a matching call is valid. OpenAI uses tool_calls[].id, Anthropic uses the + tool_use block id, and LangChain uses ToolMessage.tool_call_id. + idempotency_key : typing.Optional[str] request_options : typing.Optional[RequestOptions] @@ -1671,6 +1723,7 @@ async def main() -> None: occurred_at=occurred_at, sequence=sequence, sources=sources, + tool_call_id=tool_call_id, idempotency_key=idempotency_key, request_options=request_options, ) @@ -1699,6 +1752,7 @@ async def delete_event( Event UUID expected_revision : int + The developer supplies the current revision for optimistic concurrency. idempotency_key : typing.Optional[str] diff --git a/src/zep_cloud/agent/trace/raw_client.py b/src/zep_cloud/agent/trace/raw_client.py index 6db7a135..4e93d80b 100644 --- a/src/zep_cloud/agent/trace/raw_client.py +++ b/src/zep_cloud/agent/trace/raw_client.py @@ -69,23 +69,32 @@ def create( Agent UUID objective : str - The task-instance objective captured for this attempt. + The developer describes the task instance. The create request requires a non-empty value but + does not check its size. An AppendAgentTraceEventRequest returns 400 if the Trace objective + exceeds 8 KiB (8,192 bytes). learn_from : typing.Optional[bool] - Whether eligible evidence may participate in learning. Defaults to true. + The developer supplies whether eligible evidence may participate in learning. Defaults to + true. metadata : typing.Optional[typing.Dict[str, typing.Any]] Developer metadata used to organize and filter Traces. parent_trace_uuid : typing.Optional[str] - The parent Trace UUID when this attempt retries an earlier attempt. + The developer supplies the parent Trace UUID when this attempt retries an earlier attempt. task_family : typing.Optional[str] - The task-family slug. Optional when inferred task families are enabled - for the account: the service assigns one after the Trace closes. + The developer may set a task-family slug. If the developer omits it, Agent Skills assigns the + Trace to a task family automatically. If Agent Skills cannot assign a task family, the + `task_family_inference` field of the Trace is `unassigned`. A BYOM configuration requires `task_family`. A + strict-residency deployment requires `task_family`. Without task_family in either case, the + API returns 400 `invalid_request` with the message `task_family is required`. The slug must + contain 1 to 128 lowercase letters, digits, `.`, `_`, `/`, or `-`. It must start with a + lowercase letter or digit. trace_id : typing.Optional[str] - The optional customer-assigned identifier, unique within the Agent. + The developer may set an identifier that is unique within the Agent. A retry with the same + create parameters returns 200 and the existing Trace. Different parameters return 409. idempotency_key : typing.Optional[str] @@ -239,7 +248,8 @@ def list( Filters to Traces whose metadata contains these key-value pairs. outcome : typing.Optional[AgentTraceOutcome] - Filters to one reported outcome. + The developer supplies filters to one reported outcome. Valid values are succeeded, failed, + partial, abandoned, unknown. parent_trace_uuid : typing.Optional[str] Filters to direct retries of this parent Trace. @@ -484,6 +494,7 @@ def delete( Trace UUID expected_revision : int + The developer supplies the current revision for optimistic concurrency. idempotency_key : typing.Optional[str] @@ -746,6 +757,39 @@ def abandon( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), @@ -868,6 +912,39 @@ def close( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), @@ -967,6 +1044,39 @@ def correct_task_family( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), @@ -1063,6 +1173,39 @@ def list_events( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 503: raise ServiceUnavailableError( headers=dict(_response.headers), @@ -1100,10 +1243,13 @@ def append_event( occurred_at: typing.Optional[str] = OMIT, sequence: typing.Optional[int] = OMIT, sources: typing.Optional[typing.Sequence[AgentTraceEventSource]] = OMIT, + tool_call_id: typing.Optional[str] = OMIT, idempotency_key: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentTraceEvent]: """ + A tool call and its result can share a tool_call_id. For example, append {"event_type":"tool_call","tool_call_id":"call_8f2b","content":"Search orders","context":{"tools":[{"name":"search_orders"}]}} and {"event_type":"tool_result","tool_call_id":"call_8f2b","content":"Order results","context":{"tools":[{"name":"search_orders"}]}}. + Parameters ---------- agent_uuid : str @@ -1117,10 +1263,13 @@ def append_event( content : typing.Optional[str] context : typing.Optional[AgentTraceEventContext] + Context gives the model, the tools, and the environments of the event. context.tools is the tool + that the event calls or returns, and Skills learning reads it. A tool event can omit the tool name. event_id : typing.Optional[str] metadata : typing.Optional[typing.Dict[str, typing.Any]] + Metadata is developer data. Skills learning does not read it. occurred_at : typing.Optional[str] @@ -1128,6 +1277,12 @@ def append_event( sources : typing.Optional[typing.Sequence[AgentTraceEventSource]] + tool_call_id : typing.Optional[str] + ToolCallID is the ID that the agent framework gives a tool call. Use the same ID on + the tool_call and tool_result events. It is valid only on these event types. A result + without a matching call is valid. OpenAI uses tool_calls[].id, Anthropic uses the + tool_use block id, and LangChain uses ToolMessage.tool_call_id. + idempotency_key : typing.Optional[str] request_options : typing.Optional[RequestOptions] @@ -1154,6 +1309,7 @@ def append_event( "sources": convert_and_respect_annotation_metadata( object_=sources, annotation=typing.Sequence[AgentTraceEventSource], direction="write" ), + "tool_call_id": tool_call_id, }, headers={ "content-type": "application/json", @@ -1183,6 +1339,17 @@ def append_event( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 403: raise ForbiddenError( headers=dict(_response.headers), @@ -1194,6 +1361,17 @@ def append_event( ), ), ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), @@ -1252,6 +1430,7 @@ def delete_event( Event UUID expected_revision : int + The developer supplies the current revision for optimistic concurrency. idempotency_key : typing.Optional[str] @@ -1364,6 +1543,39 @@ def reopen( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), @@ -1557,23 +1769,32 @@ async def create( Agent UUID objective : str - The task-instance objective captured for this attempt. + The developer describes the task instance. The create request requires a non-empty value but + does not check its size. An AppendAgentTraceEventRequest returns 400 if the Trace objective + exceeds 8 KiB (8,192 bytes). learn_from : typing.Optional[bool] - Whether eligible evidence may participate in learning. Defaults to true. + The developer supplies whether eligible evidence may participate in learning. Defaults to + true. metadata : typing.Optional[typing.Dict[str, typing.Any]] Developer metadata used to organize and filter Traces. parent_trace_uuid : typing.Optional[str] - The parent Trace UUID when this attempt retries an earlier attempt. + The developer supplies the parent Trace UUID when this attempt retries an earlier attempt. task_family : typing.Optional[str] - The task-family slug. Optional when inferred task families are enabled - for the account: the service assigns one after the Trace closes. + The developer may set a task-family slug. If the developer omits it, Agent Skills assigns the + Trace to a task family automatically. If Agent Skills cannot assign a task family, the + `task_family_inference` field of the Trace is `unassigned`. A BYOM configuration requires `task_family`. A + strict-residency deployment requires `task_family`. Without task_family in either case, the + API returns 400 `invalid_request` with the message `task_family is required`. The slug must + contain 1 to 128 lowercase letters, digits, `.`, `_`, `/`, or `-`. It must start with a + lowercase letter or digit. trace_id : typing.Optional[str] - The optional customer-assigned identifier, unique within the Agent. + The developer may set an identifier that is unique within the Agent. A retry with the same + create parameters returns 200 and the existing Trace. Different parameters return 409. idempotency_key : typing.Optional[str] @@ -1727,7 +1948,8 @@ async def list( Filters to Traces whose metadata contains these key-value pairs. outcome : typing.Optional[AgentTraceOutcome] - Filters to one reported outcome. + The developer supplies filters to one reported outcome. Valid values are succeeded, failed, + partial, abandoned, unknown. parent_trace_uuid : typing.Optional[str] Filters to direct retries of this parent Trace. @@ -1975,6 +2197,7 @@ async def delete( Trace UUID expected_revision : int + The developer supplies the current revision for optimistic concurrency. idempotency_key : typing.Optional[str] @@ -2237,6 +2460,39 @@ async def abandon( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), @@ -2359,6 +2615,39 @@ async def close( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), @@ -2458,6 +2747,39 @@ async def correct_task_family( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), @@ -2557,6 +2879,39 @@ async def _get_next(): ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 503: raise ServiceUnavailableError( headers=dict(_response.headers), @@ -2594,10 +2949,13 @@ async def append_event( occurred_at: typing.Optional[str] = OMIT, sequence: typing.Optional[int] = OMIT, sources: typing.Optional[typing.Sequence[AgentTraceEventSource]] = OMIT, + tool_call_id: typing.Optional[str] = OMIT, idempotency_key: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentTraceEvent]: """ + A tool call and its result can share a tool_call_id. For example, append {"event_type":"tool_call","tool_call_id":"call_8f2b","content":"Search orders","context":{"tools":[{"name":"search_orders"}]}} and {"event_type":"tool_result","tool_call_id":"call_8f2b","content":"Order results","context":{"tools":[{"name":"search_orders"}]}}. + Parameters ---------- agent_uuid : str @@ -2611,10 +2969,13 @@ async def append_event( content : typing.Optional[str] context : typing.Optional[AgentTraceEventContext] + Context gives the model, the tools, and the environments of the event. context.tools is the tool + that the event calls or returns, and Skills learning reads it. A tool event can omit the tool name. event_id : typing.Optional[str] metadata : typing.Optional[typing.Dict[str, typing.Any]] + Metadata is developer data. Skills learning does not read it. occurred_at : typing.Optional[str] @@ -2622,6 +2983,12 @@ async def append_event( sources : typing.Optional[typing.Sequence[AgentTraceEventSource]] + tool_call_id : typing.Optional[str] + ToolCallID is the ID that the agent framework gives a tool call. Use the same ID on + the tool_call and tool_result events. It is valid only on these event types. A result + without a matching call is valid. OpenAI uses tool_calls[].id, Anthropic uses the + tool_use block id, and LangChain uses ToolMessage.tool_call_id. + idempotency_key : typing.Optional[str] request_options : typing.Optional[RequestOptions] @@ -2648,6 +3015,7 @@ async def append_event( "sources": convert_and_respect_annotation_metadata( object_=sources, annotation=typing.Sequence[AgentTraceEventSource], direction="write" ), + "tool_call_id": tool_call_id, }, headers={ "content-type": "application/json", @@ -2677,6 +3045,17 @@ async def append_event( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 403: raise ForbiddenError( headers=dict(_response.headers), @@ -2688,6 +3067,17 @@ async def append_event( ), ), ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), @@ -2746,6 +3136,7 @@ async def delete_event( Event UUID expected_revision : int + The developer supplies the current revision for optimistic concurrency. idempotency_key : typing.Optional[str] @@ -2858,6 +3249,39 @@ async def reopen( ), ), ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), diff --git a/src/zep_cloud/agent/trace_import/client.py b/src/zep_cloud/agent/trace_import/client.py index d7cb3dd5..ecd08a15 100644 --- a/src/zep_cloud/agent/trace_import/client.py +++ b/src/zep_cloud/agent/trace_import/client.py @@ -51,7 +51,7 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[TraceImport, TraceImportPage]: """ - List trace imports that belong to this Agent. + List trace imports that belong to this Agent. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -107,7 +107,7 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> TraceImportCreateResult: """ - Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with `import`. A one-time import returns HTTP 202 with `import`, `run`, and `task`. Example request: `{"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}`. + Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with `import`. A one-time import returns HTTP 202 with `import`, `run`, and `task`. Example request: `{"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -115,7 +115,7 @@ def create( Agent UUID connection_uuid : typing.Optional[str] - ConnectionUUID identifies the project trace connection. + The developer selects the configured provider connection. learn_from : typing.Optional[bool] LearnFrom controls whether imported evidence can support Skills. @@ -130,7 +130,7 @@ def create( OnSourceChange defines how changed source traces are handled. provider_project_id : typing.Optional[str] - ProviderProjectID is the source provider project identifier. + The developer selects the project to import from the provider. require_review : typing.Optional[bool] RequireReview requires review for candidates backed by this import. @@ -182,7 +182,7 @@ def get( self, agent_uuid: str, import_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> TraceImport: """ - Read one trace import. The response does not include its source cursor. + Read one trace import. The response does not include its source cursor. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -225,7 +225,7 @@ def delete( request_options: typing.Optional[RequestOptions] = None, ) -> typing.Optional[Task]: """ - Set `traces=delete` to queue asynchronous Trace deletion. The default keeps Traces. Example query: `?traces=delete`. + Set `traces=delete` to queue asynchronous Trace deletion. The default keeps Traces. Example query: `?traces=delete`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -282,7 +282,7 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> TraceImport: """ - Use `expected_revision` to reject a stale update. Example request: `{"expected_revision":1,"name":"Updated support traces"}`. + Use `expected_revision` to reject a stale update. Example request: `{"expected_revision":1,"name":"Updated support traces"}`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -363,7 +363,7 @@ def pause( request_options: typing.Optional[RequestOptions] = None, ) -> TraceImport: """ - Pause a scheduled trace import. One-time imports cannot be paused. + Pause a scheduled trace import. One-time imports cannot be paused. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -409,7 +409,7 @@ def resume( request_options: typing.Optional[RequestOptions] = None, ) -> TraceImport: """ - Resume a scheduled trace import. Zep verifies credentials first when they caused the pause. + Resume a scheduled trace import. Zep verifies credentials first when they caused the pause. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -481,7 +481,7 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[TraceImport, TraceImportPage]: """ - List trace imports that belong to this Agent. + List trace imports that belong to this Agent. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -548,7 +548,7 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> TraceImportCreateResult: """ - Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with `import`. A one-time import returns HTTP 202 with `import`, `run`, and `task`. Example request: `{"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}`. + Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with `import`. A one-time import returns HTTP 202 with `import`, `run`, and `task`. Example request: `{"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -556,7 +556,7 @@ async def create( Agent UUID connection_uuid : typing.Optional[str] - ConnectionUUID identifies the project trace connection. + The developer selects the configured provider connection. learn_from : typing.Optional[bool] LearnFrom controls whether imported evidence can support Skills. @@ -571,7 +571,7 @@ async def create( OnSourceChange defines how changed source traces are handled. provider_project_id : typing.Optional[str] - ProviderProjectID is the source provider project identifier. + The developer selects the project to import from the provider. require_review : typing.Optional[bool] RequireReview requires review for candidates backed by this import. @@ -631,7 +631,7 @@ async def get( self, agent_uuid: str, import_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> TraceImport: """ - Read one trace import. The response does not include its source cursor. + Read one trace import. The response does not include its source cursor. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -682,7 +682,7 @@ async def delete( request_options: typing.Optional[RequestOptions] = None, ) -> typing.Optional[Task]: """ - Set `traces=delete` to queue asynchronous Trace deletion. The default keeps Traces. Example query: `?traces=delete`. + Set `traces=delete` to queue asynchronous Trace deletion. The default keeps Traces. Example query: `?traces=delete`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -747,7 +747,7 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> TraceImport: """ - Use `expected_revision` to reject a stale update. Example request: `{"expected_revision":1,"name":"Updated support traces"}`. + Use `expected_revision` to reject a stale update. Example request: `{"expected_revision":1,"name":"Updated support traces"}`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -836,7 +836,7 @@ async def pause( request_options: typing.Optional[RequestOptions] = None, ) -> TraceImport: """ - Pause a scheduled trace import. One-time imports cannot be paused. + Pause a scheduled trace import. One-time imports cannot be paused. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -890,7 +890,7 @@ async def resume( request_options: typing.Optional[RequestOptions] = None, ) -> TraceImport: """ - Resume a scheduled trace import. Zep verifies credentials first when they caused the pause. + Resume a scheduled trace import. Zep verifies credentials first when they caused the pause. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- diff --git a/src/zep_cloud/agent/trace_import/raw_client.py b/src/zep_cloud/agent/trace_import/raw_client.py index 49e2c9f3..e579c08d 100644 --- a/src/zep_cloud/agent/trace_import/raw_client.py +++ b/src/zep_cloud/agent/trace_import/raw_client.py @@ -49,7 +49,7 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[TraceImport, TraceImportPage]: """ - List trace imports that belong to this Agent. + List trace imports that belong to this Agent. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -161,7 +161,7 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[TraceImportCreateResult]: """ - Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with `import`. A one-time import returns HTTP 202 with `import`, `run`, and `task`. Example request: `{"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}`. + Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with `import`. A one-time import returns HTTP 202 with `import`, `run`, and `task`. Example request: `{"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -169,7 +169,7 @@ def create( Agent UUID connection_uuid : typing.Optional[str] - ConnectionUUID identifies the project trace connection. + The developer selects the configured provider connection. learn_from : typing.Optional[bool] LearnFrom controls whether imported evidence can support Skills. @@ -184,7 +184,7 @@ def create( OnSourceChange defines how changed source traces are handled. provider_project_id : typing.Optional[str] - ProviderProjectID is the source provider project identifier. + The developer selects the project to import from the provider. require_review : typing.Optional[bool] RequireReview requires review for candidates backed by this import. @@ -325,7 +325,7 @@ def get( self, agent_uuid: str, import_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[TraceImport]: """ - Read one trace import. The response does not include its source cursor. + Read one trace import. The response does not include its source cursor. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -414,7 +414,7 @@ def delete( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[typing.Optional[Task]]: """ - Set `traces=delete` to queue asynchronous Trace deletion. The default keeps Traces. Example query: `?traces=delete`. + Set `traces=delete` to queue asynchronous Trace deletion. The default keeps Traces. Example query: `?traces=delete`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -523,7 +523,7 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[TraceImport]: """ - Use `expected_revision` to reject a stale update. Example request: `{"expected_revision":1,"name":"Updated support traces"}`. + Use `expected_revision` to reject a stale update. Example request: `{"expected_revision":1,"name":"Updated support traces"}`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -680,7 +680,7 @@ def pause( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[TraceImport]: """ - Pause a scheduled trace import. One-time imports cannot be paused. + Pause a scheduled trace import. One-time imports cannot be paused. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -784,7 +784,7 @@ def resume( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[TraceImport]: """ - Resume a scheduled trace import. Zep verifies credentials first when they caused the pause. + Resume a scheduled trace import. Zep verifies credentials first when they caused the pause. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -893,7 +893,7 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[TraceImport, TraceImportPage]: """ - List trace imports that belong to this Agent. + List trace imports that belong to this Agent. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -1008,7 +1008,7 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[TraceImportCreateResult]: """ - Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with `import`. A one-time import returns HTTP 202 with `import`, `run`, and `task`. Example request: `{"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}`. + Create a scheduled import or queue a one-time import. A scheduled import returns HTTP 201 with `import`. A one-time import returns HTTP 202 with `import`, `run`, and `task`. Example request: `{"connection_uuid":"8c78a85e-eac2-4f57-b5f5-59a68a1e77a1","provider_project_id":"project-123","name":"Support traces","selection":{"trace_ids":["trace-123"]},"mapping":{"task_family":{"source":"fixed","value":"support"}}}`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -1016,7 +1016,7 @@ async def create( Agent UUID connection_uuid : typing.Optional[str] - ConnectionUUID identifies the project trace connection. + The developer selects the configured provider connection. learn_from : typing.Optional[bool] LearnFrom controls whether imported evidence can support Skills. @@ -1031,7 +1031,7 @@ async def create( OnSourceChange defines how changed source traces are handled. provider_project_id : typing.Optional[str] - ProviderProjectID is the source provider project identifier. + The developer selects the project to import from the provider. require_review : typing.Optional[bool] RequireReview requires review for candidates backed by this import. @@ -1172,7 +1172,7 @@ async def get( self, agent_uuid: str, import_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[TraceImport]: """ - Read one trace import. The response does not include its source cursor. + Read one trace import. The response does not include its source cursor. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -1261,7 +1261,7 @@ async def delete( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[typing.Optional[Task]]: """ - Set `traces=delete` to queue asynchronous Trace deletion. The default keeps Traces. Example query: `?traces=delete`. + Set `traces=delete` to queue asynchronous Trace deletion. The default keeps Traces. Example query: `?traces=delete`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -1370,7 +1370,7 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[TraceImport]: """ - Use `expected_revision` to reject a stale update. Example request: `{"expected_revision":1,"name":"Updated support traces"}`. + Use `expected_revision` to reject a stale update. Example request: `{"expected_revision":1,"name":"Updated support traces"}`. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -1527,7 +1527,7 @@ async def pause( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[TraceImport]: """ - Pause a scheduled trace import. One-time imports cannot be paused. + Pause a scheduled trace import. One-time imports cannot be paused. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -1631,7 +1631,7 @@ async def resume( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[TraceImport]: """ - Resume a scheduled trace import. Zep verifies credentials first when they caused the pause. + Resume a scheduled trace import. Zep verifies credentials first when they caused the pause. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- diff --git a/src/zep_cloud/agent/trace_import/run/client.py b/src/zep_cloud/agent/trace_import/run/client.py index 878a2a0f..fe6cc7ef 100644 --- a/src/zep_cloud/agent/trace_import/run/client.py +++ b/src/zep_cloud/agent/trace_import/run/client.py @@ -43,7 +43,7 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[TraceImportRun, TraceImportRunPage]: """ - List runs that belong to this trace import. + List runs that belong to this trace import. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -97,7 +97,7 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> Task: """ - Create a pending run and its Task. This operation does not start the run. + Create a pending run and its Task. This operation does not start the run. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -143,7 +143,7 @@ def get( request_options: typing.Optional[RequestOptions] = None, ) -> TraceImportRun: """ - Read one run that belongs to this trace import. + Read one run that belongs to this trace import. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -216,7 +216,7 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[TraceImportRun, TraceImportRunPage]: """ - List runs that belong to this trace import. + List runs that belong to this trace import. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -279,7 +279,7 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> Task: """ - Create a pending run and its Task. This operation does not start the run. + Create a pending run and its Task. This operation does not start the run. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -333,7 +333,7 @@ async def get( request_options: typing.Optional[RequestOptions] = None, ) -> TraceImportRun: """ - Read one run that belongs to this trace import. + Read one run that belongs to this trace import. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- diff --git a/src/zep_cloud/agent/trace_import/run/item/client.py b/src/zep_cloud/agent/trace_import/run/item/client.py index 614961d7..2f0a361a 100644 --- a/src/zep_cloud/agent/trace_import/run/item/client.py +++ b/src/zep_cloud/agent/trace_import/run/item/client.py @@ -36,7 +36,7 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[TraceImportRunItem, TraceImportRunItemPage]: """ - List trace results for this run. Run items do not include source payload. + List trace results for this run. Run items do not include source payload. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -112,7 +112,7 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[TraceImportRunItem, TraceImportRunItemPage]: """ - List trace results for this run. Run items do not include source payload. + List trace results for this run. Run items do not include source payload. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- diff --git a/src/zep_cloud/agent/trace_import/run/item/raw_client.py b/src/zep_cloud/agent/trace_import/run/item/raw_client.py index 82865640..c8cb2fcc 100644 --- a/src/zep_cloud/agent/trace_import/run/item/raw_client.py +++ b/src/zep_cloud/agent/trace_import/run/item/raw_client.py @@ -34,7 +34,7 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[TraceImportRunItem, TraceImportRunItemPage]: """ - List trace results for this run. Run items do not include source payload. + List trace results for this run. Run items do not include source payload. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -153,7 +153,7 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[TraceImportRunItem, TraceImportRunItemPage]: """ - List trace results for this run. Run items do not include source payload. + List trace results for this run. Run items do not include source payload. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- diff --git a/src/zep_cloud/agent/trace_import/run/raw_client.py b/src/zep_cloud/agent/trace_import/run/raw_client.py index 34494c84..046994fd 100644 --- a/src/zep_cloud/agent/trace_import/run/raw_client.py +++ b/src/zep_cloud/agent/trace_import/run/raw_client.py @@ -37,7 +37,7 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[TraceImportRun, TraceImportRunPage]: """ - List runs that belong to this trace import. + List runs that belong to this trace import. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -145,7 +145,7 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[Task]: """ - Create a pending run and its Task. This operation does not start the run. + Create a pending run and its Task. This operation does not start the run. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -249,7 +249,7 @@ def get( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[TraceImportRun]: """ - Read one run that belongs to this trace import. + Read one run that belongs to this trace import. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -346,7 +346,7 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[TraceImportRun, TraceImportRunPage]: """ - List runs that belong to this trace import. + List runs that belong to this trace import. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -457,7 +457,7 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[Task]: """ - Create a pending run and its Task. This operation does not start the run. + Create a pending run and its Task. This operation does not start the run. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- @@ -561,7 +561,7 @@ async def get( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[TraceImportRun]: """ - Read one run that belongs to this trace import. + Read one run that belongs to this trace import. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. Parameters ---------- diff --git a/src/zep_cloud/agent/verifier/client.py b/src/zep_cloud/agent/verifier/client.py index 54534aa2..2a6b45a3 100644 --- a/src/zep_cloud/agent/verifier/client.py +++ b/src/zep_cloud/agent/verifier/client.py @@ -46,6 +46,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentVerifier, Pagev4AgentVerifier]: """ + List Agent Verifiers. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -112,6 +114,8 @@ def get( self, agent_uuid: str, verifier_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AgentVerifier: """ + Get Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -157,6 +161,8 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> AgentVerifier: """ + Update Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -227,6 +233,8 @@ def invalidate_evidence( request_options: typing.Optional[RequestOptions] = None, ) -> AgentVerifierEvidenceInvalidationResult: """ + Invalidate Agent Verifier Evidence. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -236,7 +244,7 @@ def invalidate_evidence( Verifier UUID reason : str - Why evidence from these verifier revisions is invalid. + The developer supplies why evidence from these verifier revisions is invalid. verifier_revisions : typing.Sequence[int] Verifier revisions whose accepted evidence is no longer valid. @@ -261,7 +269,7 @@ def invalidate_evidence( client.agent.verifier.invalidate_evidence( agent_uuid="agent_uuid", verifier_uuid="verifier_uuid", - reason="reason", + reason="acknowledged_gap", verifier_revisions=[1], ) """ @@ -285,6 +293,8 @@ def revoke( request_options: typing.Optional[RequestOptions] = None, ) -> AgentVerifier: """ + Revoke Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -358,6 +368,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentVerifier, Pagev4AgentVerifier]: """ + List Agent Verifiers. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -433,6 +445,8 @@ async def get( self, agent_uuid: str, verifier_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AgentVerifier: """ + Get Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -486,6 +500,8 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> AgentVerifier: """ + Update Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -564,6 +580,8 @@ async def invalidate_evidence( request_options: typing.Optional[RequestOptions] = None, ) -> AgentVerifierEvidenceInvalidationResult: """ + Invalidate Agent Verifier Evidence. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -573,7 +591,7 @@ async def invalidate_evidence( Verifier UUID reason : str - Why evidence from these verifier revisions is invalid. + The developer supplies why evidence from these verifier revisions is invalid. verifier_revisions : typing.Sequence[int] Verifier revisions whose accepted evidence is no longer valid. @@ -603,7 +621,7 @@ async def main() -> None: await client.agent.verifier.invalidate_evidence( agent_uuid="agent_uuid", verifier_uuid="verifier_uuid", - reason="reason", + reason="acknowledged_gap", verifier_revisions=[1], ) @@ -630,6 +648,8 @@ async def revoke( request_options: typing.Optional[RequestOptions] = None, ) -> AgentVerifier: """ + Revoke Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/agent/verifier/raw_client.py b/src/zep_cloud/agent/verifier/raw_client.py index b5971db4..152de045 100644 --- a/src/zep_cloud/agent/verifier/raw_client.py +++ b/src/zep_cloud/agent/verifier/raw_client.py @@ -47,6 +47,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[AgentVerifier, Pagev4AgentVerifier]: """ + List Agent Verifiers. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -165,6 +167,8 @@ def get( self, agent_uuid: str, verifier_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[AgentVerifier]: """ + Get Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -245,6 +249,8 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentVerifier]: """ + Update Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -366,6 +372,8 @@ def invalidate_evidence( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentVerifierEvidenceInvalidationResult]: """ + Invalidate Agent Verifier Evidence. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -375,7 +383,7 @@ def invalidate_evidence( Verifier UUID reason : str - Why evidence from these verifier revisions is invalid. + The developer supplies why evidence from these verifier revisions is invalid. verifier_revisions : typing.Sequence[int] Verifier revisions whose accepted evidence is no longer valid. @@ -470,6 +478,8 @@ def revoke( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AgentVerifier]: """ + Revoke Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -579,6 +589,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[AgentVerifier, Pagev4AgentVerifier]: """ + List Agent Verifiers. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -700,6 +712,8 @@ async def get( self, agent_uuid: str, verifier_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[AgentVerifier]: """ + Get Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -780,6 +794,8 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentVerifier]: """ + Update Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -901,6 +917,8 @@ async def invalidate_evidence( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentVerifierEvidenceInvalidationResult]: """ + Invalidate Agent Verifier Evidence. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str @@ -910,7 +928,7 @@ async def invalidate_evidence( Verifier UUID reason : str - Why evidence from these verifier revisions is invalid. + The developer supplies why evidence from these verifier revisions is invalid. verifier_revisions : typing.Sequence[int] Verifier revisions whose accepted evidence is no longer valid. @@ -1005,6 +1023,8 @@ async def revoke( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AgentVerifier]: """ + Revoke Agent Verifier. Agent Skills is in closed release. Zep enables Agent Skills only for select accounts. A request from an account without access returns `403 permission_denied`. To get access, contact support@getzep.com. + Parameters ---------- agent_uuid : str diff --git a/src/zep_cloud/core/client_wrapper.py b/src/zep_cloud/core/client_wrapper.py index d3deb3c2..226c2a49 100644 --- a/src/zep_cloud/core/client_wrapper.py +++ b/src/zep_cloud/core/client_wrapper.py @@ -33,12 +33,12 @@ def get_headers(self) -> typing.Dict[str, str]: import platform headers: typing.Dict[str, str] = { - "User-Agent": "zep-cloud/4.0.0", + "User-Agent": "zep-cloud/4.0.1", "X-Fern-Language": "Python", "X-Fern-Runtime": f"python/{platform.python_version()}", "X-Fern-Platform": f"{platform.system().lower()}/{platform.release()}", "X-Fern-SDK-Name": "zep-cloud", - "X-Fern-SDK-Version": "4.0.0", + "X-Fern-SDK-Version": "4.0.1", **(self.get_custom_headers() or {}), } headers["Authorization"] = f"Api-Key {self.api_key}" diff --git a/src/zep_cloud/errors/__init__.py b/src/zep_cloud/errors/__init__.py index a98dbc3f..de83d463 100644 --- a/src/zep_cloud/errors/__init__.py +++ b/src/zep_cloud/errors/__init__.py @@ -11,8 +11,10 @@ from .conflict_error import ConflictError from .content_too_large_error import ContentTooLargeError from .forbidden_error import ForbiddenError + from .internal_server_error import InternalServerError from .not_found_error import NotFoundError from .service_unavailable_error import ServiceUnavailableError + from .too_many_requests_error import TooManyRequestsError from .unauthorized_error import UnauthorizedError from .unprocessable_entity_error import UnprocessableEntityError _dynamic_imports: typing.Dict[str, str] = { @@ -21,8 +23,10 @@ "ConflictError": ".conflict_error", "ContentTooLargeError": ".content_too_large_error", "ForbiddenError": ".forbidden_error", + "InternalServerError": ".internal_server_error", "NotFoundError": ".not_found_error", "ServiceUnavailableError": ".service_unavailable_error", + "TooManyRequestsError": ".too_many_requests_error", "UnauthorizedError": ".unauthorized_error", "UnprocessableEntityError": ".unprocessable_entity_error", } @@ -55,8 +59,10 @@ def __dir__(): "ConflictError", "ContentTooLargeError", "ForbiddenError", + "InternalServerError", "NotFoundError", "ServiceUnavailableError", + "TooManyRequestsError", "UnauthorizedError", "UnprocessableEntityError", ] diff --git a/src/zep_cloud/errors/internal_server_error.py b/src/zep_cloud/errors/internal_server_error.py new file mode 100644 index 00000000..42082d1f --- /dev/null +++ b/src/zep_cloud/errors/internal_server_error.py @@ -0,0 +1,11 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from ..core.api_error import ApiError as core_api_error_ApiError +from ..types.api_error import ApiError as types_api_error_ApiError + + +class InternalServerError(core_api_error_ApiError): + def __init__(self, body: types_api_error_ApiError, headers: typing.Optional[typing.Dict[str, str]] = None): + super().__init__(status_code=500, headers=headers, body=body) diff --git a/src/zep_cloud/errors/too_many_requests_error.py b/src/zep_cloud/errors/too_many_requests_error.py new file mode 100644 index 00000000..ce332667 --- /dev/null +++ b/src/zep_cloud/errors/too_many_requests_error.py @@ -0,0 +1,11 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from ..core.api_error import ApiError as core_api_error_ApiError +from ..types.api_error import ApiError as types_api_error_ApiError + + +class TooManyRequestsError(core_api_error_ApiError): + def __init__(self, body: types_api_error_ApiError, headers: typing.Optional[typing.Dict[str, str]] = None): + super().__init__(status_code=429, headers=headers, body=body) diff --git a/src/zep_cloud/graph/__init__.py b/src/zep_cloud/graph/__init__.py index 4958a427..9d584d9b 100644 --- a/src/zep_cloud/graph/__init__.py +++ b/src/zep_cloud/graph/__init__.py @@ -10,6 +10,7 @@ GraphContextRequestRecencyBias, GraphListRequestOrder, GraphListRequestOrderBy, + GraphQueryRequestMode, SearchEdgesRequestReranker, SearchEpisodesRequestReranker, SearchNodesRequestReranker, @@ -42,6 +43,7 @@ "GraphContextRequestRecencyBias": ".types", "GraphListRequestOrder": ".types", "GraphListRequestOrderBy": ".types", + "GraphQueryRequestMode": ".types", "HyperedgeListRequestOrder": ".hyperedge", "HyperedgeListRequestOrderBy": ".hyperedge", "NeighborsRequestDirection": ".node", @@ -101,6 +103,7 @@ def __dir__(): "GraphContextRequestRecencyBias", "GraphListRequestOrder", "GraphListRequestOrderBy", + "GraphQueryRequestMode", "HyperedgeListRequestOrder", "HyperedgeListRequestOrderBy", "NeighborsRequestDirection", diff --git a/src/zep_cloud/graph/client.py b/src/zep_cloud/graph/client.py index 1bd20aa4..b56934c3 100644 --- a/src/zep_cloud/graph/client.py +++ b/src/zep_cloud/graph/client.py @@ -28,6 +28,8 @@ from ..types.graph_context_response import GraphContextResponse from ..types.graph_delete_result import GraphDeleteResult from ..types.graph_page import GraphPage +from ..types.graph_query_response import GraphQueryResponse +from ..types.graph_query_stream_event import GraphQueryStreamEvent from ..types.instructions import Instructions from ..types.node import Node from ..types.node_page import NodePage @@ -47,6 +49,7 @@ from .types.graph_context_request_recency_bias import GraphContextRequestRecencyBias from .types.graph_list_request_order import GraphListRequestOrder from .types.graph_list_request_order_by import GraphListRequestOrderBy +from .types.graph_query_request_mode import GraphQueryRequestMode from .types.search_edges_request_reranker import SearchEdgesRequestReranker from .types.search_episodes_request_reranker import SearchEpisodesRequestReranker from .types.search_nodes_request_reranker import SearchNodesRequestReranker @@ -250,6 +253,130 @@ def lookup( ) return _response.data + def query_stream( + self, + *, + graph_uuids: typing.Sequence[str], + query: str, + generate_answer: typing.Optional[bool] = OMIT, + guidance: typing.Optional[str] = OMIT, + mode: typing.Optional[GraphQueryRequestMode] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> typing.Iterator[GraphQueryStreamEvent]: + """ + Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set `generate_answer` to `true` to also get an answer that a model writes from the records, with the cited graph items. Set `stream` to `true` to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns `404 not_found`. To get access, contact support@getzep.com. + + Parameters + ---------- + graph_uuids : typing.Sequence[str] + The graph UUIDs to query. The current release accepts one UUID. + + query : str + The natural-language question about the graph. + + generate_answer : typing.Optional[bool] + When true, a model also writes an answer from the retrieved records. + The default is false: the response has the records and no answer. + + guidance : typing.Optional[str] + Optional caller guidance for the answer. The agent treats it as untrusted text. + + mode : typing.Optional[GraphQueryRequestMode] + The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Yields + ------ + typing.Iterator[GraphQueryStreamEvent] + + + Examples + -------- + from zep_cloud import Zep + + client = Zep( + api_key="YOUR_API_KEY", + ) + response = client.graph.query_stream( + graph_uuids=["graph_uuids"], + query="query", + ) + for chunk in response: + yield chunk + """ + with self._raw_client.query_stream( + graph_uuids=graph_uuids, + query=query, + generate_answer=generate_answer, + guidance=guidance, + mode=mode, + request_options=request_options, + ) as r: + yield from r.data + + def query( + self, + *, + graph_uuids: typing.Sequence[str], + query: str, + generate_answer: typing.Optional[bool] = OMIT, + guidance: typing.Optional[str] = OMIT, + mode: typing.Optional[GraphQueryRequestMode] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> GraphQueryResponse: + """ + Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set `generate_answer` to `true` to also get an answer that a model writes from the records, with the cited graph items. Set `stream` to `true` to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns `404 not_found`. To get access, contact support@getzep.com. + + Parameters + ---------- + graph_uuids : typing.Sequence[str] + The graph UUIDs to query. The current release accepts one UUID. + + query : str + The natural-language question about the graph. + + generate_answer : typing.Optional[bool] + When true, a model also writes an answer from the retrieved records. + The default is false: the response has the records and no answer. + + guidance : typing.Optional[str] + Optional caller guidance for the answer. The agent treats it as untrusted text. + + mode : typing.Optional[GraphQueryRequestMode] + The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GraphQueryResponse + + + Examples + -------- + from zep_cloud import Zep + + client = Zep( + api_key="YOUR_API_KEY", + ) + client.graph.query( + graph_uuids=["graph_uuids"], + query="query", + ) + """ + _response = self._raw_client.query( + graph_uuids=graph_uuids, + query=query, + generate_answer=generate_answer, + guidance=guidance, + mode=mode, + request_options=request_options, + ) + return _response.data + def get(self, graph_uuid: str, *, request_options: typing.Optional[RequestOptions] = None) -> Graph: """ Parameters @@ -1705,6 +1832,147 @@ async def main() -> None: ) return _response.data + async def query_stream( + self, + *, + graph_uuids: typing.Sequence[str], + query: str, + generate_answer: typing.Optional[bool] = OMIT, + guidance: typing.Optional[str] = OMIT, + mode: typing.Optional[GraphQueryRequestMode] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> typing.AsyncIterator[GraphQueryStreamEvent]: + """ + Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set `generate_answer` to `true` to also get an answer that a model writes from the records, with the cited graph items. Set `stream` to `true` to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns `404 not_found`. To get access, contact support@getzep.com. + + Parameters + ---------- + graph_uuids : typing.Sequence[str] + The graph UUIDs to query. The current release accepts one UUID. + + query : str + The natural-language question about the graph. + + generate_answer : typing.Optional[bool] + When true, a model also writes an answer from the retrieved records. + The default is false: the response has the records and no answer. + + guidance : typing.Optional[str] + Optional caller guidance for the answer. The agent treats it as untrusted text. + + mode : typing.Optional[GraphQueryRequestMode] + The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Yields + ------ + typing.AsyncIterator[GraphQueryStreamEvent] + + + Examples + -------- + import asyncio + + from zep_cloud import AsyncZep + + client = AsyncZep( + api_key="YOUR_API_KEY", + ) + + + async def main() -> None: + response = client.graph.query_stream( + graph_uuids=["graph_uuids"], + query="query", + ) + async for chunk in response: + yield chunk + + + asyncio.run(main()) + """ + async with self._raw_client.query_stream( + graph_uuids=graph_uuids, + query=query, + generate_answer=generate_answer, + guidance=guidance, + mode=mode, + request_options=request_options, + ) as r: + async for _chunk in r.data: + yield _chunk + + async def query( + self, + *, + graph_uuids: typing.Sequence[str], + query: str, + generate_answer: typing.Optional[bool] = OMIT, + guidance: typing.Optional[str] = OMIT, + mode: typing.Optional[GraphQueryRequestMode] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> GraphQueryResponse: + """ + Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set `generate_answer` to `true` to also get an answer that a model writes from the records, with the cited graph items. Set `stream` to `true` to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns `404 not_found`. To get access, contact support@getzep.com. + + Parameters + ---------- + graph_uuids : typing.Sequence[str] + The graph UUIDs to query. The current release accepts one UUID. + + query : str + The natural-language question about the graph. + + generate_answer : typing.Optional[bool] + When true, a model also writes an answer from the retrieved records. + The default is false: the response has the records and no answer. + + guidance : typing.Optional[str] + Optional caller guidance for the answer. The agent treats it as untrusted text. + + mode : typing.Optional[GraphQueryRequestMode] + The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + GraphQueryResponse + + + Examples + -------- + import asyncio + + from zep_cloud import AsyncZep + + client = AsyncZep( + api_key="YOUR_API_KEY", + ) + + + async def main() -> None: + await client.graph.query( + graph_uuids=["graph_uuids"], + query="query", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.query( + graph_uuids=graph_uuids, + query=query, + generate_answer=generate_answer, + guidance=guidance, + mode=mode, + request_options=request_options, + ) + return _response.data + async def get(self, graph_uuid: str, *, request_options: typing.Optional[RequestOptions] = None) -> Graph: """ Parameters diff --git a/src/zep_cloud/graph/raw_client.py b/src/zep_cloud/graph/raw_client.py index 5c831c94..7bd65ded 100644 --- a/src/zep_cloud/graph/raw_client.py +++ b/src/zep_cloud/graph/raw_client.py @@ -1,22 +1,29 @@ # This file was auto-generated by Fern from our API Definition. +import contextlib import typing from json.decoder import JSONDecodeError +from logging import error, warning from ..core.api_error import ApiError as core_api_error_ApiError from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ..core.http_response import AsyncHttpResponse, HttpResponse +from ..core.http_sse._api import EventSource from ..core.idempotency import generate_idempotency_key from ..core.jsonable_encoder import encode_path_param from ..core.pagination import AsyncPager, SyncPager from ..core.parse_error import ParsingError -from ..core.pydantic_utilities import parse_obj_as +from ..core.pydantic_utilities import parse_obj_as, parse_sse_obj from ..core.request_options import RequestOptions from ..core.serialization import convert_and_respect_annotation_metadata from ..errors.bad_request_error import BadRequestError from ..errors.conflict_error import ConflictError +from ..errors.content_too_large_error import ContentTooLargeError from ..errors.forbidden_error import ForbiddenError +from ..errors.internal_server_error import InternalServerError from ..errors.not_found_error import NotFoundError +from ..errors.service_unavailable_error import ServiceUnavailableError +from ..errors.too_many_requests_error import TooManyRequestsError from ..errors.unauthorized_error import UnauthorizedError from ..types.api_error import ApiError as types_api_error_ApiError from ..types.async_result import AsyncResult @@ -40,6 +47,8 @@ from ..types.graph_context_response import GraphContextResponse from ..types.graph_delete_result import GraphDeleteResult from ..types.graph_page import GraphPage +from ..types.graph_query_response import GraphQueryResponse +from ..types.graph_query_stream_event import GraphQueryStreamEvent from ..types.instructions import Instructions from ..types.node import Node from ..types.node_page import NodePage @@ -58,6 +67,7 @@ from .types.graph_context_request_recency_bias import GraphContextRequestRecencyBias from .types.graph_list_request_order import GraphListRequestOrder from .types.graph_list_request_order_by import GraphListRequestOrderBy +from .types.graph_query_request_mode import GraphQueryRequestMode from .types.search_edges_request_reranker import SearchEdgesRequestReranker from .types.search_episodes_request_reranker import SearchEpisodesRequestReranker from .types.search_nodes_request_reranker import SearchNodesRequestReranker @@ -443,6 +453,372 @@ def lookup( status_code=_response.status_code, headers=dict(_response.headers), body=_response_json ) + @contextlib.contextmanager + def query_stream( + self, + *, + graph_uuids: typing.Sequence[str], + query: str, + generate_answer: typing.Optional[bool] = OMIT, + guidance: typing.Optional[str] = OMIT, + mode: typing.Optional[GraphQueryRequestMode] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> typing.Iterator[HttpResponse[typing.Iterator[GraphQueryStreamEvent]]]: + """ + Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set `generate_answer` to `true` to also get an answer that a model writes from the records, with the cited graph items. Set `stream` to `true` to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns `404 not_found`. To get access, contact support@getzep.com. + + Parameters + ---------- + graph_uuids : typing.Sequence[str] + The graph UUIDs to query. The current release accepts one UUID. + + query : str + The natural-language question about the graph. + + generate_answer : typing.Optional[bool] + When true, a model also writes an answer from the retrieved records. + The default is false: the response has the records and no answer. + + guidance : typing.Optional[str] + Optional caller guidance for the answer. The agent treats it as untrusted text. + + mode : typing.Optional[GraphQueryRequestMode] + The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Yields + ------ + typing.Iterator[HttpResponse[typing.Iterator[GraphQueryStreamEvent]]] + + """ + with self._client_wrapper.httpx_client.stream( + "graphs/query", + method="POST", + json={ + "generate_answer": generate_answer, + "graph_uuids": graph_uuids, + "guidance": guidance, + "mode": mode, + "query": query, + "stream": True, + }, + headers={ + "content-type": "application/json", + "Idempotency-Key": generate_idempotency_key(), + }, + request_options=request_options, + omit=OMIT, + ) as _response: + + def _stream() -> HttpResponse[typing.Iterator[GraphQueryStreamEvent]]: + try: + if 200 <= _response.status_code < 300: + + def _iter(): + _event_source = EventSource(_response) + for _sse in _event_source.iter_sse(): + if _sse.data == None: + return + if len(_sse.data) == 0: + continue + try: + yield typing.cast( + GraphQueryStreamEvent, + parse_sse_obj( + sse=_sse, + type_=GraphQueryStreamEvent, # type: ignore + ), + ) + except JSONDecodeError as e: + warning(f"Skipping SSE event with invalid JSON: {e}, sse: {_sse!r}") + except (TypeError, ValueError, KeyError, AttributeError) as e: + warning( + f"Skipping SSE event due to model construction error: {type(e).__name__}: {e}, sse: {_sse!r}" + ) + except Exception as e: + error( + f"Unexpected error processing SSE event: {type(e).__name__}: {e}, sse: {_sse!r}" + ) + return + + return HttpResponse(response=_response, data=_iter()) + _response.read() + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 413: + raise ContentTooLargeError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 503: + raise ServiceUnavailableError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise core_api_error_ApiError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.text + ) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, + headers=dict(_response.headers), + body=_response.json(), + cause=e, + ) + raise core_api_error_ApiError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response_json + ) + + yield _stream() + + def query( + self, + *, + graph_uuids: typing.Sequence[str], + query: str, + generate_answer: typing.Optional[bool] = OMIT, + guidance: typing.Optional[str] = OMIT, + mode: typing.Optional[GraphQueryRequestMode] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[GraphQueryResponse]: + """ + Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set `generate_answer` to `true` to also get an answer that a model writes from the records, with the cited graph items. Set `stream` to `true` to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns `404 not_found`. To get access, contact support@getzep.com. + + Parameters + ---------- + graph_uuids : typing.Sequence[str] + The graph UUIDs to query. The current release accepts one UUID. + + query : str + The natural-language question about the graph. + + generate_answer : typing.Optional[bool] + When true, a model also writes an answer from the retrieved records. + The default is false: the response has the records and no answer. + + guidance : typing.Optional[str] + Optional caller guidance for the answer. The agent treats it as untrusted text. + + mode : typing.Optional[GraphQueryRequestMode] + The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[GraphQueryResponse] + + """ + _response = self._client_wrapper.httpx_client.request( + "graphs/query", + method="POST", + json={ + "generate_answer": generate_answer, + "graph_uuids": graph_uuids, + "guidance": guidance, + "mode": mode, + "query": query, + "stream": False, + }, + headers={ + "content-type": "application/json", + "Idempotency-Key": generate_idempotency_key(), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GraphQueryResponse, + parse_obj_as( + type_=GraphQueryResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 413: + raise ContentTooLargeError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 503: + raise ServiceUnavailableError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise core_api_error_ApiError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.text + ) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise core_api_error_ApiError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response_json + ) + def get(self, graph_uuid: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Graph]: """ Parameters @@ -3308,6 +3684,372 @@ async def lookup( status_code=_response.status_code, headers=dict(_response.headers), body=_response_json ) + @contextlib.asynccontextmanager + async def query_stream( + self, + *, + graph_uuids: typing.Sequence[str], + query: str, + generate_answer: typing.Optional[bool] = OMIT, + guidance: typing.Optional[str] = OMIT, + mode: typing.Optional[GraphQueryRequestMode] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[GraphQueryStreamEvent]]]: + """ + Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set `generate_answer` to `true` to also get an answer that a model writes from the records, with the cited graph items. Set `stream` to `true` to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns `404 not_found`. To get access, contact support@getzep.com. + + Parameters + ---------- + graph_uuids : typing.Sequence[str] + The graph UUIDs to query. The current release accepts one UUID. + + query : str + The natural-language question about the graph. + + generate_answer : typing.Optional[bool] + When true, a model also writes an answer from the retrieved records. + The default is false: the response has the records and no answer. + + guidance : typing.Optional[str] + Optional caller guidance for the answer. The agent treats it as untrusted text. + + mode : typing.Optional[GraphQueryRequestMode] + The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Yields + ------ + typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[GraphQueryStreamEvent]]] + + """ + async with self._client_wrapper.httpx_client.stream( + "graphs/query", + method="POST", + json={ + "generate_answer": generate_answer, + "graph_uuids": graph_uuids, + "guidance": guidance, + "mode": mode, + "query": query, + "stream": True, + }, + headers={ + "content-type": "application/json", + "Idempotency-Key": generate_idempotency_key(), + }, + request_options=request_options, + omit=OMIT, + ) as _response: + + async def _stream() -> AsyncHttpResponse[typing.AsyncIterator[GraphQueryStreamEvent]]: + try: + if 200 <= _response.status_code < 300: + + async def _iter(): + _event_source = EventSource(_response) + async for _sse in _event_source.aiter_sse(): + if _sse.data == None: + return + if len(_sse.data) == 0: + continue + try: + yield typing.cast( + GraphQueryStreamEvent, + parse_sse_obj( + sse=_sse, + type_=GraphQueryStreamEvent, # type: ignore + ), + ) + except JSONDecodeError as e: + warning(f"Skipping SSE event with invalid JSON: {e}, sse: {_sse!r}") + except (TypeError, ValueError, KeyError, AttributeError) as e: + warning( + f"Skipping SSE event due to model construction error: {type(e).__name__}: {e}, sse: {_sse!r}" + ) + except Exception as e: + error( + f"Unexpected error processing SSE event: {type(e).__name__}: {e}, sse: {_sse!r}" + ) + return + + return AsyncHttpResponse(response=_response, data=_iter()) + await _response.aread() + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 413: + raise ContentTooLargeError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 503: + raise ServiceUnavailableError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise core_api_error_ApiError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.text + ) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, + headers=dict(_response.headers), + body=_response.json(), + cause=e, + ) + raise core_api_error_ApiError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response_json + ) + + yield await _stream() + + async def query( + self, + *, + graph_uuids: typing.Sequence[str], + query: str, + generate_answer: typing.Optional[bool] = OMIT, + guidance: typing.Optional[str] = OMIT, + mode: typing.Optional[GraphQueryRequestMode] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[GraphQueryResponse]: + """ + Experimental. Retrieves the graph records for a natural-language question about a graph with a read-only retrieval loop. By default, the response has the retrieved records and no answer. Set `generate_answer` to `true` to also get an answer that a model writes from the records, with the cited graph items. Set `stream` to `true` to get the retrieval calls as server-sent events. The default mode is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. The operation is experimental and in closed release. Zep enables the operation only for select accounts. The request, the response, the events, and the modes of the operation can change. A request from an account without access returns `404 not_found`. To get access, contact support@getzep.com. + + Parameters + ---------- + graph_uuids : typing.Sequence[str] + The graph UUIDs to query. The current release accepts one UUID. + + query : str + The natural-language question about the graph. + + generate_answer : typing.Optional[bool] + When true, a model also writes an answer from the retrieved records. + The default is false: the response has the records and no answer. + + guidance : typing.Optional[str] + Optional caller guidance for the answer. The agent treats it as untrusted text. + + mode : typing.Optional[GraphQueryRequestMode] + The retrieval mode. The default is fast. fast: A decision model selects the types of search for each round and stops when it has enough context. The query runs at most 3 search rounds. deep: A model plans its own searches. It can page through complete lists and read more records before it answers. A project with a BYOM configuration supports only deep. A BYOC deployment supports only deep. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[GraphQueryResponse] + + """ + _response = await self._client_wrapper.httpx_client.request( + "graphs/query", + method="POST", + json={ + "generate_answer": generate_answer, + "graph_uuids": graph_uuids, + "guidance": guidance, + "mode": mode, + "query": query, + "stream": False, + }, + headers={ + "content-type": "application/json", + "Idempotency-Key": generate_idempotency_key(), + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + GraphQueryResponse, + parse_obj_as( + type_=GraphQueryResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 413: + raise ContentTooLargeError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 503: + raise ServiceUnavailableError( + headers=dict(_response.headers), + body=typing.cast( + types_api_error_ApiError, + parse_obj_as( + type_=types_api_error_ApiError, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise core_api_error_ApiError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.text + ) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise core_api_error_ApiError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response_json + ) + async def get( self, graph_uuid: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[Graph]: diff --git a/src/zep_cloud/graph/types/__init__.py b/src/zep_cloud/graph/types/__init__.py index ace9479a..15cc7a71 100644 --- a/src/zep_cloud/graph/types/__init__.py +++ b/src/zep_cloud/graph/types/__init__.py @@ -9,6 +9,7 @@ from .graph_context_request_recency_bias import GraphContextRequestRecencyBias from .graph_list_request_order import GraphListRequestOrder from .graph_list_request_order_by import GraphListRequestOrderBy + from .graph_query_request_mode import GraphQueryRequestMode from .search_edges_request_reranker import SearchEdgesRequestReranker from .search_episodes_request_reranker import SearchEpisodesRequestReranker from .search_nodes_request_reranker import SearchNodesRequestReranker @@ -19,6 +20,7 @@ "GraphContextRequestRecencyBias": ".graph_context_request_recency_bias", "GraphListRequestOrder": ".graph_list_request_order", "GraphListRequestOrderBy": ".graph_list_request_order_by", + "GraphQueryRequestMode": ".graph_query_request_mode", "SearchEdgesRequestReranker": ".search_edges_request_reranker", "SearchEpisodesRequestReranker": ".search_episodes_request_reranker", "SearchNodesRequestReranker": ".search_nodes_request_reranker", @@ -53,6 +55,7 @@ def __dir__(): "GraphContextRequestRecencyBias", "GraphListRequestOrder", "GraphListRequestOrderBy", + "GraphQueryRequestMode", "SearchEdgesRequestReranker", "SearchEpisodesRequestReranker", "SearchNodesRequestReranker", diff --git a/src/zep_cloud/graph/types/graph_query_request_mode.py b/src/zep_cloud/graph/types/graph_query_request_mode.py new file mode 100644 index 00000000..1b91823a --- /dev/null +++ b/src/zep_cloud/graph/types/graph_query_request_mode.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GraphQueryRequestMode = typing.Union[typing.Literal["fast", "deep"], typing.Any] diff --git a/src/zep_cloud/trace_connection/trace/client.py b/src/zep_cloud/trace_connection/trace/client.py index 9f01441e..c2acb6d5 100644 --- a/src/zep_cloud/trace_connection/trace/client.py +++ b/src/zep_cloud/trace_connection/trace/client.py @@ -49,7 +49,7 @@ def get( Trace connection UUID provider_project_id : str - ProviderProjectID is the provider project identifier. + The developer supplies the project ID from the selected provider. trace_id : str TraceID is the provider trace identifier. @@ -106,7 +106,7 @@ def list( Trace connection UUID provider_project_id : str - ProviderProjectID is the provider project identifier. + The developer supplies the project ID from the selected provider. page_size : typing.Optional[int] The maximum number of items in one page. The SDK method returns a pager. In Python, `.items` holds only the first page. In TypeScript, `.data` holds only the first page. To read every page, iterate the pager: use `for` or `list(...)` in Python, or `for await` in TypeScript. In Go, the method returns one page, and `Iterator()` reads all pages. @@ -185,7 +185,7 @@ async def get( Trace connection UUID provider_project_id : str - ProviderProjectID is the provider project identifier. + The developer supplies the project ID from the selected provider. trace_id : str TraceID is the provider trace identifier. @@ -250,7 +250,7 @@ async def list( Trace connection UUID provider_project_id : str - ProviderProjectID is the provider project identifier. + The developer supplies the project ID from the selected provider. page_size : typing.Optional[int] The maximum number of items in one page. The SDK method returns a pager. In Python, `.items` holds only the first page. In TypeScript, `.data` holds only the first page. To read every page, iterate the pager: use `for` or `list(...)` in Python, or `for await` in TypeScript. In Go, the method returns one page, and `Iterator()` reads all pages. diff --git a/src/zep_cloud/trace_connection/trace/raw_client.py b/src/zep_cloud/trace_connection/trace/raw_client.py index bd34db34..46aab888 100644 --- a/src/zep_cloud/trace_connection/trace/raw_client.py +++ b/src/zep_cloud/trace_connection/trace/raw_client.py @@ -52,7 +52,7 @@ def get( Trace connection UUID provider_project_id : str - ProviderProjectID is the provider project identifier. + The developer supplies the project ID from the selected provider. trace_id : str TraceID is the provider trace identifier. @@ -182,7 +182,7 @@ def list( Trace connection UUID provider_project_id : str - ProviderProjectID is the provider project identifier. + The developer supplies the project ID from the selected provider. page_size : typing.Optional[int] The maximum number of items in one page. The SDK method returns a pager. In Python, `.items` holds only the first page. In TypeScript, `.data` holds only the first page. To read every page, iterate the pager: use `for` or `list(...)` in Python, or `for await` in TypeScript. In Go, the method returns one page, and `Iterator()` reads all pages. @@ -333,7 +333,7 @@ async def get( Trace connection UUID provider_project_id : str - ProviderProjectID is the provider project identifier. + The developer supplies the project ID from the selected provider. trace_id : str TraceID is the provider trace identifier. @@ -463,7 +463,7 @@ async def list( Trace connection UUID provider_project_id : str - ProviderProjectID is the provider project identifier. + The developer supplies the project ID from the selected provider. page_size : typing.Optional[int] The maximum number of items in one page. The SDK method returns a pager. In Python, `.items` holds only the first page. In TypeScript, `.data` holds only the first page. To read every page, iterate the pager: use `for` or `list(...)` in Python, or `for await` in TypeScript. In Go, the method returns one page, and `Iterator()` reads all pages. diff --git a/src/zep_cloud/types/__init__.py b/src/zep_cloud/types/__init__.py index e245364c..7a44b5e8 100644 --- a/src/zep_cloud/types/__init__.py +++ b/src/zep_cloud/types/__init__.py @@ -208,6 +208,36 @@ from .graph_data_type import GraphDataType from .graph_delete_result import GraphDeleteResult from .graph_page import GraphPage + from .graph_query_citations import GraphQueryCitations + from .graph_query_edge import GraphQueryEdge + from .graph_query_error_event import GraphQueryErrorEvent + from .graph_query_handle import GraphQueryHandle + from .graph_query_handle_item_type import GraphQueryHandleItemType + from .graph_query_listing import GraphQueryListing + from .graph_query_node import GraphQueryNode + from .graph_query_plan import GraphQueryPlan + from .graph_query_plan_event import GraphQueryPlanEvent + from .graph_query_plan_step import GraphQueryPlanStep + from .graph_query_reasoning_event import GraphQueryReasoningEvent + from .graph_query_response import GraphQueryResponse + from .graph_query_result_event import GraphQueryResultEvent + from .graph_query_results import GraphQueryResults + from .graph_query_started_event import GraphQueryStartedEvent + from .graph_query_stream_event import ( + GraphQueryStreamEvent, + GraphQueryStreamEvent_Error, + GraphQueryStreamEvent_Plan, + GraphQueryStreamEvent_Reasoning, + GraphQueryStreamEvent_Result, + GraphQueryStreamEvent_Started, + GraphQueryStreamEvent_ToolCall, + GraphQueryStreamEvent_ToolError, + GraphQueryStreamEvent_ToolResult, + ) + from .graph_query_tool_call_event import GraphQueryToolCallEvent + from .graph_query_tool_error_event import GraphQueryToolErrorEvent + from .graph_query_tool_error_event_reason import GraphQueryToolErrorEventReason + from .graph_query_tool_result_event import GraphQueryToolResultEvent from .hyperedge import Hyperedge from .hyperedge_edge import HyperedgeEdge from .hyperedge_input import HyperedgeInput @@ -552,6 +582,34 @@ "GraphDataType": ".graph_data_type", "GraphDeleteResult": ".graph_delete_result", "GraphPage": ".graph_page", + "GraphQueryCitations": ".graph_query_citations", + "GraphQueryEdge": ".graph_query_edge", + "GraphQueryErrorEvent": ".graph_query_error_event", + "GraphQueryHandle": ".graph_query_handle", + "GraphQueryHandleItemType": ".graph_query_handle_item_type", + "GraphQueryListing": ".graph_query_listing", + "GraphQueryNode": ".graph_query_node", + "GraphQueryPlan": ".graph_query_plan", + "GraphQueryPlanEvent": ".graph_query_plan_event", + "GraphQueryPlanStep": ".graph_query_plan_step", + "GraphQueryReasoningEvent": ".graph_query_reasoning_event", + "GraphQueryResponse": ".graph_query_response", + "GraphQueryResultEvent": ".graph_query_result_event", + "GraphQueryResults": ".graph_query_results", + "GraphQueryStartedEvent": ".graph_query_started_event", + "GraphQueryStreamEvent": ".graph_query_stream_event", + "GraphQueryStreamEvent_Error": ".graph_query_stream_event", + "GraphQueryStreamEvent_Plan": ".graph_query_stream_event", + "GraphQueryStreamEvent_Reasoning": ".graph_query_stream_event", + "GraphQueryStreamEvent_Result": ".graph_query_stream_event", + "GraphQueryStreamEvent_Started": ".graph_query_stream_event", + "GraphQueryStreamEvent_ToolCall": ".graph_query_stream_event", + "GraphQueryStreamEvent_ToolError": ".graph_query_stream_event", + "GraphQueryStreamEvent_ToolResult": ".graph_query_stream_event", + "GraphQueryToolCallEvent": ".graph_query_tool_call_event", + "GraphQueryToolErrorEvent": ".graph_query_tool_error_event", + "GraphQueryToolErrorEventReason": ".graph_query_tool_error_event_reason", + "GraphQueryToolResultEvent": ".graph_query_tool_result_event", "Hyperedge": ".hyperedge", "HyperedgeEdge": ".hyperedge_edge", "HyperedgeInput": ".hyperedge_input", @@ -920,6 +978,34 @@ def __dir__(): "GraphDataType", "GraphDeleteResult", "GraphPage", + "GraphQueryCitations", + "GraphQueryEdge", + "GraphQueryErrorEvent", + "GraphQueryHandle", + "GraphQueryHandleItemType", + "GraphQueryListing", + "GraphQueryNode", + "GraphQueryPlan", + "GraphQueryPlanEvent", + "GraphQueryPlanStep", + "GraphQueryReasoningEvent", + "GraphQueryResponse", + "GraphQueryResultEvent", + "GraphQueryResults", + "GraphQueryStartedEvent", + "GraphQueryStreamEvent", + "GraphQueryStreamEvent_Error", + "GraphQueryStreamEvent_Plan", + "GraphQueryStreamEvent_Reasoning", + "GraphQueryStreamEvent_Result", + "GraphQueryStreamEvent_Started", + "GraphQueryStreamEvent_ToolCall", + "GraphQueryStreamEvent_ToolError", + "GraphQueryStreamEvent_ToolResult", + "GraphQueryToolCallEvent", + "GraphQueryToolErrorEvent", + "GraphQueryToolErrorEventReason", + "GraphQueryToolResultEvent", "Hyperedge", "HyperedgeEdge", "HyperedgeInput", diff --git a/src/zep_cloud/types/add_agent_skill_use_outcome_request.py b/src/zep_cloud/types/add_agent_skill_use_outcome_request.py index 85aefad5..bbc34e4e 100644 --- a/src/zep_cloud/types/add_agent_skill_use_outcome_request.py +++ b/src/zep_cloud/types/add_agent_skill_use_outcome_request.py @@ -8,7 +8,11 @@ class AddAgentSkillUseOutcomeRequest(UniversalBaseModel): - outcome: AddAgentSkillUseOutcomeRequestOutcome + outcome: AddAgentSkillUseOutcomeRequestOutcome = pydantic.Field() + """ + The developer records the attempt outcome. Valid values are succeeded, + failed, partial, abandoned, and unknown. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_breaking_change.py b/src/zep_cloud/types/agent_breaking_change.py index fd12f02b..2a9694d9 100644 --- a/src/zep_cloud/types/agent_breaking_change.py +++ b/src/zep_cloud/types/agent_breaking_change.py @@ -9,17 +9,34 @@ class AgentBreakingChange(UniversalBaseModel): - affected_skill_count: typing.Optional[int] = None - agent_uuid: typing.Optional[str] = None + affected_skill_count: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the number of Skills affected by the declaration. + """ + + agent_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the Agent that received this declaration. + """ + revision: typing.Optional[int] = pydantic.Field(default=None) """ - The Agent revision produced by this declaration, stable on replay. + The service returns the Agent revision produced by this declaration, stable on replay. """ uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service assigns the UUID that identifies this declaration."), ] = None - version: typing.Optional[str] = None + """ + The service assigns the UUID that identifies this declaration. + """ + + version: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the deployment version recorded by this declaration. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_context.py b/src/zep_cloud/types/agent_context.py index b803c27b..b1dbc583 100644 --- a/src/zep_cloud/types/agent_context.py +++ b/src/zep_cloud/types/agent_context.py @@ -10,15 +10,50 @@ class AgentContext(UniversalBaseModel): - context: typing.Optional[str] = None - objective: typing.Optional[str] = None - partial_sources: typing.Optional[typing.List[AgentContextPartialSource]] = None - request_id: typing.Optional[str] = None - skipped: typing.Optional[typing.List[AgentContextSkippedSkill]] = None - snapshot: typing.Optional[typing.List[AgentContextSkillSnapshot]] = None - task_family: typing.Optional[str] = None - trace_uuid: typing.Optional[str] = None - truncated: typing.Optional[bool] = None + context: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns context for this result. + """ + + objective: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-instance objective. + """ + + partial_sources: typing.Optional[typing.List[AgentContextPartialSource]] = pydantic.Field(default=None) + """ + The service returns sources that it could not include in full. + """ + + request_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID that identifies this context request. + """ + + skipped: typing.Optional[typing.List[AgentContextSkippedSkill]] = pydantic.Field(default=None) + """ + The service returns the Skills that it skipped. + """ + + snapshot: typing.Optional[typing.List[AgentContextSkillSnapshot]] = pydantic.Field(default=None) + """ + The service returns a snapshot of the source data. + """ + + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-family slug. + """ + + trace_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the source Trace. + """ + + truncated: typing.Optional[bool] = pydantic.Field(default=None) + """ + The service sets this to true when the context exceeds its output limit. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_context_evidence_counts.py b/src/zep_cloud/types/agent_context_evidence_counts.py index c882bb3a..8e53f50e 100644 --- a/src/zep_cloud/types/agent_context_evidence_counts.py +++ b/src/zep_cloud/types/agent_context_evidence_counts.py @@ -7,9 +7,20 @@ class AgentContextEvidenceCounts(UniversalBaseModel): - contradicting: typing.Optional[int] = None - neutral: typing.Optional[int] = None - supporting: typing.Optional[int] = None + contradicting: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns contradicting evidence count. + """ + + neutral: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the count of neutral evidence items. + """ + + supporting: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns supporting evidence count. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_context_partial_source.py b/src/zep_cloud/types/agent_context_partial_source.py index 56d4ccbc..8de53fb8 100644 --- a/src/zep_cloud/types/agent_context_partial_source.py +++ b/src/zep_cloud/types/agent_context_partial_source.py @@ -7,9 +7,20 @@ class AgentContextPartialSource(UniversalBaseModel): - reason: typing.Optional[str] = None - source: typing.Optional[str] = None - task_uuid: typing.Optional[str] = None + reason: typing.Optional[str] = pydantic.Field(default=None) + """ + The service explains why this source is partial. + """ + + source: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the source used to build this context. + """ + + task_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the Task linked to this partial source. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_context_resource.py b/src/zep_cloud/types/agent_context_resource.py index 21747abe..5d711c5a 100644 --- a/src/zep_cloud/types/agent_context_resource.py +++ b/src/zep_cloud/types/agent_context_resource.py @@ -7,8 +7,15 @@ class AgentContextResource(UniversalBaseModel): - name: str - version: typing.Optional[str] = None + name: str = pydantic.Field() + """ + The service returns the display name. At most 128. + """ + + version: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the version of this context resource. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_context_skill_snapshot.py b/src/zep_cloud/types/agent_context_skill_snapshot.py index 939b69c5..4a124f6c 100644 --- a/src/zep_cloud/types/agent_context_skill_snapshot.py +++ b/src/zep_cloud/types/agent_context_skill_snapshot.py @@ -8,12 +8,35 @@ class AgentContextSkillSnapshot(UniversalBaseModel): - artifact_sha256: typing.Optional[str] = None - evidence_citations: typing.Optional[typing.List[str]] = None - evidence_counts: typing.Optional[AgentContextEvidenceCounts] = None - rank: typing.Optional[int] = None - skill_uuid: typing.Optional[str] = None - version: typing.Optional[int] = None + artifact_sha256: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the SHA-256 digest of the Skill artifact. + """ + + evidence_citations: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns citations that support this Skill snapshot. + """ + + evidence_counts: typing.Optional[AgentContextEvidenceCounts] = pydantic.Field(default=None) + """ + The service returns counts of evidence items by result. + """ + + rank: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns result rank. + """ + + skill_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the Skill. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the Skill version number. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_context_skipped_skill.py b/src/zep_cloud/types/agent_context_skipped_skill.py index 3c219ef3..226226ed 100644 --- a/src/zep_cloud/types/agent_context_skipped_skill.py +++ b/src/zep_cloud/types/agent_context_skipped_skill.py @@ -7,9 +7,20 @@ class AgentContextSkippedSkill(UniversalBaseModel): - reason: typing.Optional[str] = None - skill_uuid: typing.Optional[str] = None - version: typing.Optional[int] = None + reason: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns why the Skill was skipped from the context. + """ + + skill_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the Skill. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the Skill version number. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_learning_state.py b/src/zep_cloud/types/agent_learning_state.py index fbd20b48..9f6ff666 100644 --- a/src/zep_cloud/types/agent_learning_state.py +++ b/src/zep_cloud/types/agent_learning_state.py @@ -9,21 +9,47 @@ class AgentLearningState(UniversalBaseModel): approval: typing.Optional[str] = pydantic.Field(default=None) """ - Approval is the approval mode of the Agent: manual or auto. The default is auto. + The service returns the approval mode. Valid values are auto and manual. The default is auto. + """ + + compilation_mode: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Agent's learning mode. Valid values are scheduled, manual, and + on_close. The default is scheduled. """ - compilation_mode: typing.Optional[str] = None compilation_pending: typing.Optional[bool] = pydantic.Field(default=None) """ - CompilationPending is true while a learning run for the task family - waits to start or runs. Skills from that run are not yet available. + The service sets this to true while a learning run waits to start or runs. + Skills from that run are not yet available. + """ + + eligible_trace_count: typing.Optional[int] = pydantic.Field(default=None) + """ + The service reports the number of Traces that can support learning. + """ + + minimum_attempt_families: typing.Optional[int] = pydantic.Field(default=None) + """ + The service reports how many distinct attempt families a run needs. The default is 3 in + scheduled mode and 1 in on_close mode. """ - eligible_trace_count: typing.Optional[int] = None - minimum_attempt_families: typing.Optional[int] = None - next_step: typing.Optional[str] = None - required_evaluations: typing.Optional[typing.List[str]] = None - task_family: typing.Optional[str] = None + next_step: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns text that tells a person what to do next. Code must + not treat this text as a stable value. + """ + + required_evaluations: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns the evaluations that each candidate must pass. + """ + + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the category whose learning progress this record describes. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_memory_evaluation_policy.py b/src/zep_cloud/types/agent_memory_evaluation_policy.py index 83914406..065fb3f2 100644 --- a/src/zep_cloud/types/agent_memory_evaluation_policy.py +++ b/src/zep_cloud/types/agent_memory_evaluation_policy.py @@ -8,8 +8,15 @@ class AgentMemoryEvaluationPolicy(UniversalBaseModel): - requirements: typing.List[AgentMemoryEvaluationRequirement] - task_family: str + requirements: typing.List[AgentMemoryEvaluationRequirement] = pydantic.Field() + """ + The developer lists one or more evaluation requirements for this policy. + """ + + task_family: str = pydantic.Field() + """ + The developer selects the task family that uses this evaluation policy. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_memory_evaluation_requirement.py b/src/zep_cloud/types/agent_memory_evaluation_requirement.py index 36db8c89..07bcbcb0 100644 --- a/src/zep_cloud/types/agent_memory_evaluation_requirement.py +++ b/src/zep_cloud/types/agent_memory_evaluation_requirement.py @@ -7,11 +7,32 @@ class AgentMemoryEvaluationRequirement(UniversalBaseModel): - controlled: typing.Optional[bool] = None - environment: typing.Optional[str] = None - evaluated_by: str - evaluator_version: str - result: str + controlled: typing.Optional[bool] = pydantic.Field(default=None) + """ + The service sets this to true when it controls whether the requirement + passes admission. + """ + + environment: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the environment used for this evaluation. + """ + + evaluated_by: str = pydantic.Field() + """ + The developer selects the evaluation source. + """ + + evaluator_version: str = pydantic.Field() + """ + The service returns the version of the evaluation rule. + """ + + result: str = pydantic.Field() + """ + The developer supplies the required result for this evaluation. Valid + values are defined by the evaluation named in the policy. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_memory_settings.py b/src/zep_cloud/types/agent_memory_settings.py index ef09a9f5..07a0f842 100644 --- a/src/zep_cloud/types/agent_memory_settings.py +++ b/src/zep_cloud/types/agent_memory_settings.py @@ -10,33 +10,61 @@ class AgentMemorySettings(UniversalBaseModel): - admission_evaluation_requirements: typing.Optional[typing.List[AgentMemoryEvaluationPolicy]] = None - approval: typing.Optional[AgentMemorySettingsApproval] = None - approval_minimum_attempt_families: typing.Optional[int] = None + admission_evaluation_requirements: typing.Optional[typing.List[AgentMemoryEvaluationPolicy]] = pydantic.Field( + default=None + ) + """ + The developer lists the evaluations that each candidate must pass for its category. + """ + + approval: typing.Optional[AgentMemorySettingsApproval] = pydantic.Field(default=None) + """ + The developer sets the approval mode. Valid values are auto and manual. The default is auto. + """ + + approval_minimum_attempt_families: typing.Optional[int] = pydantic.Field(default=None) + """ + The developer sets the minimum number of distinct attempt families for admission. The range is + 1 to 16, and the default is 1. + """ + approval_required_tools: typing.Optional[typing.List[str]] = pydantic.Field(default=None) """ - ApprovalRequiredTools lists the tool names that need a member approval in - auto approval. A generated Skill that uses one of these tools waits for a - member. The default is an empty list. + The developer lists tool names that need member approval in auto approval. A generated Skill + that uses one of these tools waits for a member. The list can contain up to 256 unique names, + each at most 255 characters. The default is an empty list. + """ + + auto_approval_task_families: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer lists task-family slugs that use auto approval. An empty list applies auto + approval to all task families. + """ + + compilation_mode: typing.Optional[AgentMemorySettingsCompilationMode] = pydantic.Field(default=None) + """ + The developer selects the compilation mode. Valid values are scheduled, manual, and on_close. + The default is scheduled. """ - auto_approval_task_families: typing.Optional[typing.List[str]] = None - compilation_mode: typing.Optional[AgentMemorySettingsCompilationMode] = None provisional_expiry_days: typing.Optional[int] = pydantic.Field(default=None) """ - ProvisionalExpiryDays is the period after which Zep retires a provisional - Skill that no application used. When it is not set, provisional Skills do - not expire. + The developer sets how many days an unused provisional Skill can remain before the service + retires it. The range is 1 to 3650 days. If omitted, provisional Skills do not expire. """ provisional_skill_limit: typing.Optional[int] = pydantic.Field(default=None) """ - ProvisionalSkillLimit is the maximum count of provisional Skills in one - task family. Over the limit, a new provisional Skill waits for a member. - When it is not set, no limit applies. + The developer sets the maximum number of provisional Skills in one category. The range is 1 to + 1000. A new Skill waits for a member when the count is over the limit. If omitted, no limit + applies. """ - retention_days: typing.Optional[int] = None + retention_days: typing.Optional[int] = pydantic.Field(default=None) + """ + The developer sets the age-based cleanup period for eligible proposal sets. The range is 1 to + 3650 days. If omitted, the setting does not enable age-based cleanup. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_page.py b/src/zep_cloud/types/agent_page.py index 939d8fc6..39e4313b 100644 --- a/src/zep_cloud/types/agent_page.py +++ b/src/zep_cloud/types/agent_page.py @@ -10,7 +10,7 @@ class AgentPage(UniversalBaseModel): items: typing.Optional[typing.List[Agent]] = pydantic.Field(default=None) """ - The Agents on this page. + The service returns the Agents on this page. """ next_cursor: typing.Optional[str] = pydantic.Field(default=None) diff --git a/src/zep_cloud/types/agent_skill.py b/src/zep_cloud/types/agent_skill.py index fb8b61d5..5c16fe78 100644 --- a/src/zep_cloud/types/agent_skill.py +++ b/src/zep_cloud/types/agent_skill.py @@ -9,20 +9,69 @@ class AgentSkill(UniversalBaseModel): - agent_versions: typing.Optional[typing.List[str]] = None - created_at: typing.Optional[str] = None - current_version: typing.Optional[int] = None - kind: typing.Optional[str] = None - package_name: typing.Optional[str] = None - searchable: typing.Optional[bool] = None - skill_id: typing.Optional[str] = None - status: typing.Optional[str] = None - task_family: typing.Optional[str] = None - unavailable_reason: typing.Optional[str] = None - updated_at: typing.Optional[str] = None + agent_versions: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns Agent versions that can use the Skill. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + current_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the current Skill version number. + """ + + kind: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Skill kind. + """ + + package_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the stable package name of the Skill. + """ + + searchable: typing.Optional[bool] = pydantic.Field(default=None) + """ + The service returns whether search can return this Skill. + """ + + skill_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the stable developer-facing ID of the Skill, when set. + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the lifecycle status. + """ + + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-family slug. + """ + + unavailable_reason: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns why the Skill is unavailable to this Agent. + """ + + updated_at: typing.Optional[str] = pydantic.Field(default=None) + """ + the time that Zep last updated this resource. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None + """ + The service returns the UUID that identifies this resource. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_admission_decision.py b/src/zep_cloud/types/agent_skill_admission_decision.py index 7cd21340..86604a47 100644 --- a/src/zep_cloud/types/agent_skill_admission_decision.py +++ b/src/zep_cloud/types/agent_skill_admission_decision.py @@ -7,12 +7,35 @@ class AgentSkillAdmissionDecision(UniversalBaseModel): - created_at: typing.Optional[str] = None - decision: typing.Optional[str] = None - mode: typing.Optional[str] = None - reason_code: typing.Optional[str] = None - skill_version: typing.Optional[int] = None - supporting_attempt_families: typing.Optional[int] = None + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + decision: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the decision for this operation. + """ + + mode: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns publication policy mode. + """ + + reason_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the code that explains this result. + """ + + skill_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the version number of the Skill. + """ + + supporting_attempt_families: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the count of distinct attempt families that support admission. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_candidate.py b/src/zep_cloud/types/agent_skill_candidate.py index 59aece17..92eb4b4d 100644 --- a/src/zep_cloud/types/agent_skill_candidate.py +++ b/src/zep_cloud/types/agent_skill_candidate.py @@ -11,21 +11,75 @@ class AgentSkillCandidate(UniversalBaseModel): - agent_versions: typing.Optional[typing.List[str]] = None - base_versions: typing.Optional[typing.List[AgentSkillCandidateBaseVersion]] = None - confidence: typing.Optional[float] = None - decision: typing.Optional[str] = None - description: typing.Optional[str] = None - do_not_use_when: typing.Optional[typing.List[str]] = None - evidence: typing.Optional[typing.List[AgentSkillCandidateEvidence]] = None - kind: typing.Optional[str] = None - markdown: typing.Optional[str] = None - name: typing.Optional[str] = None - package_name: typing.Optional[str] = None - task_family: typing.Optional[str] = None + agent_versions: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns Agent versions that can use the Skill. + """ + + base_versions: typing.Optional[typing.List[AgentSkillCandidateBaseVersion]] = pydantic.Field(default=None) + """ + The service returns Skill versions used as the split-plan base. + """ + + confidence: typing.Optional[float] = pydantic.Field(default=None) + """ + The service returns classifier confidence score. + """ + + decision: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the candidate operation. Valid values are add, patch, + and retire. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the resource description. + """ + + do_not_use_when: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns situations in which the Skill must not be used. + """ + + evidence: typing.Optional[typing.List[AgentSkillCandidateEvidence]] = pydantic.Field(default=None) + """ + The service returns evidence linked to this result. + """ + + kind: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Skill kind. + """ + + markdown: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Skill content in Markdown. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the display name. + """ + + package_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the stable package name of the Skill. + """ + + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-family slug. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None + """ + The service returns the UUID that identifies this resource. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_candidate_base_version.py b/src/zep_cloud/types/agent_skill_candidate_base_version.py index c07535c4..2072ff6d 100644 --- a/src/zep_cloud/types/agent_skill_candidate_base_version.py +++ b/src/zep_cloud/types/agent_skill_candidate_base_version.py @@ -7,13 +7,40 @@ class AgentSkillCandidateBaseVersion(UniversalBaseModel): - agent_versions: typing.Optional[typing.List[str]] = None - description: typing.Optional[str] = None - do_not_use_when: typing.Optional[typing.List[str]] = None - markdown: typing.Optional[str] = None - name: typing.Optional[str] = None - skill_uuid: typing.Optional[str] = None - version: typing.Optional[int] = None + agent_versions: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns Agent versions that can use the Skill. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the resource description. + """ + + do_not_use_when: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns situations in which the Skill must not be used. + """ + + markdown: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Skill content in Markdown. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the display name. + """ + + skill_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the Skill. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the Skill version number. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_candidate_evaluation.py b/src/zep_cloud/types/agent_skill_candidate_evaluation.py index 994223ae..0c96f916 100644 --- a/src/zep_cloud/types/agent_skill_candidate_evaluation.py +++ b/src/zep_cloud/types/agent_skill_candidate_evaluation.py @@ -9,20 +9,69 @@ class AgentSkillCandidateEvaluation(UniversalBaseModel): - candidate_uuid: typing.Optional[str] = None - controlled_test: typing.Optional[bool] = None - created_at: typing.Optional[str] = None - environment: typing.Optional[str] = None - evaluated_by: typing.Optional[str] = None - evaluator_version: typing.Optional[str] = None - evidence_reference: typing.Optional[str] = None - metrics: typing.Optional[typing.Dict[str, float]] = None - review_uuid: typing.Optional[str] = None - revision: typing.Optional[int] = None + candidate_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the candidate that this evaluation covers. + """ + + controlled_test: typing.Optional[bool] = pydantic.Field(default=None) + """ + The service reports whether a controlled test produced the result. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + environment: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the environment used for this evaluation. + """ + + evaluated_by: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the evaluation source. Valid values are customer, tool, offline_corpus, and policy. + """ + + evaluator_version: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the version of the evaluation rule. + """ + + evidence_reference: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the link to supporting evidence, when one exists. + """ + + metrics: typing.Optional[typing.Dict[str, float]] = pydantic.Field(default=None) + """ + The service returns evaluation metrics. + """ + + review_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the review that produced this evaluation. + """ + + revision: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the current revision number. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None - verdict: typing.Optional[str] = None + """ + The service returns the UUID that identifies this resource. + """ + + verdict: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the evaluation verdict. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_candidate_evidence.py b/src/zep_cloud/types/agent_skill_candidate_evidence.py index 75e90d34..d1c2db63 100644 --- a/src/zep_cloud/types/agent_skill_candidate_evidence.py +++ b/src/zep_cloud/types/agent_skill_candidate_evidence.py @@ -9,15 +9,39 @@ class AgentSkillCandidateEvidence(UniversalBaseModel): imported_provider: typing.Optional[str] = pydantic.Field(default=None) """ - ImportedProvider is the provider of the source import, when this Trace was imported. + The service returns the provider of the source import, when this Trace was imported. """ - occurred_at: typing.Optional[str] = None - outcome: typing.Optional[str] = None - polarity: typing.Optional[str] = None - source_kind: typing.Optional[str] = None - trace_uuid: typing.Optional[str] = None - verification: typing.Optional[str] = None + occurred_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when the source event occurred. + """ + + outcome: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task outcome. + """ + + polarity: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the evidence stance. + """ + + source_kind: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the evidence source type. Valid values are trace, + trace_event, trace_summary, and skill_version. + """ + + trace_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the source Trace. + """ + + verification: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns how the outcome was verified. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_candidate_review.py b/src/zep_cloud/types/agent_skill_candidate_review.py index 09371977..05b71c52 100644 --- a/src/zep_cloud/types/agent_skill_candidate_review.py +++ b/src/zep_cloud/types/agent_skill_candidate_review.py @@ -11,23 +11,64 @@ class AgentSkillCandidateReview(UniversalBaseModel): - candidate_count: typing.Optional[int] = None - candidates: typing.Optional[typing.List[AgentSkillCandidate]] = None - created_at: typing.Optional[str] = None + candidate_count: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the number of related resources. + """ + + candidates: typing.Optional[typing.List[AgentSkillCandidate]] = pydantic.Field(default=None) + """ + The service returns candidate Skills. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + import_review_required: typing.Optional[bool] = pydantic.Field(default=None) """ ImportReviewRequired reports whether any evidence import requires approval. """ - reason_code: typing.Optional[str] = None - results: typing.Optional[typing.List[AgentSkillCandidateReviewResult]] = None - reviewed_at: typing.Optional[str] = None - revision: typing.Optional[int] = None - status: typing.Optional[str] = None - task_family: typing.Optional[str] = None + reason_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the code that explains this result. + """ + + results: typing.Optional[typing.List[AgentSkillCandidateReviewResult]] = pydantic.Field(default=None) + """ + The service returns evaluation results. + """ + + reviewed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when the review occurred. + """ + + revision: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the current revision number. + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the lifecycle status. + """ + + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-family slug. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None + """ + The service returns the UUID that identifies this resource. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_candidate_review_result.py b/src/zep_cloud/types/agent_skill_candidate_review_result.py index 683addc3..a28a1134 100644 --- a/src/zep_cloud/types/agent_skill_candidate_review_result.py +++ b/src/zep_cloud/types/agent_skill_candidate_review_result.py @@ -10,13 +10,34 @@ class AgentSkillCandidateReviewResult(UniversalBaseModel): - base_versions: typing.Optional[typing.List[AgentSkillCandidateBaseVersion]] = None - candidate_uuids: typing.Optional[typing.List[str]] = None - decision: typing.Optional[str] = None - target_skill_uuids: typing.Optional[typing.List[str]] = None + base_versions: typing.Optional[typing.List[AgentSkillCandidateBaseVersion]] = pydantic.Field(default=None) + """ + The service returns Skill versions used as the split-plan base. + """ + + candidate_uuids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns UUIDs of the candidate Skills in this plan. + """ + + decision: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Curator decision for this review result. Valid values are add, patch, merge, split, supersede, contradict, retire, reject, and no_change. + """ + + target_skill_uuids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns UUIDs of the Skills that this plan can update. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None + """ + The service returns the UUID that identifies this resource. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_candidate_review_summary.py b/src/zep_cloud/types/agent_skill_candidate_review_summary.py index e537a18d..66d59c64 100644 --- a/src/zep_cloud/types/agent_skill_candidate_review_summary.py +++ b/src/zep_cloud/types/agent_skill_candidate_review_summary.py @@ -9,16 +9,49 @@ class AgentSkillCandidateReviewSummary(UniversalBaseModel): - candidate_count: typing.Optional[int] = None - created_at: typing.Optional[str] = None - reason_code: typing.Optional[str] = None - reviewed_at: typing.Optional[str] = None - revision: typing.Optional[int] = None - status: typing.Optional[str] = None - task_family: typing.Optional[str] = None + candidate_count: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the number of related resources. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + reason_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the code that explains this result. + """ + + reviewed_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when the review occurred. + """ + + revision: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the current revision number. + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the lifecycle status. + """ + + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-family slug. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None + """ + The service returns the UUID that identifies this resource. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_compilation_outcome.py b/src/zep_cloud/types/agent_skill_compilation_outcome.py index afe1d82a..2298f0f7 100644 --- a/src/zep_cloud/types/agent_skill_compilation_outcome.py +++ b/src/zep_cloud/types/agent_skill_compilation_outcome.py @@ -10,28 +10,88 @@ class AgentSkillCompilationOutcome(UniversalBaseModel): - agent_uuid: typing.Optional[str] = None - attempts: typing.Optional[int] = None - candidate_count: typing.Optional[int] = None - compilation_identity: typing.Optional[str] = None - compilation_window_uuid: typing.Optional[str] = None - created_at: typing.Optional[str] = None - decision: typing.Optional[str] = None - proposal_count: typing.Optional[int] = None - reason_text: typing.Optional[str] = None + agent_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service assigns the UUID of the Agent that owns this learning run. + """ + + attempts: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the number of attempts made in the last stage. + """ + + candidate_count: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the number of candidate Skills that the run produced. + """ + + compilation_identity: typing.Optional[str] = pydantic.Field(default=None) + """ + The service assigns the UUID that identifies this idempotent compilation + attempt. + """ + + compilation_window_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service assigns the UUID of the scheduled window when one applies. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep recorded this learning-run outcome. + """ + + decision: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the final result of the learning run. + """ + + proposal_count: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the number of Skill proposals that the run produced. + """ + + reason_text: typing.Optional[str] = pydantic.Field(default=None) + """ + The service explains why the learning run stopped or made no change. + """ + rejected_add_count: typing.Optional[int] = pydantic.Field(default=None) """ - RejectedAddCount is the count of add proposals that the Reflector, - the proposal scanner, or the Curator rejected in this compilation. + The service returns the count of add proposals that the Reflector, the proposal scanner, or + the Curator rejected in this compilation. + """ + + rejection_class: typing.Optional[AgentSkillCompilationOutcomeRejectionClass] = pydantic.Field(default=None) + """ + The service returns why compilation rejected the candidate. Valid values are + no_eligible_traces,reflector_invalid_output,applicability_ungrounded,corroboration_insufficient,scanner_rejected,curator_rejected,curator_attempts_exhausted,prompt_budget_exceeded,provider_error. + """ + + stage: typing.Optional[str] = pydantic.Field(default=None) + """ + The service reports the last stage reached: selection, reflector, scanner, curator, or + admission. + """ + + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the category that this learning run processed. + """ + + trace_count: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the number of eligible Traces that the run processed. """ - rejection_class: typing.Optional[AgentSkillCompilationOutcomeRejectionClass] = None - stage: typing.Optional[str] = None - task_family: typing.Optional[str] = None - trace_count: typing.Optional[int] = None uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the stable identifier for this learning run."), ] = None + """ + The service returns the stable identifier for this learning run. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract.py b/src/zep_cloud/types/agent_skill_contract.py index e9e00575..3fe624eb 100644 --- a/src/zep_cloud/types/agent_skill_contract.py +++ b/src/zep_cloud/types/agent_skill_contract.py @@ -19,31 +19,132 @@ class AgentSkillContract(UniversalBaseModel): - aliases: typing.Optional[typing.List[str]] = None - applicability: typing.Optional[AgentSkillContractApplicability] = None - citations: typing.Optional[typing.List[str]] = None - confidence: typing.Optional[float] = None - contraindications: typing.Optional[typing.List[AgentSkillContractText]] = None - customer_sections: typing.Optional[typing.List[AgentSkillContractSection]] = None - dependencies: typing.Optional[typing.List[AgentSkillContractDependency]] = None - description: typing.Optional[str] = None - environments: typing.Optional[typing.List[AgentSkillContractResource]] = None - evidence: typing.Optional[typing.List[AgentSkillContractEvidence]] = None - failures: typing.Optional[typing.List[AgentSkillContractFailure]] = None - invocation: typing.Optional[AgentSkillContractInvocation] = None - kind: typing.Optional[SkillKind] = None - name: typing.Optional[str] = None - origin: typing.Optional[AgentSkillContractOrigin] = None - outputs: typing.Optional[typing.List[AgentSkillContractText]] = None - package_name: typing.Optional[str] = None - preconditions: typing.Optional[typing.List[AgentSkillContractText]] = None - procedure: typing.Optional[typing.List[AgentSkillContractStep]] = None - relations: typing.Optional[typing.List[AgentSkillContractRelation]] = None - schema_version: typing.Optional[str] = None - success_criteria: typing.Optional[typing.List[AgentSkillContractText]] = None - task_family: typing.Optional[str] = None - termination_conditions: typing.Optional[typing.List[AgentSkillContractText]] = None - tools: typing.Optional[typing.List[AgentSkillContractResource]] = None + aliases: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns alternate names for the resource. + """ + + applicability: typing.Optional[AgentSkillContractApplicability] = pydantic.Field(default=None) + """ + The service returns the Agent versions and models that can use the Skill. + """ + + citations: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns evidence identifiers that support the contract. + """ + + confidence: typing.Optional[float] = pydantic.Field(default=None) + """ + The service returns the confidence score for the contract, from 0 to 1. + """ + + contraindications: typing.Optional[typing.List[AgentSkillContractText]] = pydantic.Field(default=None) + """ + The service returns situations in which the Skill must not be used. + """ + + customer_sections: typing.Optional[typing.List[AgentSkillContractSection]] = pydantic.Field(default=None) + """ + The service returns extra sections that a customer added to the Skill. + """ + + dependencies: typing.Optional[typing.List[AgentSkillContractDependency]] = pydantic.Field(default=None) + """ + The service returns packages that the Skill requires. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the resource description. + """ + + environments: typing.Optional[typing.List[AgentSkillContractResource]] = pydantic.Field(default=None) + """ + The service returns environment names used by the Skill. + """ + + evidence: typing.Optional[typing.List[AgentSkillContractEvidence]] = pydantic.Field(default=None) + """ + The service returns the evidence records cited by the contract. + """ + + failures: typing.Optional[typing.List[AgentSkillContractFailure]] = pydantic.Field(default=None) + """ + The service returns failure conditions and recovery steps. + """ + + invocation: typing.Optional[AgentSkillContractInvocation] = pydantic.Field(default=None) + """ + The service returns when the Skill should be used. + """ + + kind: typing.Optional[SkillKind] = pydantic.Field(default=None) + """ + The service returns the Skill kind. Valid values are principle, procedure, workflow, failure_mode, + recovery, constraint. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the display name. + """ + + origin: typing.Optional[AgentSkillContractOrigin] = pydantic.Field(default=None) + """ + The service returns how the Skill contract was created. Valid values are + evidence_derived and customer_authored. + """ + + outputs: typing.Optional[typing.List[AgentSkillContractText]] = pydantic.Field(default=None) + """ + The service returns results that the Skill produces. + """ + + package_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the stable package name of the Skill. + """ + + preconditions: typing.Optional[typing.List[AgentSkillContractText]] = pydantic.Field(default=None) + """ + The service returns conditions that must be true before use. + """ + + procedure: typing.Optional[typing.List[AgentSkillContractStep]] = pydantic.Field(default=None) + """ + The service returns ordered procedure steps. + """ + + relations: typing.Optional[typing.List[AgentSkillContractRelation]] = pydantic.Field(default=None) + """ + The service returns links from this Skill to other Skills. + """ + + schema_version: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the contract schema version. The current value is v1. + """ + + success_criteria: typing.Optional[typing.List[AgentSkillContractText]] = pydantic.Field(default=None) + """ + The service returns conditions that show when the Skill task is complete. + """ + + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-family slug. + """ + + termination_conditions: typing.Optional[typing.List[AgentSkillContractText]] = pydantic.Field(default=None) + """ + The service returns conditions that show when the Skill's work is complete. + """ + + tools: typing.Optional[typing.List[AgentSkillContractResource]] = pydantic.Field(default=None) + """ + The service returns tool names used by the Skill. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_applicability.py b/src/zep_cloud/types/agent_skill_contract_applicability.py index bb39c4f8..1ae24980 100644 --- a/src/zep_cloud/types/agent_skill_contract_applicability.py +++ b/src/zep_cloud/types/agent_skill_contract_applicability.py @@ -8,9 +8,20 @@ class AgentSkillContractApplicability(UniversalBaseModel): - agent_versions: typing.Optional[typing.List[str]] = None - citations: typing.Optional[typing.List[str]] = None - models: typing.Optional[typing.List[AgentSkillContractVersionConstraint]] = None + agent_versions: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns Agent versions that can use the Skill. + """ + + citations: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns evidence identifiers that support this applicability. + """ + + models: typing.Optional[typing.List[AgentSkillContractVersionConstraint]] = pydantic.Field(default=None) + """ + The service returns model names and their allowed versions. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_dependency.py b/src/zep_cloud/types/agent_skill_contract_dependency.py index 08af7fbc..95deceda 100644 --- a/src/zep_cloud/types/agent_skill_contract_dependency.py +++ b/src/zep_cloud/types/agent_skill_contract_dependency.py @@ -7,8 +7,15 @@ class AgentSkillContractDependency(UniversalBaseModel): - package_name: typing.Optional[str] = None - version_constraint: typing.Optional[str] = None + package_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the stable package name of the Skill. + """ + + version_constraint: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the allowed versions for this Skill. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_evidence.py b/src/zep_cloud/types/agent_skill_contract_evidence.py index ccb2d05d..110ffb91 100644 --- a/src/zep_cloud/types/agent_skill_contract_evidence.py +++ b/src/zep_cloud/types/agent_skill_contract_evidence.py @@ -9,12 +9,42 @@ class AgentSkillContractEvidence(UniversalBaseModel): - attempt_family_id: typing.Optional[str] = None - id: typing.Optional[str] = None - polarity: typing.Optional[AgentSkillContractEvidencePolarity] = None - source_id: typing.Optional[str] = None - source_kind: typing.Optional[AgentSkillContractEvidenceSourceKind] = None - trajectory_id: typing.Optional[str] = None + attempt_family_id: typing.Optional[str] = pydantic.Field(default=None) + """ + AttemptFamilyID is the ID of the attempt family that supplied this + evidence. The service returns this value. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + ID is the citation identifier that the service returns. It is unique in + the evidence list. + """ + + polarity: typing.Optional[AgentSkillContractEvidencePolarity] = pydantic.Field(default=None) + """ + Polarity states whether the evidence supports, contradicts, or does not + affect the contract claim. The service returns supporting, contradicting, + or neutral. + """ + + source_id: typing.Optional[str] = pydantic.Field(default=None) + """ + SourceID is the ID of the Trace, event, or summary version named by + source_kind. The service returns this value. + """ + + source_kind: typing.Optional[AgentSkillContractEvidenceSourceKind] = pydantic.Field(default=None) + """ + SourceKind is the source type. The service returns trace, event, or + summary. + """ + + trace_id: typing.Optional[str] = pydantic.Field(default=None) + """ + TraceID is the ID of the Trace that supplied this evidence. The service + returns this value. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_evidence_source_kind.py b/src/zep_cloud/types/agent_skill_contract_evidence_source_kind.py index 314cce3f..b8ce1b51 100644 --- a/src/zep_cloud/types/agent_skill_contract_evidence_source_kind.py +++ b/src/zep_cloud/types/agent_skill_contract_evidence_source_kind.py @@ -2,4 +2,4 @@ import typing -AgentSkillContractEvidenceSourceKind = typing.Union[typing.Literal["trajectory", "event", "summary"], typing.Any] +AgentSkillContractEvidenceSourceKind = typing.Union[typing.Literal["trace", "event", "summary"], typing.Any] diff --git a/src/zep_cloud/types/agent_skill_contract_failure.py b/src/zep_cloud/types/agent_skill_contract_failure.py index 5dcdec0f..9a33a6c8 100644 --- a/src/zep_cloud/types/agent_skill_contract_failure.py +++ b/src/zep_cloud/types/agent_skill_contract_failure.py @@ -8,8 +8,15 @@ class AgentSkillContractFailure(UniversalBaseModel): - condition: typing.Optional[AgentSkillContractText] = None - recovery: typing.Optional[typing.List[AgentSkillContractText]] = None + condition: typing.Optional[AgentSkillContractText] = pydantic.Field(default=None) + """ + The service returns the failure condition. + """ + + recovery: typing.Optional[typing.List[AgentSkillContractText]] = pydantic.Field(default=None) + """ + The service returns actions that recover from this failure. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_invocation.py b/src/zep_cloud/types/agent_skill_contract_invocation.py index 8818bc1a..13703a7d 100644 --- a/src/zep_cloud/types/agent_skill_contract_invocation.py +++ b/src/zep_cloud/types/agent_skill_contract_invocation.py @@ -8,8 +8,15 @@ class AgentSkillContractInvocation(UniversalBaseModel): - conditions: typing.Optional[typing.List[AgentSkillContractText]] = None - summary: typing.Optional[AgentSkillContractText] = None + conditions: typing.Optional[typing.List[AgentSkillContractText]] = pydantic.Field(default=None) + """ + The service returns conditions that must hold before the Skill is used. + """ + + summary: typing.Optional[AgentSkillContractText] = pydantic.Field(default=None) + """ + The service returns a summary of when to use the Skill. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_relation.py b/src/zep_cloud/types/agent_skill_contract_relation.py index 2feee0d8..e792669d 100644 --- a/src/zep_cloud/types/agent_skill_contract_relation.py +++ b/src/zep_cloud/types/agent_skill_contract_relation.py @@ -8,10 +8,26 @@ class AgentSkillContractRelation(UniversalBaseModel): - citations: typing.Optional[typing.List[str]] = None - kind: typing.Optional[AgentSkillContractRelationKind] = None - target_package_name: typing.Optional[str] = None - version_constraint: typing.Optional[str] = None + citations: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns evidence identifiers that support this relation. + """ + + kind: typing.Optional[AgentSkillContractRelationKind] = pydantic.Field(default=None) + """ + The service returns the relation type. Valid values are composes, requires, + conflicts_with, supersedes, and related. + """ + + target_package_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the package name of the related Skill. + """ + + version_constraint: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the allowed versions for the related Skill. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_resource.py b/src/zep_cloud/types/agent_skill_contract_resource.py index 3601a823..fd1308e1 100644 --- a/src/zep_cloud/types/agent_skill_contract_resource.py +++ b/src/zep_cloud/types/agent_skill_contract_resource.py @@ -7,10 +7,25 @@ class AgentSkillContractResource(UniversalBaseModel): - aliases: typing.Optional[typing.List[str]] = None - citations: typing.Optional[typing.List[str]] = None - name: typing.Optional[str] = None - version_constraint: typing.Optional[str] = None + aliases: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns alternate names for this tool or environment. + """ + + citations: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns evidence identifiers that support this resource. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the resource name stored in the contract. + """ + + version_constraint: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the allowed versions for this resource. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_section.py b/src/zep_cloud/types/agent_skill_contract_section.py index 95f0c7b8..f0a632db 100644 --- a/src/zep_cloud/types/agent_skill_contract_section.py +++ b/src/zep_cloud/types/agent_skill_contract_section.py @@ -7,10 +7,25 @@ class AgentSkillContractSection(UniversalBaseModel): - heading: typing.Optional[str] = None - markdown: typing.Optional[str] = None - schema_version: typing.Optional[str] = None - section_id: typing.Optional[str] = None + heading: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns section heading. + """ + + markdown: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Skill content in Markdown. + """ + + schema_version: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the section schema version. The current value is v1. + """ + + section_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the stable ID of this customer-authored section. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_step.py b/src/zep_cloud/types/agent_skill_contract_step.py index cdeb0f8b..26ed0775 100644 --- a/src/zep_cloud/types/agent_skill_contract_step.py +++ b/src/zep_cloud/types/agent_skill_contract_step.py @@ -8,9 +8,20 @@ class AgentSkillContractStep(UniversalBaseModel): - decision: typing.Optional[AgentSkillContractText] = None - expected_observations: typing.Optional[typing.List[AgentSkillContractText]] = None - instruction: typing.Optional[AgentSkillContractText] = None + decision: typing.Optional[AgentSkillContractText] = pydantic.Field(default=None) + """ + The service returns the decision for this operation. + """ + + expected_observations: typing.Optional[typing.List[AgentSkillContractText]] = pydantic.Field(default=None) + """ + The service returns results to look for after this procedure step. + """ + + instruction: typing.Optional[AgentSkillContractText] = pydantic.Field(default=None) + """ + The service returns the action for this procedure step. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_text.py b/src/zep_cloud/types/agent_skill_contract_text.py index 2a9b94b3..41105205 100644 --- a/src/zep_cloud/types/agent_skill_contract_text.py +++ b/src/zep_cloud/types/agent_skill_contract_text.py @@ -7,8 +7,15 @@ class AgentSkillContractText(UniversalBaseModel): - citations: typing.Optional[typing.List[str]] = None - text: typing.Optional[str] = None + citations: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns evidence identifiers that support this text. + """ + + text: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns text that a person can read. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_contract_version_constraint.py b/src/zep_cloud/types/agent_skill_contract_version_constraint.py index 13d402f1..a7b6fed4 100644 --- a/src/zep_cloud/types/agent_skill_contract_version_constraint.py +++ b/src/zep_cloud/types/agent_skill_contract_version_constraint.py @@ -7,8 +7,15 @@ class AgentSkillContractVersionConstraint(UniversalBaseModel): - name: typing.Optional[str] = None - version_constraint: typing.Optional[str] = None + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Agent model or deployment name. + """ + + version_constraint: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the allowed versions for this model or deployment. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_evaluation.py b/src/zep_cloud/types/agent_skill_evaluation.py index 800a361b..e03caf17 100644 --- a/src/zep_cloud/types/agent_skill_evaluation.py +++ b/src/zep_cloud/types/agent_skill_evaluation.py @@ -9,21 +9,74 @@ class AgentSkillEvaluation(UniversalBaseModel): - controlled_test: typing.Optional[bool] = None - created_at: typing.Optional[str] = None - environment: typing.Optional[str] = None - evaluated_by: typing.Optional[str] = None - evaluator_version: typing.Optional[str] = None - evidence_reference: typing.Optional[str] = None - metrics: typing.Optional[typing.Dict[str, float]] = None - skill_uuid: typing.Optional[str] = None - skill_version: typing.Optional[int] = None - trace_uuid: typing.Optional[str] = None - use_uuid: typing.Optional[str] = None + controlled_test: typing.Optional[bool] = pydantic.Field(default=None) + """ + The developer sets this to true when a controlled test produced the result. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + environment: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the environment used for this evaluation. + """ + + evaluated_by: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the evaluation source. Valid values are customer, tool, offline_corpus, and policy. + """ + + evaluator_version: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the version of the evaluation rule. + """ + + evidence_reference: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the link to supporting evidence, when one exists. + """ + + metrics: typing.Optional[typing.Dict[str, float]] = pydantic.Field(default=None) + """ + The service returns evaluation metrics. + """ + + skill_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the Skill. + """ + + skill_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the version number of the Skill. + """ + + trace_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the source Trace. + """ + + use_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the recorded Skill use, when linked. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None - verdict: typing.Optional[str] = None + """ + The service returns the UUID that identifies this resource. + """ + + verdict: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the evaluation verdict. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_evidence.py b/src/zep_cloud/types/agent_skill_evidence.py index 104abe51..7d8eb18a 100644 --- a/src/zep_cloud/types/agent_skill_evidence.py +++ b/src/zep_cloud/types/agent_skill_evidence.py @@ -7,15 +7,52 @@ class AgentSkillEvidence(UniversalBaseModel): - assertion_uuid: typing.Optional[str] = None - created_at: typing.Optional[str] = None - occurred_at: typing.Optional[str] = None - polarity: typing.Optional[str] = None - source_kind: typing.Optional[str] = None - summary_version_uuid: typing.Optional[str] = None - trace_event_uuid: typing.Optional[str] = None - trace_uuid: typing.Optional[str] = None - verification: typing.Optional[str] = None + assertion_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the verification assertion linked to this evidence. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + occurred_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when the source event occurred. + """ + + polarity: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the evidence stance. + """ + + source_kind: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the evidence source type. Valid values are trace, + trace_event, trace_summary, and skill_version. + """ + + summary_version_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns summary version linked to this evidence. + """ + + trace_event_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns trace event linked to this evidence. + """ + + trace_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the source Trace. + """ + + verification: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the verification source. Valid values are none, agent, + tool, customer, and external. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_relationship.py b/src/zep_cloud/types/agent_skill_relationship.py index 1039f792..8fd1b67a 100644 --- a/src/zep_cloud/types/agent_skill_relationship.py +++ b/src/zep_cloud/types/agent_skill_relationship.py @@ -7,21 +7,80 @@ class AgentSkillRelationship(UniversalBaseModel): - application_state: typing.Optional[str] = None - kind: typing.Optional[str] = None - related_package_name: typing.Optional[str] = None - related_skill_kind: typing.Optional[str] = None - related_skill_name: typing.Optional[str] = None - related_skill_task_family: typing.Optional[str] = None - related_skill_uuid: typing.Optional[str] = None - related_skill_version: typing.Optional[int] = None - related_version_constraint: typing.Optional[str] = None - resource_name: typing.Optional[str] = None - resource_version_constraint: typing.Optional[str] = None - trace_outcome: typing.Optional[str] = None - trace_task_family: typing.Optional[str] = None - trace_uuid: typing.Optional[str] = None - trace_verification: typing.Optional[str] = None + application_state: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns whether this Skill is applied to the Agent. + """ + + kind: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Skill kind. + """ + + related_package_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the package name of the related Skill. + """ + + related_skill_kind: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the kind of the related Skill. + """ + + related_skill_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the display name of the related Skill. + """ + + related_skill_task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-family slug of the related Skill. + """ + + related_skill_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the related Skill, when one is linked. + """ + + related_skill_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the version number of the related Skill. + """ + + related_version_constraint: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the version constraint for the related Skill. + """ + + resource_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the name of the related tool or environment. + """ + + resource_version_constraint: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the allowed versions of the related resource. + """ + + trace_outcome: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the outcome of the source Trace. + """ + + trace_task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task family of the source Trace. + """ + + trace_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the source Trace. + """ + + trace_verification: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the verification state of the source Trace. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_search_hit.py b/src/zep_cloud/types/agent_skill_search_hit.py index 3c31b1f3..36df51d8 100644 --- a/src/zep_cloud/types/agent_skill_search_hit.py +++ b/src/zep_cloud/types/agent_skill_search_hit.py @@ -10,11 +10,31 @@ class AgentSkillSearchHit(UniversalBaseModel): - agent_versions: typing.Optional[typing.List[str]] = None - description: typing.Optional[str] = None - environments: typing.Optional[typing.List[str]] = None - kind: typing.Optional[str] = None - markdown: typing.Optional[str] = None + agent_versions: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns Agent versions that can use this Skill. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the resource description. + """ + + environments: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns environment names used by the Skill. + """ + + kind: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Skill kind. + """ + + markdown: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the rendered Skill instructions in Markdown. + """ + maturity: typing.Optional[AgentSkillSearchHitMaturity] = pydantic.Field(default=None) """ Maturity is the trust tier of the Skill: provisional (one source attempt @@ -22,18 +42,42 @@ class AgentSkillSearchHit(UniversalBaseModel): more from verified applications), or authored (no compiled source). """ - name: typing.Optional[str] = None - package_name: typing.Optional[str] = None - self_contained: typing.Optional[bool] = None - skill_id: typing.Optional[str] = None + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the display name. + """ + + package_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the stable package name of the Skill. + """ + + self_contained: typing.Optional[bool] = pydantic.Field(default=None) + """ + The service reports whether this Skill can run without external context. + """ + + skill_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the stable developer-facing ID of the Skill, when set. + """ + source_attempt_families: typing.Optional[int] = pydantic.Field(default=None) """ SourceAttemptFamilies is the count of distinct, successful, verified attempt families that support the current version. """ - task_family: typing.Optional[str] = None - tools: typing.Optional[typing.List[str]] = None + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-family slug. + """ + + tools: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns tool names used by the Skill. + """ + trust: typing.Optional[float] = pydantic.Field(default=None) """ Trust is the lower bound of the 95% Wilson score interval for the @@ -42,15 +86,24 @@ class AgentSkillSearchHit(UniversalBaseModel): """ uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None + """ + The service returns the UUID that identifies this resource. + """ + verified_applications: typing.Optional[int] = pydantic.Field(default=None) """ - VerifiedApplications is the count of strongly verified applications - that end in success or failure. + The service returns the count of strongly verified applications that end in success or + failure. """ - version: typing.Optional[int] = None + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the Skill version number. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_search_response.py b/src/zep_cloud/types/agent_skill_search_response.py index ccec48a5..967934fd 100644 --- a/src/zep_cloud/types/agent_skill_search_response.py +++ b/src/zep_cloud/types/agent_skill_search_response.py @@ -8,9 +8,20 @@ class AgentSkillSearchResponse(UniversalBaseModel): - items: typing.Optional[typing.List[AgentSkillSearchHit]] = None - next_cursor: typing.Optional[str] = None - search_id: typing.Optional[str] = None + items: typing.Optional[typing.List[AgentSkillSearchHit]] = pydantic.Field(default=None) + """ + The service returns the items in this page. + """ + + next_cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the cursor for the next page, when one exists. + """ + + search_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the signed token for this result set. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_use.py b/src/zep_cloud/types/agent_skill_use.py index 57019f38..93e29749 100644 --- a/src/zep_cloud/types/agent_skill_use.py +++ b/src/zep_cloud/types/agent_skill_use.py @@ -10,17 +10,54 @@ class AgentSkillUse(UniversalBaseModel): - agent_version: typing.Optional[str] = None - created_at: typing.Optional[str] = None - outcome: typing.Optional[AgentSkillUseOutcome] = None - reason_code: typing.Optional[str] = None - skill_uuid: typing.Optional[str] = None - skill_version: typing.Optional[int] = None - trace_uuid: typing.Optional[str] = None - usage: typing.Optional[str] = None + agent_version: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Agent version that used this Skill. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + outcome: typing.Optional[AgentSkillUseOutcome] = pydantic.Field(default=None) + """ + The service returns the task outcome. + """ + + reason_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the code that explains this result. + """ + + skill_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the Skill. + """ + + skill_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the version number of the Skill. + """ + + trace_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the source Trace. + """ + + usage: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns how the Skill was used. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None + """ + The service returns the UUID that identifies this resource. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_use_outcome.py b/src/zep_cloud/types/agent_skill_use_outcome.py index a053dc73..5a754a2c 100644 --- a/src/zep_cloud/types/agent_skill_use_outcome.py +++ b/src/zep_cloud/types/agent_skill_use_outcome.py @@ -9,15 +9,45 @@ class AgentSkillUseOutcome(UniversalBaseModel): - assertion_uuid: typing.Optional[str] = None - created_at: typing.Optional[str] = None - outcome: typing.Optional[str] = None - trace_uuid: typing.Optional[str] = None - use_uuid: typing.Optional[str] = None + assertion_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the verification assertion linked to this evidence. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + outcome: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task outcome. + """ + + trace_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the source Trace. + """ + + use_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the recorded Skill use. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None - verification: typing.Optional[str] = None + """ + The service returns the UUID that identifies this resource. + """ + + verification: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the verification source. Valid values are none, agent, + tool, customer, and external. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_version.py b/src/zep_cloud/types/agent_skill_version.py index 9cfae13f..3c1ad493 100644 --- a/src/zep_cloud/types/agent_skill_version.py +++ b/src/zep_cloud/types/agent_skill_version.py @@ -9,17 +9,36 @@ class AgentSkillVersion(UniversalBaseModel): - contract: typing.Optional[AgentSkillContract] = None - created_at: typing.Optional[str] = None - definition: typing.Optional[SkillDefinition] = None + contract: typing.Optional[AgentSkillContract] = pydantic.Field(default=None) + """ + The service returns skill contract. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + definition: typing.Optional[SkillDefinition] = pydantic.Field(default=None) + """ + The service returns the customer-authored Skill definition. + """ + markdown: typing.Optional[str] = pydantic.Field(default=None) """ Markdown is the agent view of the Skill unless the request selects `markdown_format=full`. """ - self_contained: typing.Optional[bool] = None - version: typing.Optional[int] = None + self_contained: typing.Optional[bool] = pydantic.Field(default=None) + """ + The service reports whether the Skill can run without external context. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the Skill version number. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_skill_version_comparison.py b/src/zep_cloud/types/agent_skill_version_comparison.py index 5bb389d1..1212714e 100644 --- a/src/zep_cloud/types/agent_skill_version_comparison.py +++ b/src/zep_cloud/types/agent_skill_version_comparison.py @@ -10,11 +10,24 @@ class AgentSkillVersionComparison(UniversalBaseModel): - changed_fields: typing.Optional[typing.List[str]] = None + changed_fields: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service lists fields that changed between these Skill versions. + """ + from_: typing_extensions.Annotated[ - typing.Optional[AgentSkillVersion], FieldMetadata(alias="from"), pydantic.Field(alias="from") + typing.Optional[AgentSkillVersion], + FieldMetadata(alias="from"), + pydantic.Field(alias="from", description="The service returns the Skill version before the comparison."), ] = None - to: typing.Optional[AgentSkillVersion] = None + """ + The service returns the Skill version before the comparison. + """ + + to: typing.Optional[AgentSkillVersion] = pydantic.Field(default=None) + """ + The service returns the Skill version after the comparison. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_split_plan.py b/src/zep_cloud/types/agent_split_plan.py index bfee69f1..8cc1cd62 100644 --- a/src/zep_cloud/types/agent_split_plan.py +++ b/src/zep_cloud/types/agent_split_plan.py @@ -9,17 +9,40 @@ class AgentSplitPlan(UniversalBaseModel): - authorizes_agent_creation: typing.Optional[bool] = None - authorizes_publication: typing.Optional[bool] = None + authorizes_agent_creation: typing.Optional[bool] = pydantic.Field(default=None) + """ + The service reports whether the plan authorizes Agent creation. + """ + + authorizes_publication: typing.Optional[bool] = pydantic.Field(default=None) + """ + The service reports whether the plan authorizes Skill publication. + """ + creates_resources: typing.Optional[bool] = pydantic.Field(default=None) """ A split plan is not human approval and grants no authority for later commands. """ - destinations: typing.Optional[typing.List[AgentSplitPlanDestination]] = None - rationale: typing.Optional[str] = None - review_acknowledged: typing.Optional[bool] = None - source: typing.Optional[AgentSplitPlanSource] = None + destinations: typing.Optional[typing.List[AgentSplitPlanDestination]] = pydantic.Field(default=None) + """ + The service returns UUIDs of the destination Agents. + """ + + rationale: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the reason for the requested split. + """ + + review_acknowledged: typing.Optional[bool] = pydantic.Field(default=None) + """ + The service reports whether the developer confirmed the review. + """ + + source: typing.Optional[AgentSplitPlanSource] = pydantic.Field(default=None) + """ + The service returns the source Agent and the revision used for this plan. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_split_plan_destination.py b/src/zep_cloud/types/agent_split_plan_destination.py index ea5a2a4d..8cec1325 100644 --- a/src/zep_cloud/types/agent_split_plan_destination.py +++ b/src/zep_cloud/types/agent_split_plan_destination.py @@ -9,8 +9,15 @@ class AgentSplitPlanDestination(UniversalBaseModel): - agent: typing.Optional[CreateAgentRequest] = None - skills: typing.Optional[typing.List[AgentSplitPlanSkillReference]] = None + agent: typing.Optional[CreateAgentRequest] = pydantic.Field(default=None) + """ + The service returns the Agent settings for this destination. + """ + + skills: typing.Optional[typing.List[AgentSplitPlanSkillReference]] = pydantic.Field(default=None) + """ + The service returns the Skills included in this plan. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_split_plan_destination_request.py b/src/zep_cloud/types/agent_split_plan_destination_request.py index d8adbec3..f1070648 100644 --- a/src/zep_cloud/types/agent_split_plan_destination_request.py +++ b/src/zep_cloud/types/agent_split_plan_destination_request.py @@ -9,8 +9,15 @@ class AgentSplitPlanDestinationRequest(UniversalBaseModel): - agent: CreateAgentRequest - skills: typing.List[AgentSplitPlanSkillSelectionRequest] + agent: CreateAgentRequest = pydantic.Field() + """ + The developer supplies the Agent settings for this destination. + """ + + skills: typing.List[AgentSplitPlanSkillSelectionRequest] = pydantic.Field() + """ + The developer lists 1 to 100 Skills to include in this plan. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_split_plan_skill_reference.py b/src/zep_cloud/types/agent_split_plan_skill_reference.py index c5ee19f9..7d8882f7 100644 --- a/src/zep_cloud/types/agent_split_plan_skill_reference.py +++ b/src/zep_cloud/types/agent_split_plan_skill_reference.py @@ -7,12 +7,35 @@ class AgentSplitPlanSkillReference(UniversalBaseModel): - package_name: typing.Optional[str] = None - skill_id: typing.Optional[str] = None - skill_uuid: typing.Optional[str] = None - skill_version_uuid: typing.Optional[str] = None - status: typing.Optional[str] = None - version: typing.Optional[int] = None + package_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the stable package name of the Skill. + """ + + skill_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the stable developer-facing ID of the Skill, when set. + """ + + skill_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the Skill. + """ + + skill_version_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the selected immutable Skill version. + """ + + status: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the Skill's lifecycle status. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the selected Skill version number. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_split_plan_skill_selection_request.py b/src/zep_cloud/types/agent_split_plan_skill_selection_request.py index 024b2129..f81af354 100644 --- a/src/zep_cloud/types/agent_split_plan_skill_selection_request.py +++ b/src/zep_cloud/types/agent_split_plan_skill_selection_request.py @@ -7,9 +7,20 @@ class AgentSplitPlanSkillSelectionRequest(UniversalBaseModel): - skill_uuid: str - skill_version_uuid: str - version: int + skill_uuid: str = pydantic.Field() + """ + The developer supplies the Skill identifier. + """ + + skill_version_uuid: str = pydantic.Field() + """ + The developer selects the immutable Skill version to include. + """ + + version: int = pydantic.Field() + """ + The developer supplies the Skill version number. It must be at least 1. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_split_plan_source.py b/src/zep_cloud/types/agent_split_plan_source.py index 2104f76b..6a07c832 100644 --- a/src/zep_cloud/types/agent_split_plan_source.py +++ b/src/zep_cloud/types/agent_split_plan_source.py @@ -7,8 +7,15 @@ class AgentSplitPlanSource(UniversalBaseModel): - agent_uuid: typing.Optional[str] = None - revision: typing.Optional[int] = None + agent_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the owning Agent. + """ + + revision: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the current revision number. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_task_family_descriptor.py b/src/zep_cloud/types/agent_task_family_descriptor.py index 5cbc00df..d398488a 100644 --- a/src/zep_cloud/types/agent_task_family_descriptor.py +++ b/src/zep_cloud/types/agent_task_family_descriptor.py @@ -11,56 +11,56 @@ class AgentTaskFamilyDescriptor(UniversalBaseModel): agent_uuid: typing.Optional[str] = pydantic.Field(default=None) """ - The owning Agent UUID. + The service returns the owning Agent UUID. """ created_at: typing.Optional[str] = pydantic.Field(default=None) """ - The time the descriptor was created. + The service returns the time the descriptor was created. """ description: typing.Optional[str] = pydantic.Field(default=None) """ - What the family covers. + The service returns what the family covers. """ descriptor_version: typing.Optional[int] = pydantic.Field(default=None) """ - The descriptor version the classifier ran against. + The service returns the descriptor version the classifier ran against. """ distinguishing_tools: typing.Optional[typing.List[str]] = pydantic.Field(default=None) """ - The tools that distinguish this family from the others. + The service returns the tools that distinguish this family from the others. """ not_for: typing.Optional[str] = pydantic.Field(default=None) """ - The most similar goal that does not belong to the family. + The service returns the most similar goal that does not belong to the family. """ slug: typing.Optional[str] = pydantic.Field(default=None) """ - The task-family slug members receive. + The service returns the task-family slug members receive. """ updated_at: typing.Optional[str] = pydantic.Field(default=None) """ - The time the descriptor was last updated. + The service returns the time the descriptor was last updated. """ use_when: typing.Optional[str] = pydantic.Field(default=None) """ - When a Trace belongs to the family. + The service returns when a Trace belongs to the family. """ uuid_: typing_extensions.Annotated[ typing.Optional[str], FieldMetadata(alias="uuid"), - pydantic.Field(alias="uuid", description="The stable descriptor UUID."), + pydantic.Field(alias="uuid", description="The service returns the stable descriptor UUID."), ] = None """ - The stable descriptor UUID. + The service returns the stable descriptor UUID. """ if IS_PYDANTIC_V2: diff --git a/src/zep_cloud/types/agent_task_family_descriptor_page.py b/src/zep_cloud/types/agent_task_family_descriptor_page.py index def0d1a7..da12333f 100644 --- a/src/zep_cloud/types/agent_task_family_descriptor_page.py +++ b/src/zep_cloud/types/agent_task_family_descriptor_page.py @@ -20,7 +20,7 @@ class AgentTaskFamilyDescriptorPage(UniversalBaseModel): total_size: typing.Optional[int] = pydantic.Field(default=None) """ - The total number of discovered task families within the owning Agent. + The service returns the total number of discovered task families within the owning Agent. """ if IS_PYDANTIC_V2: diff --git a/src/zep_cloud/types/agent_trace.py b/src/zep_cloud/types/agent_trace.py index 58dbcd67..2c8d4eab 100644 --- a/src/zep_cloud/types/agent_trace.py +++ b/src/zep_cloud/types/agent_trace.py @@ -22,12 +22,12 @@ class AgentTrace(UniversalBaseModel): agent_uuid: typing.Optional[str] = pydantic.Field(default=None) """ - The owning Agent UUID. + The service returns the owning Agent UUID. """ attempt_family_uuid: typing.Optional[str] = pydantic.Field(default=None) """ - The stable retry-family identity shared with declared child attempts. + The service returns the stable retry-family identity shared by attempts. """ closed_at: typing.Optional[str] = pydantic.Field(default=None) @@ -47,12 +47,13 @@ class AgentTrace(UniversalBaseModel): learn_from: typing.Optional[bool] = pydantic.Field(default=None) """ - Whether eligible evidence may participate in learning. + The service returns whether eligible evidence may participate in learning. """ learn_from_reason: typing.Optional[str] = pydantic.Field(default=None) """ - Why the Trace is not eligible for learning. + The service returns why the Trace is not eligible for learning, when it + is not eligible. """ metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None) @@ -62,22 +63,24 @@ class AgentTrace(UniversalBaseModel): objective: typing.Optional[str] = pydantic.Field(default=None) """ - The task-instance objective captured for this attempt. + The service returns the task-instance objective captured for this attempt. """ outcome: typing.Optional[AgentTraceOutcome] = pydantic.Field(default=None) """ - The caller-owned task outcome. + The service returns the task outcome that the developer recorded. Valid + values are succeeded, failed, partial, abandoned, and unknown. """ parent_trace_uuid: typing.Optional[str] = pydantic.Field(default=None) """ - The parent attempt when this Trace is a retry. + The service returns the parent attempt when this Trace is a retry. """ revision: typing.Optional[int] = pydantic.Field(default=None) """ - The revision required by the next update or lifecycle command. + The service returns the current revision for the next update or lifecycle + command. """ source: typing.Optional[AgentTraceSource] = pydantic.Field(default=None) @@ -87,29 +90,31 @@ class AgentTrace(UniversalBaseModel): status: typing.Optional[AgentTraceLifecycle] = pydantic.Field(default=None) """ - The current lifecycle state. + The service returns the current lifecycle state. Valid values are open, closing, closed, abandoned, and deleted. """ task_family: typing.Optional[str] = pydantic.Field(default=None) """ - The optional opaque task-family classification slug. + The service returns the declared or assigned task-family slug, when one + is available. """ task_family_inference: typing.Optional[AgentTraceTaskFamilyInference] = pydantic.Field(default=None) """ - The latest task-family inference outcome. Absent when inference never - ran for this Trace. + The service returns the latest classification result. Its state is pending, assigned, or + unassigned. It is absent if classification did not run for this Trace. """ task_family_source: typing.Optional[str] = pydantic.Field(default=None) """ - Who supplied task_family: the caller (declared), an import rule - (import_rule), or the service classifier (inferred). + The service returns how it selected the task family. Valid values are + declared, import_rule, and inferred. """ trace_id: typing.Optional[str] = pydantic.Field(default=None) """ - The optional customer-assigned identifier, unique within the Agent. + The developer may set an identifier that is unique within the Agent. A retry with the same + create parameters returns 200 and the existing Trace. Different parameters return 409. """ updated_at: typing.Optional[str] = pydantic.Field(default=None) @@ -120,15 +125,16 @@ class AgentTrace(UniversalBaseModel): uuid_: typing_extensions.Annotated[ typing.Optional[str], FieldMetadata(alias="uuid"), - pydantic.Field(alias="uuid", description="The stable Trace UUID."), + pydantic.Field(alias="uuid", description="The service returns the stable Trace UUID."), ] = None """ - The stable Trace UUID. + The service returns the stable Trace UUID. """ verification: typing.Optional[AgentTraceVerification] = pydantic.Field(default=None) """ - The strength of the accepted outcome verification. + The service returns how the outcome was verified. Valid values are none, + agent, tool, customer, and external. """ if IS_PYDANTIC_V2: diff --git a/src/zep_cloud/types/agent_trace_event.py b/src/zep_cloud/types/agent_trace_event.py index 3a8aaca0..3c27be29 100644 --- a/src/zep_cloud/types/agent_trace_event.py +++ b/src/zep_cloud/types/agent_trace_event.py @@ -15,17 +15,34 @@ class AgentTraceEvent(UniversalBaseModel): agent_uuid: typing.Optional[str] = None content: typing.Optional[str] = None - context: typing.Optional[AgentTraceEventContext] = None + context: typing.Optional[AgentTraceEventContext] = pydantic.Field(default=None) + """ + Context gives the model, the tools, and the environments of the event. context.tools is the tool + that the event calls or returns, and Skills learning reads it. A tool event can omit the tool name. + """ + created_at: typing.Optional[str] = None event_id: typing.Optional[str] = None event_type: typing.Optional[AgentTraceEventType] = None failed_at: typing.Optional[str] = None - metadata: typing.Optional[typing.Dict[str, typing.Any]] = None + metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None) + """ + Metadata is developer data. Skills learning does not read it. + """ + occurred_at: typing.Optional[str] = None processed_at: typing.Optional[str] = None processing_state: typing.Optional[AgentTraceEventProcessingState] = None sequence: typing.Optional[int] = None sources: typing.Optional[typing.List[AgentTraceEventSource]] = None + tool_call_id: typing.Optional[str] = pydantic.Field(default=None) + """ + ToolCallID is the ID that the agent framework gives a tool call. Use the same ID on + the tool_call and tool_result events. It is valid only on these event types. A result + without a matching call is valid. OpenAI uses tool_calls[].id, Anthropic uses the + tool_use block id, and LangChain uses ToolMessage.tool_call_id. + """ + trace_uuid: typing.Optional[str] = None updated_at: typing.Optional[str] = None uuid_: typing_extensions.Annotated[ diff --git a/src/zep_cloud/types/agent_trace_event_context.py b/src/zep_cloud/types/agent_trace_event_context.py index 6ea6bf5a..455dceab 100644 --- a/src/zep_cloud/types/agent_trace_event_context.py +++ b/src/zep_cloud/types/agent_trace_event_context.py @@ -12,7 +12,12 @@ class AgentTraceEventContext(UniversalBaseModel): artifacts: typing.Optional[typing.List[AgentTraceResourceRef]] = None environments: typing.Optional[typing.List[AgentTraceResourceRef]] = None model: typing.Optional[AgentTraceResourceRef] = None - tools: typing.Optional[typing.List[AgentTraceResourceRef]] = None + tools: typing.Optional[typing.List[AgentTraceResourceRef]] = pydantic.Field(default=None) + """ + Tools identifies the tool that the event calls or returns. Skills learning reads this field. + It is optional. A tool event can omit the tool name. + """ + verification: typing.Optional[AgentTraceVerification] = None if IS_PYDANTIC_V2: diff --git a/src/zep_cloud/types/agent_trace_event_page.py b/src/zep_cloud/types/agent_trace_event_page.py index c82bb39b..c281388b 100644 --- a/src/zep_cloud/types/agent_trace_event_page.py +++ b/src/zep_cloud/types/agent_trace_event_page.py @@ -8,9 +8,20 @@ class AgentTraceEventPage(UniversalBaseModel): - items: typing.Optional[typing.List[AgentTraceEvent]] = None - next_cursor: typing.Optional[str] = None - total_size: typing.Optional[int] = None + items: typing.Optional[typing.List[AgentTraceEvent]] = pydantic.Field(default=None) + """ + The service returns the events in this page. + """ + + next_cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the cursor for the next page, when one exists. + """ + + total_size: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the total number of items. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_finalization_result.py b/src/zep_cloud/types/agent_trace_finalization_result.py index a7dab1d3..d0364cf5 100644 --- a/src/zep_cloud/types/agent_trace_finalization_result.py +++ b/src/zep_cloud/types/agent_trace_finalization_result.py @@ -9,8 +9,15 @@ class AgentTraceFinalizationResult(UniversalBaseModel): - task: typing.Optional[Task] = None - trace: typing.Optional[AgentTrace] = None + task: typing.Optional[Task] = pydantic.Field(default=None) + """ + The service returns the asynchronous Task. + """ + + trace: typing.Optional[AgentTrace] = pydantic.Field(default=None) + """ + The service returns the finalized Trace. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_internal.py b/src/zep_cloud/types/agent_trace_internal.py index 1f6f437d..c4a0281b 100644 --- a/src/zep_cloud/types/agent_trace_internal.py +++ b/src/zep_cloud/types/agent_trace_internal.py @@ -8,12 +8,36 @@ class AgentTraceInternal(UniversalBaseModel): - assertion_uuid: typing.Optional[str] = None - closing_sequence: typing.Optional[int] = None - current_summary_version: typing.Optional[int] = None - last_task_uuid: typing.Optional[str] = None - next_sequence: typing.Optional[int] = None - processing_state: typing.Optional[AgentTraceProcessingState] = None + assertion_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the assertion linked to this Trace. + """ + + closing_sequence: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the final sequence number expected when the Trace closes. + """ + + current_summary_version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the current summary version number. + """ + + last_task_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the last Task linked to this Trace. + """ + + next_sequence: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the next sequence number that the Trace can accept. + """ + + processing_state: typing.Optional[AgentTraceProcessingState] = pydantic.Field(default=None) + """ + The service returns the current processing state. Valid values are idle, pending, processing, + failed. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_source.py b/src/zep_cloud/types/agent_trace_source.py index bd40ede6..4ff71460 100644 --- a/src/zep_cloud/types/agent_trace_source.py +++ b/src/zep_cloud/types/agent_trace_source.py @@ -7,24 +7,78 @@ class AgentTraceSource(UniversalBaseModel): - connection_uuid: typing.Optional[str] = None - import_uuid: typing.Optional[str] = None - imported_at: typing.Optional[str] = None - kind: typing.Optional[typing.Literal["trace_import"]] = None - provider: typing.Optional[str] = None - provider_project_id: typing.Optional[str] = None - run_uuid: typing.Optional[str] = None - scores: typing.Optional[typing.Dict[str, float]] = None + connection_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the provider connection, when the Trace + came from an import. + """ + + import_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the import, when the Trace came from an + import. + """ + + imported_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep imported the Trace. + """ + + kind: typing.Optional[typing.Literal["trace_import"]] = pydantic.Field(default=None) + """ + The service returns the source type. The valid value is trace_import. + """ + + provider: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the provider that supplied this Trace. + """ + + provider_project_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the provider's project ID when the Trace came from an + import. + """ + + run_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the import run, when one applies. + """ + + scores: typing.Optional[typing.Dict[str, float]] = pydantic.Field(default=None) + """ + The service returns provider-specific scores for the imported Trace. + """ + source_changed: typing.Optional[bool] = pydantic.Field(default=None) """ - SourceChanged reports whether the provider trace changed after import. + The service returns whether the provider Trace changed after import. """ - source_revision: typing.Optional[str] = None - source_url: typing.Optional[str] = None - trace_ended_at: typing.Optional[str] = None - trace_id: typing.Optional[str] = None - trace_started_at: typing.Optional[str] = None + source_revision: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the provider revision processed by this import. + """ + + source_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns a link to the source Trace, when available. + """ + + trace_ended_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when the source Trace ended. + """ + + trace_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the provider ID of the source Trace. + """ + + trace_started_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the start time of the source Trace, when available. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_source_deletion_result.py b/src/zep_cloud/types/agent_trace_source_deletion_result.py index 1616e022..42017f3c 100644 --- a/src/zep_cloud/types/agent_trace_source_deletion_result.py +++ b/src/zep_cloud/types/agent_trace_source_deletion_result.py @@ -9,11 +9,30 @@ class AgentTraceSourceDeletionResult(UniversalBaseModel): - affected_skills: typing.Optional[int] = None - deletion_uuid: typing.Optional[str] = None - skill_repair_task: typing.Optional[Task] = None - summary_repair_task: typing.Optional[Task] = None - trace: typing.Optional[AgentTrace] = None + affected_skills: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the number of Skills affected by this deletion. + """ + + deletion_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the deletion operation. + """ + + skill_repair_task: typing.Optional[Task] = pydantic.Field(default=None) + """ + The service returns the Task that repairs Skills affected by this deletion. + """ + + summary_repair_task: typing.Optional[Task] = pydantic.Field(default=None) + """ + The service returns the Task that repairs summaries affected by this deletion. + """ + + trace: typing.Optional[AgentTrace] = pydantic.Field(default=None) + """ + The service returns the Trace. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_structured_summary.py b/src/zep_cloud/types/agent_trace_structured_summary.py index cb505df9..829ab771 100644 --- a/src/zep_cloud/types/agent_trace_structured_summary.py +++ b/src/zep_cloud/types/agent_trace_structured_summary.py @@ -12,26 +12,106 @@ class AgentTraceStructuredSummary(UniversalBaseModel): - ambiguities: typing.Optional[typing.List[AgentTraceSummaryStatement]] = None - approach: typing.Optional[typing.List[AgentTraceSummaryStatement]] = None - artifacts: typing.Optional[typing.List[AgentTraceSummaryResource]] = None - candidate_lessons: typing.Optional[typing.List[AgentTraceSummaryStatement]] = None - corrections: typing.Optional[typing.List[AgentTraceSummaryStatement]] = None - coverage: typing.Optional[AgentTraceSummaryCoverage] = None - effective_steps: typing.Optional[typing.List[AgentTraceSummaryStatement]] = None - environments: typing.Optional[typing.List[AgentTraceSummaryResource]] = None - errors: typing.Optional[typing.List[AgentTraceSummaryStatement]] = None - event_time_basis: typing.Optional[str] = None - first_event_time: typing.Optional[str] = None - ineffective_steps: typing.Optional[typing.List[AgentTraceSummaryStatement]] = None - last_event_time: typing.Optional[str] = None - objective: typing.Optional[str] = None - recoveries: typing.Optional[typing.List[AgentTraceSummaryStatement]] = None - reported_outcome: typing.Optional[AgentTraceOutcome] = None - result: typing.Optional[AgentTraceSummaryStatement] = None - task_family: typing.Optional[str] = None - tools: typing.Optional[typing.List[AgentTraceSummaryResource]] = None - verification: typing.Optional[AgentTraceSummaryVerification] = None + ambiguities: typing.Optional[typing.List[AgentTraceSummaryStatement]] = pydantic.Field(default=None) + """ + The service returns unresolved ambiguities. + """ + + approach: typing.Optional[typing.List[AgentTraceSummaryStatement]] = pydantic.Field(default=None) + """ + The service returns verification method. + """ + + artifacts: typing.Optional[typing.List[AgentTraceSummaryResource]] = pydantic.Field(default=None) + """ + The service returns linked artifacts. + """ + + candidate_lessons: typing.Optional[typing.List[AgentTraceSummaryStatement]] = pydantic.Field(default=None) + """ + The service returns lessons that the learning process may use. + """ + + corrections: typing.Optional[typing.List[AgentTraceSummaryStatement]] = pydantic.Field(default=None) + """ + The service returns corrective actions. + """ + + coverage: typing.Optional[AgentTraceSummaryCoverage] = pydantic.Field(default=None) + """ + The service returns the event coverage of the summary. + """ + + effective_steps: typing.Optional[typing.List[AgentTraceSummaryStatement]] = pydantic.Field(default=None) + """ + The service returns actions that helped complete the task. + """ + + environments: typing.Optional[typing.List[AgentTraceSummaryResource]] = pydantic.Field(default=None) + """ + The service returns environment names used by the Skill. + """ + + errors: typing.Optional[typing.List[AgentTraceSummaryStatement]] = pydantic.Field(default=None) + """ + The service returns verification errors. + """ + + event_time_basis: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns how event times were selected for the summary. + """ + + first_event_time: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the time of the first event in the summary. + """ + + ineffective_steps: typing.Optional[typing.List[AgentTraceSummaryStatement]] = pydantic.Field(default=None) + """ + The service returns actions that did not help complete the task. + """ + + last_event_time: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the time of the last event in the summary. + """ + + objective: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-instance objective. + """ + + recoveries: typing.Optional[typing.List[AgentTraceSummaryStatement]] = pydantic.Field(default=None) + """ + The service returns recovery actions. + """ + + reported_outcome: typing.Optional[AgentTraceOutcome] = pydantic.Field(default=None) + """ + The service returns the outcome reported for the Trace. Valid values are succeeded, failed, partial, + abandoned, unknown. + """ + + result: typing.Optional[AgentTraceSummaryStatement] = pydantic.Field(default=None) + """ + The service returns verification result. + """ + + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the task-family slug. + """ + + tools: typing.Optional[typing.List[AgentTraceSummaryResource]] = pydantic.Field(default=None) + """ + The service returns tool names used by the Skill. + """ + + verification: typing.Optional[AgentTraceSummaryVerification] = pydantic.Field(default=None) + """ + The service returns the verification status and its evidence. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_summary_byte_range.py b/src/zep_cloud/types/agent_trace_summary_byte_range.py index 47b2976a..ee8fb4a2 100644 --- a/src/zep_cloud/types/agent_trace_summary_byte_range.py +++ b/src/zep_cloud/types/agent_trace_summary_byte_range.py @@ -7,8 +7,15 @@ class AgentTraceSummaryByteRange(UniversalBaseModel): - end: typing.Optional[int] = None - start: typing.Optional[int] = None + end: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the byte offset after the half-open omitted range. + """ + + start: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the first byte offset in the half-open omitted range. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_summary_citation.py b/src/zep_cloud/types/agent_trace_summary_citation.py index e1e09adb..62a07269 100644 --- a/src/zep_cloud/types/agent_trace_summary_citation.py +++ b/src/zep_cloud/types/agent_trace_summary_citation.py @@ -7,8 +7,15 @@ class AgentTraceSummaryCitation(UniversalBaseModel): - event_id: typing.Optional[str] = None - sequence: typing.Optional[int] = None + event_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the ID of the source event. + """ + + sequence: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the event sequence cited by this summary. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_summary_coverage.py b/src/zep_cloud/types/agent_trace_summary_coverage.py index fde261cd..14ac2cde 100644 --- a/src/zep_cloud/types/agent_trace_summary_coverage.py +++ b/src/zep_cloud/types/agent_trace_summary_coverage.py @@ -9,10 +9,25 @@ class AgentTraceSummaryCoverage(UniversalBaseModel): - excerpted_events: typing.Optional[typing.List[AgentTraceSummaryExcerptedEvent]] = None - first_sequence: typing.Optional[int] = None - last_sequence: typing.Optional[int] = None - omitted_sequence_ranges: typing.Optional[typing.List[AgentTraceSummaryOmittedRange]] = None + excerpted_events: typing.Optional[typing.List[AgentTraceSummaryExcerptedEvent]] = pydantic.Field(default=None) + """ + The service returns events that the summary includes as excerpts. + """ + + first_sequence: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the first sequence number covered by this summary. + """ + + last_sequence: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the last sequence number covered by this summary. + """ + + omitted_sequence_ranges: typing.Optional[typing.List[AgentTraceSummaryOmittedRange]] = pydantic.Field(default=None) + """ + The service returns sequence ranges that the summary omits. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_summary_excerpted_event.py b/src/zep_cloud/types/agent_trace_summary_excerpted_event.py index 69c619e5..b1f70494 100644 --- a/src/zep_cloud/types/agent_trace_summary_excerpted_event.py +++ b/src/zep_cloud/types/agent_trace_summary_excerpted_event.py @@ -8,10 +8,25 @@ class AgentTraceSummaryExcerptedEvent(UniversalBaseModel): - content_bytes: typing.Optional[int] = None - event_id: typing.Optional[str] = None - omitted_byte_ranges: typing.Optional[typing.List[AgentTraceSummaryByteRange]] = None - sequence: typing.Optional[int] = None + content_bytes: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the excerpted event content in bytes. + """ + + event_id: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the ID of the source event. + """ + + omitted_byte_ranges: typing.Optional[typing.List[AgentTraceSummaryByteRange]] = pydantic.Field(default=None) + """ + The service returns byte ranges removed from the excerpted event content. + """ + + sequence: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the sequence number of the excerpted event. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_summary_omitted_range.py b/src/zep_cloud/types/agent_trace_summary_omitted_range.py index c8608dd3..e65a9831 100644 --- a/src/zep_cloud/types/agent_trace_summary_omitted_range.py +++ b/src/zep_cloud/types/agent_trace_summary_omitted_range.py @@ -8,9 +8,21 @@ class AgentTraceSummaryOmittedRange(UniversalBaseModel): - first_sequence: typing.Optional[int] = None - last_sequence: typing.Optional[int] = None - reason: typing.Optional[AgentTraceSummaryOmissionReason] = None + first_sequence: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the first sequence number in the omitted range. + """ + + last_sequence: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the last sequence number in the omitted range. + """ + + reason: typing.Optional[AgentTraceSummaryOmissionReason] = pydantic.Field(default=None) + """ + The service returns the reason for this result. Valid values are narrower_authorization_boundary, + acknowledged_gap, abandoned_gap, processing_failed, source_deleted. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_summary_page.py b/src/zep_cloud/types/agent_trace_summary_page.py index 612b4115..6262da8d 100644 --- a/src/zep_cloud/types/agent_trace_summary_page.py +++ b/src/zep_cloud/types/agent_trace_summary_page.py @@ -8,9 +8,20 @@ class AgentTraceSummaryPage(UniversalBaseModel): - items: typing.Optional[typing.List[AgentTraceSummaryVersion]] = None - next_cursor: typing.Optional[str] = None - total_size: typing.Optional[int] = None + items: typing.Optional[typing.List[AgentTraceSummaryVersion]] = pydantic.Field(default=None) + """ + The service returns the summary versions in this page. + """ + + next_cursor: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the cursor for the next page, when one exists. + """ + + total_size: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the total number of matching items. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_summary_resource.py b/src/zep_cloud/types/agent_trace_summary_resource.py index dd7ecd1c..30d049ab 100644 --- a/src/zep_cloud/types/agent_trace_summary_resource.py +++ b/src/zep_cloud/types/agent_trace_summary_resource.py @@ -8,9 +8,20 @@ class AgentTraceSummaryResource(UniversalBaseModel): - citations: typing.Optional[typing.List[AgentTraceSummaryCitation]] = None - name: typing.Optional[str] = None - version: typing.Optional[str] = None + citations: typing.Optional[typing.List[AgentTraceSummaryCitation]] = pydantic.Field(default=None) + """ + The service returns the events that support this resource summary. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the resource name recorded in the source event. + """ + + version: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the resource version recorded in the source event. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_summary_statement.py b/src/zep_cloud/types/agent_trace_summary_statement.py index 9fe22b14..05f938ae 100644 --- a/src/zep_cloud/types/agent_trace_summary_statement.py +++ b/src/zep_cloud/types/agent_trace_summary_statement.py @@ -8,8 +8,15 @@ class AgentTraceSummaryStatement(UniversalBaseModel): - citations: typing.Optional[typing.List[AgentTraceSummaryCitation]] = None - text: typing.Optional[str] = None + citations: typing.Optional[typing.List[AgentTraceSummaryCitation]] = pydantic.Field(default=None) + """ + The service returns the events that support this statement. + """ + + text: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns one statement from the summary. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_summary_verification.py b/src/zep_cloud/types/agent_trace_summary_verification.py index 483bedd4..a332c6d3 100644 --- a/src/zep_cloud/types/agent_trace_summary_verification.py +++ b/src/zep_cloud/types/agent_trace_summary_verification.py @@ -10,10 +10,26 @@ class AgentTraceSummaryVerification(UniversalBaseModel): - citations: typing.Optional[typing.List[AgentTraceSummaryCitation]] = None - details: typing.Optional[typing.List[AgentTraceSummaryStatement]] = None - status: typing.Optional[AgentTraceSummaryVerificationStatus] = None - verifier_ids: typing.Optional[typing.List[str]] = None + citations: typing.Optional[typing.List[AgentTraceSummaryCitation]] = pydantic.Field(default=None) + """ + The service returns the events that support this verification result. + """ + + details: typing.Optional[typing.List[AgentTraceSummaryStatement]] = pydantic.Field(default=None) + """ + The service returns the detailed verification statements. + """ + + status: typing.Optional[AgentTraceSummaryVerificationStatus] = pydantic.Field(default=None) + """ + The service returns the lifecycle status. Valid values are + unverified,agent_verified,tool_verified,customer_verified,externally_verified. + """ + + verifier_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns IDs of Verifiers that checked this summary. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_summary_version.py b/src/zep_cloud/types/agent_trace_summary_version.py index 08a52001..aaa12f85 100644 --- a/src/zep_cloud/types/agent_trace_summary_version.py +++ b/src/zep_cloud/types/agent_trace_summary_version.py @@ -14,25 +14,98 @@ class AgentTraceSummaryVersion(UniversalBaseModel): - agent_uuid: typing.Optional[str] = None - assertion_uuid: typing.Optional[str] = None - created_at: typing.Optional[str] = None - creation_reason: typing.Optional[AgentTraceSummaryCreationReason] = None - first_occurred_at: typing.Optional[str] = None - first_sequence: typing.Optional[int] = None - last_occurred_at: typing.Optional[str] = None - last_sequence: typing.Optional[int] = None - omitted_sequence_ranges: typing.Optional[typing.List[AgentTraceSummaryOmittedRange]] = None - outcome: typing.Optional[AgentTraceOutcome] = None - parent_version_uuid: typing.Optional[str] = None - structured_summary: typing.Optional[AgentTraceStructuredSummary] = None - text: typing.Optional[str] = None - trace_uuid: typing.Optional[str] = None + agent_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the owning Agent. + """ + + assertion_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the verification assertion linked to this evidence. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + creation_reason: typing.Optional[AgentTraceSummaryCreationReason] = pydantic.Field(default=None) + """ + The service returns what caused this summary version. Valid values are close, abandon, revision, + task_family_correction, evidence_deletion, policy_change. + """ + + first_occurred_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when the first event occurred. + """ + + first_sequence: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the first event sequence included in this summary. + """ + + last_occurred_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when the last event occurred. + """ + + last_sequence: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns the last event sequence included in this summary. + """ + + omitted_sequence_ranges: typing.Optional[typing.List[AgentTraceSummaryOmittedRange]] = pydantic.Field(default=None) + """ + The service returns event sequence ranges that this summary omits. + """ + + outcome: typing.Optional[AgentTraceOutcome] = pydantic.Field(default=None) + """ + The service returns the task outcome. Valid values are succeeded, failed, partial, abandoned, + unknown. + """ + + parent_version_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the parent summary version, when one exists. + """ + + structured_summary: typing.Optional[AgentTraceStructuredSummary] = pydantic.Field(default=None) + """ + The service returns the structured summary generated for this Trace. + """ + + text: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns text that a person can read. + """ + + trace_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the source Trace. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this summary version."), ] = None - verification: typing.Optional[AgentTraceVerification] = None - version: typing.Optional[int] = None + """ + The service returns the UUID that identifies this summary version. + """ + + verification: typing.Optional[AgentTraceVerification] = pydantic.Field(default=None) + """ + The service returns how the outcome was verified. Valid values are none, agent, tool, + customer, external, unverified, agent_verified, tool_verified, customer_verified, + externally_verified. + """ + + version: typing.Optional[int] = pydantic.Field(default=None) + """ + The service returns this summary version number. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_trace_task_family_inference.py b/src/zep_cloud/types/agent_trace_task_family_inference.py index 8669933f..4fc26eda 100644 --- a/src/zep_cloud/types/agent_trace_task_family_inference.py +++ b/src/zep_cloud/types/agent_trace_task_family_inference.py @@ -9,32 +9,33 @@ class AgentTraceTaskFamilyInference(UniversalBaseModel): assigned_at: typing.Optional[str] = pydantic.Field(default=None) """ - The time the outcome was recorded. + The service returns the time the outcome was recorded. """ classifier_version: typing.Optional[str] = pydantic.Field(default=None) """ - The classifier version that produced the outcome. + The service records the classifier version that produced the outcome. """ confidence: typing.Optional[float] = pydantic.Field(default=None) """ - The classifier confidence of the accepted or top candidate. + The service records the classifier confidence for the accepted or top candidate, from 0 to 1. """ descriptor_version: typing.Optional[int] = pydantic.Field(default=None) """ - The descriptor set version the classifier ran against. + The service returns the descriptor set version the classifier ran against. """ learning_reusable: typing.Optional[bool] = pydantic.Field(default=None) """ - Whether the classifier marked the Trace reusable for learning. + The service returns whether the classifier marked the Trace reusable for learning. """ state: typing.Optional[str] = pydantic.Field(default=None) """ - The inference state: pending, assigned, or unassigned. + The service returns pending while classification is in progress, assigned when a task family + is selected, or unassigned when no family is selected. """ if IS_PYDANTIC_V2: diff --git a/src/zep_cloud/types/agent_verifier_evidence_invalidation_result.py b/src/zep_cloud/types/agent_verifier_evidence_invalidation_result.py index 690a92b9..8cadfd9d 100644 --- a/src/zep_cloud/types/agent_verifier_evidence_invalidation_result.py +++ b/src/zep_cloud/types/agent_verifier_evidence_invalidation_result.py @@ -11,17 +11,54 @@ class AgentVerifierEvidenceInvalidationResult(UniversalBaseModel): - affected_skill_uuids: typing.Optional[typing.List[str]] = None - agent_uuid: typing.Optional[str] = None - created_at: typing.Optional[str] = None - created_by: typing.Optional[AgentVerifierPrincipal] = None - reason: typing.Optional[str] = None - task: typing.Optional[Task] = None + affected_skill_uuids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The service returns UUIDs of Skills affected by this invalidation. + """ + + agent_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the owning Agent. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns when Zep created this resource. + """ + + created_by: typing.Optional[AgentVerifierPrincipal] = pydantic.Field(default=None) + """ + The service returns the principal that created this assertion. + """ + + reason: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns why the Verifier revisions were invalidated. + """ + + task: typing.Optional[Task] = pydantic.Field(default=None) + """ + The service returns the Task that tracks this asynchronous operation. + """ + uuid_: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid") + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The service returns the UUID that identifies this resource."), ] = None - verifier_revisions: typing.Optional[typing.List[int]] = None - verifier_uuid: typing.Optional[str] = None + """ + The service returns the UUID that identifies this resource. + """ + + verifier_revisions: typing.Optional[typing.List[int]] = pydantic.Field(default=None) + """ + The service returns revisions of the Verifiers affected by this invalidation. + """ + + verifier_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The service returns the UUID of the Verifier linked to this invalidation. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/agent_verifier_principal_binding.py b/src/zep_cloud/types/agent_verifier_principal_binding.py index fde5a96f..05922955 100644 --- a/src/zep_cloud/types/agent_verifier_principal_binding.py +++ b/src/zep_cloud/types/agent_verifier_principal_binding.py @@ -15,17 +15,18 @@ class AgentVerifierPrincipalBinding(UniversalBaseModel): effective_strength: typing.Optional[AgentVerificationStrength] = pydantic.Field(default=None) """ - The verification strength assigned to this principal binding. + The service returns the verification strength assigned to this principal binding. Valid values + are tool_verified, customer_verified, externally_verified. """ principal_id: typing.Optional[str] = pydantic.Field(default=None) """ - The exact principal identifier bound to this verifier. + The service returns the exact principal identifier bound to this verifier. """ principal_type: typing.Optional[str] = pydantic.Field(default=None) """ - The authenticated principal type bound to this verifier. + The service returns the authenticated principal type bound to this verifier. """ if IS_PYDANTIC_V2: diff --git a/src/zep_cloud/types/context_thread_summary.py b/src/zep_cloud/types/context_thread_summary.py index c3c5277f..f29a1cf8 100644 --- a/src/zep_cloud/types/context_thread_summary.py +++ b/src/zep_cloud/types/context_thread_summary.py @@ -14,6 +14,11 @@ class ContextThreadSummary(UniversalBaseModel): The time the summary was first created. """ + graph_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the graph this thread summary belongs to. + """ + last_summarized_at: typing.Optional[str] = pydantic.Field(default=None) """ The wall-clock time of the most recent summary update. diff --git a/src/zep_cloud/types/delete_agent_trace_request.py b/src/zep_cloud/types/delete_agent_trace_request.py index de6e99db..c6c60dbb 100644 --- a/src/zep_cloud/types/delete_agent_trace_request.py +++ b/src/zep_cloud/types/delete_agent_trace_request.py @@ -7,7 +7,10 @@ class DeleteAgentTraceRequest(UniversalBaseModel): - expected_revision: int + expected_revision: int = pydantic.Field() + """ + The developer supplies the current revision for optimistic concurrency. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/graph_query_citations.py b/src/zep_cloud/types/graph_query_citations.py new file mode 100644 index 00000000..79bc0043 --- /dev/null +++ b/src/zep_cloud/types/graph_query_citations.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class GraphQueryCitations(UniversalBaseModel): + edge_uuids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The edge UUIDs cited by the answer. + """ + + episode_uuids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The episode UUIDs cited by the answer. + """ + + node_uuids: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The node UUIDs cited by the answer. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_edge.py b/src/zep_cloud/types/graph_query_edge.py new file mode 100644 index 00000000..d56b9c20 --- /dev/null +++ b/src/zep_cloud/types/graph_query_edge.py @@ -0,0 +1,123 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class GraphQueryEdge(UniversalBaseModel): + attributes: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None) + """ + Additional attributes of the edge. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time the edge was created. + """ + + expired_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time the fact was superseded or removed. + """ + + fact: typing.Optional[str] = pydantic.Field(default=None) + """ + The natural-language fact this edge represents. + """ + + graph_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the graph this edge belongs to. + """ + + hyperedge_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the hyperedge this edge is a member of. Omitted + when the edge is not part of a hyperedge. + """ + + invalid_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time at which the fact stopped being true. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the edge, in upper snake case, for example RELATES_TO. + """ + + scope: typing.Optional[str] = pydantic.Field(default=None) + """ + The kind of edge this is, for example entity or episodic. + """ + + source_node_labels: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The current labels of the source node. This is read at request time rather + than stored on the edge, and is omitted when the source node cannot be + resolved. + """ + + source_node_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The current name of the source node. This is read at request time rather + than stored on the edge, and is omitted when the source node cannot be + resolved. + """ + + source_node_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the edge's source node. + """ + + target_node_labels: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The current labels of the target node. This is read at request time rather + than stored on the edge, and is omitted when the target node cannot be + resolved. + """ + + target_node_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The current name of the target node. This is read at request time rather + than stored on the edge, and is omitted when the target node cannot be + resolved. + """ + + target_node_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the edge's target node. + """ + + user_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the user that owns the graph. Present only when + the graph is a user graph. + """ + + uuid_: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The unique identifier of the edge."), + ] = None + """ + The unique identifier of the edge. + """ + + valid_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time from which the fact is considered true. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_error_event.py b/src/zep_cloud/types/graph_query_error_event.py new file mode 100644 index 00000000..3ad4fd32 --- /dev/null +++ b/src/zep_cloud/types/graph_query_error_event.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .error_body import ErrorBody + + +class GraphQueryErrorEvent(UniversalBaseModel): + sequence: int + status: int + error: ErrorBody + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_handle.py b/src/zep_cloud/types/graph_query_handle.py new file mode 100644 index 00000000..a22234e5 --- /dev/null +++ b/src/zep_cloud/types/graph_query_handle.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .graph_query_handle_item_type import GraphQueryHandleItemType + + +class GraphQueryHandle(UniversalBaseModel): + handle: str + item_type: GraphQueryHandleItemType + uuid_: typing_extensions.Annotated[str, FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid")] + graph_uuid: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_handle_item_type.py b/src/zep_cloud/types/graph_query_handle_item_type.py new file mode 100644 index 00000000..aa332114 --- /dev/null +++ b/src/zep_cloud/types/graph_query_handle_item_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GraphQueryHandleItemType = typing.Union[typing.Literal["node", "edge", "episode"], typing.Any] diff --git a/src/zep_cloud/types/graph_query_listing.py b/src/zep_cloud/types/graph_query_listing.py new file mode 100644 index 00000000..6e901406 --- /dev/null +++ b/src/zep_cloud/types/graph_query_listing.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class GraphQueryListing(UniversalBaseModel): + first_item: int + last_item: int + complete: bool + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_node.py b/src/zep_cloud/types/graph_query_node.py new file mode 100644 index 00000000..d49b81fc --- /dev/null +++ b/src/zep_cloud/types/graph_query_node.py @@ -0,0 +1,64 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class GraphQueryNode(UniversalBaseModel): + attributes: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None) + """ + Additional attributes of the node, as defined by its entity type. + """ + + created_at: typing.Optional[str] = pydantic.Field(default=None) + """ + The time the node was created. + """ + + graph_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the graph this node belongs to. + """ + + labels: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The entity type labels assigned to the node. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the entity that the node represents. + """ + + summary: typing.Optional[str] = pydantic.Field(default=None) + """ + A generated summary of the entity that the node represents. + """ + + user_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the user that owns the graph. Present only when + the graph is a user graph. + """ + + uuid_: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="uuid"), + pydantic.Field(alias="uuid", description="The node UUID, assigned by Zep."), + ] = None + """ + The node UUID, assigned by Zep. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_plan.py b/src/zep_cloud/types/graph_query_plan.py new file mode 100644 index 00000000..6c1a1ce1 --- /dev/null +++ b/src/zep_cloud/types/graph_query_plan.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .graph_query_plan_step import GraphQueryPlanStep + + +class GraphQueryPlan(UniversalBaseModel): + subjects: typing.List[str] + steps: typing.List[GraphQueryPlanStep] + evidence_needed: typing.List[str] + stop_when: str + answer_language: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_plan_event.py b/src/zep_cloud/types/graph_query_plan_event.py new file mode 100644 index 00000000..a358935d --- /dev/null +++ b/src/zep_cloud/types/graph_query_plan_event.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .graph_query_plan import GraphQueryPlan + + +class GraphQueryPlanEvent(UniversalBaseModel): + sequence: int + step: int + revision: int + plan: GraphQueryPlan + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_plan_step.py b/src/zep_cloud/types/graph_query_plan_step.py new file mode 100644 index 00000000..39ae2f87 --- /dev/null +++ b/src/zep_cloud/types/graph_query_plan_step.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class GraphQueryPlanStep(UniversalBaseModel): + tool: str + purpose: str + arguments_hint: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_reasoning_event.py b/src/zep_cloud/types/graph_query_reasoning_event.py new file mode 100644 index 00000000..dcc6db72 --- /dev/null +++ b/src/zep_cloud/types/graph_query_reasoning_event.py @@ -0,0 +1,21 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class GraphQueryReasoningEvent(UniversalBaseModel): + sequence: int + step: int + text: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_response.py b/src/zep_cloud/types/graph_query_response.py new file mode 100644 index 00000000..0d03ae00 --- /dev/null +++ b/src/zep_cloud/types/graph_query_response.py @@ -0,0 +1,41 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .graph_query_citations import GraphQueryCitations +from .graph_query_results import GraphQueryResults + + +class GraphQueryResponse(UniversalBaseModel): + answer: typing.Optional[str] = pydantic.Field(default=None) + """ + The answer with citation handles removed. Present only when the + request sets generate_answer to true. + """ + + citations: typing.Optional[GraphQueryCitations] = pydantic.Field(default=None) + """ + The UUIDs of the graph items cited by the answer. The lists are empty + when the response has no answer. + """ + + results: typing.Optional[GraphQueryResults] = pydantic.Field(default=None) + """ + The distinct graph records retrieved during the query. + """ + + truncated: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the record limit omitted any results. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_result_event.py b/src/zep_cloud/types/graph_query_result_event.py new file mode 100644 index 00000000..3ecf9caa --- /dev/null +++ b/src/zep_cloud/types/graph_query_result_event.py @@ -0,0 +1,25 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .graph_query_citations import GraphQueryCitations +from .graph_query_results import GraphQueryResults + + +class GraphQueryResultEvent(UniversalBaseModel): + sequence: int + answer: typing.Optional[str] = None + citations: GraphQueryCitations + results: GraphQueryResults + truncated: bool + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_results.py b/src/zep_cloud/types/graph_query_results.py new file mode 100644 index 00000000..4974d477 --- /dev/null +++ b/src/zep_cloud/types/graph_query_results.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .episode import Episode +from .graph_query_edge import GraphQueryEdge +from .graph_query_node import GraphQueryNode +from .observation import Observation +from .thread_summary import ThreadSummary + + +class GraphQueryResults(UniversalBaseModel): + edges: typing.Optional[typing.List[GraphQueryEdge]] = pydantic.Field(default=None) + """ + The retrieved edges. + """ + + episodes: typing.Optional[typing.List[Episode]] = pydantic.Field(default=None) + """ + The retrieved episodes. + """ + + nodes: typing.Optional[typing.List[GraphQueryNode]] = pydantic.Field(default=None) + """ + The retrieved nodes. + """ + + observations: typing.Optional[typing.List[Observation]] = pydantic.Field(default=None) + """ + The retrieved observations. + """ + + thread_summaries: typing.Optional[typing.List[ThreadSummary]] = pydantic.Field(default=None) + """ + The retrieved thread summaries. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_started_event.py b/src/zep_cloud/types/graph_query_started_event.py new file mode 100644 index 00000000..2da5c628 --- /dev/null +++ b/src/zep_cloud/types/graph_query_started_event.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .graph_query_handle import GraphQueryHandle + + +class GraphQueryStartedEvent(UniversalBaseModel): + sequence: int + graph_uuids: typing.List[str] + handles: typing.List[GraphQueryHandle] + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_stream_event.py b/src/zep_cloud/types/graph_query_stream_event.py new file mode 100644 index 00000000..b9121b10 --- /dev/null +++ b/src/zep_cloud/types/graph_query_stream_event.py @@ -0,0 +1,170 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .error_body import ErrorBody +from .graph_query_citations import GraphQueryCitations +from .graph_query_handle import GraphQueryHandle +from .graph_query_listing import GraphQueryListing +from .graph_query_plan import GraphQueryPlan +from .graph_query_results import GraphQueryResults +from .graph_query_tool_error_event_reason import GraphQueryToolErrorEventReason + + +class GraphQueryStreamEvent_Started(UniversalBaseModel): + type: typing.Literal["started"] = "started" + sequence: int + graph_uuids: typing.List[str] + handles: typing.List[GraphQueryHandle] + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class GraphQueryStreamEvent_Reasoning(UniversalBaseModel): + type: typing.Literal["reasoning"] = "reasoning" + sequence: int + step: int + text: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class GraphQueryStreamEvent_Plan(UniversalBaseModel): + type: typing.Literal["plan"] = "plan" + sequence: int + step: int + revision: int + plan: GraphQueryPlan + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class GraphQueryStreamEvent_ToolCall(UniversalBaseModel): + type: typing.Literal["tool_call"] = "tool_call" + sequence: int + step: int + call_number: int + tool: str + arguments: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class GraphQueryStreamEvent_ToolResult(UniversalBaseModel): + type: typing.Literal["tool_result"] = "tool_result" + sequence: int + call_number: int + tool: str + duration_ms: int + listing: typing.Optional[GraphQueryListing] = None + handles: typing.List[GraphQueryHandle] + results: GraphQueryResults + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class GraphQueryStreamEvent_ToolError(UniversalBaseModel): + type: typing.Literal["tool_error"] = "tool_error" + sequence: int + call_number: int + tool: str + reason: GraphQueryToolErrorEventReason + duration_ms: int + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class GraphQueryStreamEvent_Result(UniversalBaseModel): + type: typing.Literal["result"] = "result" + sequence: int + answer: typing.Optional[str] = None + citations: GraphQueryCitations + results: GraphQueryResults + truncated: bool + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class GraphQueryStreamEvent_Error(UniversalBaseModel): + type: typing.Literal["error"] = "error" + sequence: int + status: int + error: ErrorBody + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +GraphQueryStreamEvent = typing_extensions.Annotated[ + typing.Union[ + GraphQueryStreamEvent_Started, + GraphQueryStreamEvent_Reasoning, + GraphQueryStreamEvent_Plan, + GraphQueryStreamEvent_ToolCall, + GraphQueryStreamEvent_ToolResult, + GraphQueryStreamEvent_ToolError, + GraphQueryStreamEvent_Result, + GraphQueryStreamEvent_Error, + ], + pydantic.Field(discriminator="type"), +] diff --git a/src/zep_cloud/types/graph_query_tool_call_event.py b/src/zep_cloud/types/graph_query_tool_call_event.py new file mode 100644 index 00000000..2e15ef43 --- /dev/null +++ b/src/zep_cloud/types/graph_query_tool_call_event.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class GraphQueryToolCallEvent(UniversalBaseModel): + sequence: int + step: int + call_number: int + tool: str + arguments: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_tool_error_event.py b/src/zep_cloud/types/graph_query_tool_error_event.py new file mode 100644 index 00000000..60b3267c --- /dev/null +++ b/src/zep_cloud/types/graph_query_tool_error_event.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .graph_query_tool_error_event_reason import GraphQueryToolErrorEventReason + + +class GraphQueryToolErrorEvent(UniversalBaseModel): + sequence: int + call_number: int + tool: str + reason: GraphQueryToolErrorEventReason + duration_ms: int + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/graph_query_tool_error_event_reason.py b/src/zep_cloud/types/graph_query_tool_error_event_reason.py new file mode 100644 index 00000000..f47a144c --- /dev/null +++ b/src/zep_cloud/types/graph_query_tool_error_event_reason.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +GraphQueryToolErrorEventReason = typing.Union[ + typing.Literal["invalid_arguments", "duplicate_call", "unknown_tool", "plan_limit", "retrieval_failed"], typing.Any +] diff --git a/src/zep_cloud/types/graph_query_tool_result_event.py b/src/zep_cloud/types/graph_query_tool_result_event.py new file mode 100644 index 00000000..34660499 --- /dev/null +++ b/src/zep_cloud/types/graph_query_tool_result_event.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .graph_query_handle import GraphQueryHandle +from .graph_query_listing import GraphQueryListing +from .graph_query_results import GraphQueryResults + + +class GraphQueryToolResultEvent(UniversalBaseModel): + sequence: int + call_number: int + tool: str + duration_ms: int + listing: typing.Optional[GraphQueryListing] = None + handles: typing.List[GraphQueryHandle] + results: GraphQueryResults + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/zep_cloud/types/imported_trace_reference.py b/src/zep_cloud/types/imported_trace_reference.py index 4cadee7f..9fe6b643 100644 --- a/src/zep_cloud/types/imported_trace_reference.py +++ b/src/zep_cloud/types/imported_trace_reference.py @@ -14,7 +14,7 @@ class ImportedTraceReference(UniversalBaseModel): import_uuid: typing.Optional[str] = pydantic.Field(default=None) """ - ImportUUID is the active import owner identifier. + The service returns the UUID of the active import. """ trace_uuid: typing.Optional[str] = pydantic.Field(default=None) diff --git a/src/zep_cloud/types/skill_definition.py b/src/zep_cloud/types/skill_definition.py index 91d9cfd6..24bc6397 100644 --- a/src/zep_cloud/types/skill_definition.py +++ b/src/zep_cloud/types/skill_definition.py @@ -13,25 +13,101 @@ class SkillDefinition(UniversalBaseModel): - agent_versions: typing.Optional[typing.List[str]] = None - aliases: typing.Optional[typing.List[str]] = None - description: typing.Optional[str] = None - do_not_use_when: typing.Optional[typing.List[str]] = None - done_when: typing.Optional[typing.List[str]] = None - environments: typing.Optional[typing.List[SkillResource]] = None - failures: typing.Optional[typing.List[SkillFailure]] = None - kind: typing.Optional[SkillKind] = None - name: typing.Optional[str] = None - outputs: typing.Optional[typing.List[str]] = None - package_name: typing.Optional[str] = None - preconditions: typing.Optional[typing.List[str]] = None - procedure: typing.Optional[typing.List[SkillProcedureStep]] = None - related_skills: typing.Optional[typing.List[SkillRelation]] = None - sections: typing.Optional[typing.List[SkillDefinitionSection]] = None - stop_when: typing.Optional[typing.List[str]] = None - task_family: typing.Optional[str] = None - tools: typing.Optional[typing.List[SkillResource]] = None - use_when: typing.Optional[typing.List[str]] = None + agent_versions: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer lists Agent versions that can use the Skill. + """ + + aliases: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer supplies alternate names for the resource. + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies the resource description. + """ + + do_not_use_when: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer supplies situations in which the Skill must not be used. + """ + + done_when: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer supplies conditions that show when the Skill work is complete. + """ + + environments: typing.Optional[typing.List[SkillResource]] = pydantic.Field(default=None) + """ + The developer supplies environment names used by the Skill. + """ + + failures: typing.Optional[typing.List[SkillFailure]] = pydantic.Field(default=None) + """ + The developer supplies failure conditions and recovery steps. + """ + + kind: typing.Optional[SkillKind] = pydantic.Field(default=None) + """ + The developer supplies a Skill kind. Valid values are principle, procedure, workflow, + failure_mode, recovery, constraint. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies a display name. + """ + + outputs: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer supplies results that the Skill produces. + """ + + package_name: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies the stable package name for the Skill. + """ + + preconditions: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer supplies conditions that must be true before use. + """ + + procedure: typing.Optional[typing.List[SkillProcedureStep]] = pydantic.Field(default=None) + """ + The developer supplies ordered procedure steps. + """ + + related_skills: typing.Optional[typing.List[SkillRelation]] = pydantic.Field(default=None) + """ + The developer lists Skills that relate to this Skill. + """ + + sections: typing.Optional[typing.List[SkillDefinitionSection]] = pydantic.Field(default=None) + """ + The developer supplies structured sections of the Skill. + """ + + stop_when: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer supplies conditions that require the workflow to stop. + """ + + task_family: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies the task-family slug. + """ + + tools: typing.Optional[typing.List[SkillResource]] = pydantic.Field(default=None) + """ + The developer supplies tool names used by the Skill. + """ + + use_when: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer supplies conditions that must hold before the Skill is used. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/skill_definition_section.py b/src/zep_cloud/types/skill_definition_section.py index 00ff402a..1dd97b15 100644 --- a/src/zep_cloud/types/skill_definition_section.py +++ b/src/zep_cloud/types/skill_definition_section.py @@ -7,9 +7,20 @@ class SkillDefinitionSection(UniversalBaseModel): - heading: typing.Optional[str] = None - id: typing.Optional[str] = None - markdown: typing.Optional[str] = None + heading: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies section heading. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer assigns a stable ID to this section. + """ + + markdown: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies skill content in Markdown. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/skill_failure.py b/src/zep_cloud/types/skill_failure.py index 64e132f0..5d1ba40a 100644 --- a/src/zep_cloud/types/skill_failure.py +++ b/src/zep_cloud/types/skill_failure.py @@ -7,8 +7,15 @@ class SkillFailure(UniversalBaseModel): - recover: typing.Optional[typing.List[str]] = None - when: typing.Optional[str] = None + recover: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer supplies steps to recover from this failure. + """ + + when: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies a condition that causes this failure. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/skill_procedure_step.py b/src/zep_cloud/types/skill_procedure_step.py index 167fa081..f408e74f 100644 --- a/src/zep_cloud/types/skill_procedure_step.py +++ b/src/zep_cloud/types/skill_procedure_step.py @@ -7,9 +7,20 @@ class SkillProcedureStep(UniversalBaseModel): - decision: typing.Optional[str] = None - expect: typing.Optional[typing.List[str]] = None - instruction: typing.Optional[str] = None + decision: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer describes the decision point for this procedure step. + """ + + expect: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer supplies expected results. + """ + + instruction: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies action for this procedure step. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/skill_relation.py b/src/zep_cloud/types/skill_relation.py index 7837b488..7d746b32 100644 --- a/src/zep_cloud/types/skill_relation.py +++ b/src/zep_cloud/types/skill_relation.py @@ -7,9 +7,20 @@ class SkillRelation(UniversalBaseModel): - relation: typing.Optional[str] = None - skill: typing.Optional[str] = None - version: typing.Optional[str] = None + relation: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies a relationship to the related Skill. + """ + + skill: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer identifies a related Skill by its stable package name. + """ + + version: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies the Agent deployment version. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/skill_resource.py b/src/zep_cloud/types/skill_resource.py index c102f15d..569e1ac7 100644 --- a/src/zep_cloud/types/skill_resource.py +++ b/src/zep_cloud/types/skill_resource.py @@ -7,9 +7,20 @@ class SkillResource(UniversalBaseModel): - aliases: typing.Optional[typing.List[str]] = None - name: typing.Optional[str] = None - version: typing.Optional[str] = None + aliases: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The developer supplies alternate names for the resource. + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies a display name. + """ + + version: typing.Optional[str] = pydantic.Field(default=None) + """ + The developer supplies the Agent deployment version. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/zep_cloud/types/source_span.py b/src/zep_cloud/types/source_span.py index ec4bfdd9..c3617774 100644 --- a/src/zep_cloud/types/source_span.py +++ b/src/zep_cloud/types/source_span.py @@ -39,7 +39,7 @@ class SourceSpan(UniversalBaseModel): model: typing.Optional[str] = pydantic.Field(default=None) """ - Model is the model identifier, when present. + The provider supplies the model name when it is available. """ name: typing.Optional[str] = pydantic.Field(default=None) diff --git a/src/zep_cloud/types/task.py b/src/zep_cloud/types/task.py index 9b44a012..d642b9b0 100644 --- a/src/zep_cloud/types/task.py +++ b/src/zep_cloud/types/task.py @@ -50,8 +50,8 @@ class Task(UniversalBaseModel): status: typing.Optional[TaskStatus] = pydantic.Field(default=None) """ - The task's current state: pending, processing, succeeded, partial, or - failed. + The service returns the task state. Valid values are pending, processing, + succeeded, partial, and failed. """ type: typing.Optional[str] = pydantic.Field(default=None) diff --git a/src/zep_cloud/types/task_family_mapping_rule.py b/src/zep_cloud/types/task_family_mapping_rule.py index 2d6ca31d..5e308081 100644 --- a/src/zep_cloud/types/task_family_mapping_rule.py +++ b/src/zep_cloud/types/task_family_mapping_rule.py @@ -10,7 +10,7 @@ class TaskFamilyMappingRule(UniversalBaseModel): fallback: typing.Optional[str] = pydantic.Field(default=None) """ - Fallback is used when the selected source has no value. + The service uses this task family when the source gives no value. The value infer asks Agent Skills to assign the task family automatically. """ key: typing.Optional[str] = pydantic.Field(default=None) @@ -25,12 +25,12 @@ class TaskFamilyMappingRule(UniversalBaseModel): source: typing.Optional[TaskFamilyMappingRuleSource] = pydantic.Field(default=None) """ - Source selects the task family source. + The service reads the task family from this source. The value infer asks Agent Skills to assign the task family automatically. """ value: typing.Optional[str] = pydantic.Field(default=None) """ - Value is the fixed task family value. + The developer supplies the task-family slug when the source is fixed. """ if IS_PYDANTIC_V2: diff --git a/src/zep_cloud/types/task_family_mapping_rule_source.py b/src/zep_cloud/types/task_family_mapping_rule_source.py index a1c425f8..2eb64c93 100644 --- a/src/zep_cloud/types/task_family_mapping_rule_source.py +++ b/src/zep_cloud/types/task_family_mapping_rule_source.py @@ -2,4 +2,6 @@ import typing -TaskFamilyMappingRuleSource = typing.Union[typing.Literal["fixed", "metadata", "tag_prefix", "name"], typing.Any] +TaskFamilyMappingRuleSource = typing.Union[ + typing.Literal["fixed", "metadata", "tag_prefix", "name", "infer"], typing.Any +] diff --git a/src/zep_cloud/types/thread_summary.py b/src/zep_cloud/types/thread_summary.py index 7a697f4b..ebed7f04 100644 --- a/src/zep_cloud/types/thread_summary.py +++ b/src/zep_cloud/types/thread_summary.py @@ -14,6 +14,11 @@ class ThreadSummary(UniversalBaseModel): The time the summary was first created. """ + graph_uuid: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the graph this thread summary belongs to. + """ + last_summarized_at: typing.Optional[str] = pydantic.Field(default=None) """ The wall-clock time of the most recent summary update. diff --git a/src/zep_cloud/types/trace_import.py b/src/zep_cloud/types/trace_import.py index 4ee8a442..329b94ee 100644 --- a/src/zep_cloud/types/trace_import.py +++ b/src/zep_cloud/types/trace_import.py @@ -23,7 +23,7 @@ class TraceImport(UniversalBaseModel): connection_uuid: typing.Optional[str] = pydantic.Field(default=None) """ - ConnectionUUID is the trace connection identifier. + The service returns the configured provider connection used by this import. """ created_at: typing.Optional[str] = pydantic.Field(default=None) @@ -83,7 +83,7 @@ class TraceImport(UniversalBaseModel): provider_project_id: typing.Optional[str] = pydantic.Field(default=None) """ - ProviderProjectID is the source project identifier. + The service returns the provider project selected for this import. """ require_review: typing.Optional[bool] = pydantic.Field(default=None) diff --git a/src/zep_cloud/types/trace_import_run.py b/src/zep_cloud/types/trace_import_run.py index 9e9a5c9b..64018f4e 100644 --- a/src/zep_cloud/types/trace_import_run.py +++ b/src/zep_cloud/types/trace_import_run.py @@ -36,7 +36,7 @@ class TraceImportRun(UniversalBaseModel): import_uuid: typing.Optional[str] = pydantic.Field(default=None) """ - ImportUUID is the owning import identifier. + The service returns the UUID of the import that owns this run. """ more_available: typing.Optional[bool] = pydantic.Field(default=None) @@ -61,7 +61,7 @@ class TraceImportRun(UniversalBaseModel): task_uuid: typing.Optional[str] = pydantic.Field(default=None) """ - TaskUUID is the Task identifier. + The service returns the Task UUID for this import run. """ trigger: typing.Optional[str] = pydantic.Field(default=None) diff --git a/src/zep_cloud/types/trace_provider_project.py b/src/zep_cloud/types/trace_provider_project.py index 3448de45..1b41c9c1 100644 --- a/src/zep_cloud/types/trace_provider_project.py +++ b/src/zep_cloud/types/trace_provider_project.py @@ -9,7 +9,8 @@ class TraceProviderProject(UniversalBaseModel): created_at: typing.Optional[str] = pydantic.Field(default=None) """ - CreatedAt is the project creation time, when the provider returns it. + The provider supplies this creation time when it has one. The service + returns it when it is available. """ id: typing.Optional[str] = pydantic.Field(default=None)