From 7def0b4838e5ab1f39e5fa55081b83976827f36b Mon Sep 17 00:00:00 2001 From: API Engineering Date: Fri, 30 Oct 2026 05:33:47 +0000 Subject: [PATCH] [bot] Updated client based on openapi-7c72344/clientgen --- DO_OPENAPI_COMMIT_SHA.txt | 2 +- src/pydo/aio/operations/_operations.py | 849 +++++++++++++++--------- src/pydo/operations/_operations.py | 884 ++++++++++++++++--------- 3 files changed, 1134 insertions(+), 601 deletions(-) diff --git a/DO_OPENAPI_COMMIT_SHA.txt b/DO_OPENAPI_COMMIT_SHA.txt index 70105338..2499c850 100644 --- a/DO_OPENAPI_COMMIT_SHA.txt +++ b/DO_OPENAPI_COMMIT_SHA.txt @@ -1 +1 @@ -e16f959 +7c72344 diff --git a/src/pydo/aio/operations/_operations.py b/src/pydo/aio/operations/_operations.py index f4266f66..09665de6 100644 --- a/src/pydo/aio/operations/_operations.py +++ b/src/pydo/aio/operations/_operations.py @@ -6290,6 +6290,9 @@ async def create( connects to. tools selects the tools and toolbelts the session exposes, and policy decides which calls run, need approval, or are refused. + Set config.cache to opt into result caching for all eligible tools or a specific list. Caching + is off by default and must be enabled for the team. + :param body: Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. @@ -6309,11 +6312,24 @@ async def create( connections the session's tool calls use, matched against connection ``user_id``. When set it must use the same alphabet as a connection's ``user_id``"" , ``[A-Za-z0-9._-]``"" , at most 64 characters; anything else is rejected with 400. - "config": {}, # Optional. Optional session options. config.preloadTools may - contain concrete tool names (optionally version-pinned) and version-pinned - toolbelt references. config.customInstructions is a string of at most 1000 - characters. config.outputViews maps up to 100 tool slugs to the name of an output - view to apply to that tool's results. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables caching for every + called tool version with a catalog cache policy, including tools that + become eligible after session creation. Do not combine with tools. True + "maxAgeSeconds": 0, # Optional. Maximum cache lifetime in + seconds for this session. Omit to use each tool's lifetime, up to 300 + seconds. A smaller tool lifetime or provider response cache header can + shorten it. Per-call max_age_seconds can require a fresher result but + cannot increase this limit. + "tools": [ + "str" # Optional. Provider-qualified tool slugs to + cache. Every listed tool must resolve for the team and have a catalog + cache policy, or session creation fails. Use slugs without version + suffixes or toolbelt references. An empty array enables no tools. + ] + } + }, "insights": { "logs": bool, # Optional. Whether the session's customer logs are sent to Insights. @@ -6366,8 +6382,26 @@ async def create( session. Empty for sessions created through this API. "agentUrn": "str", # Optional. URN of the agent that started the session. Empty for sessions created through this API. - "config": {}, # Optional. Session options as supplied at creation. - Omitted when none were supplied. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables caching for + every called tool version with a catalog cache policy, including + tools that become eligible after session creation. Do not combine + with tools. True + "maxAgeSeconds": 0, # Optional. Maximum cache + lifetime in seconds for this session. Omit to use each tool's + lifetime, up to 300 seconds. A smaller tool lifetime or provider + response cache header can shorten it. Per-call max_age_seconds can + require a fresher result but cannot increase this limit. + "tools": [ + "str" # Optional. Provider-qualified tool + slugs to cache. Every listed tool must resolve for the team and + have a catalog cache policy, or session creation fails. Use slugs + without version suffixes or toolbelt references. An empty array + enables no tools. + ] + } + }, "createdAt": "2020-02-20 00:00:00", # Optional. When the session was created. "insights": { @@ -6453,6 +6487,9 @@ async def create( connects to. tools selects the tools and toolbelts the session exposes, and policy decides which calls run, need approval, or are refused. + Set config.cache to opt into result caching for all eligible tools or a specific list. Caching + is off by default and must be enabled for the team. + :param body: Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. @@ -6476,8 +6513,26 @@ async def create( session. Empty for sessions created through this API. "agentUrn": "str", # Optional. URN of the agent that started the session. Empty for sessions created through this API. - "config": {}, # Optional. Session options as supplied at creation. - Omitted when none were supplied. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables caching for + every called tool version with a catalog cache policy, including + tools that become eligible after session creation. Do not combine + with tools. True + "maxAgeSeconds": 0, # Optional. Maximum cache + lifetime in seconds for this session. Omit to use each tool's + lifetime, up to 300 seconds. A smaller tool lifetime or provider + response cache header can shorten it. Per-call max_age_seconds can + require a fresher result but cannot increase this limit. + "tools": [ + "str" # Optional. Provider-qualified tool + slugs to cache. Every listed tool must resolve for the team and + have a catalog cache policy, or session creation fails. Use slugs + without version suffixes or toolbelt references. An empty array + enables no tools. + ] + } + }, "createdAt": "2020-02-20 00:00:00", # Optional. When the session was created. "insights": { @@ -6561,6 +6616,9 @@ async def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: connects to. tools selects the tools and toolbelts the session exposes, and policy decides which calls run, need approval, or are refused. + Set config.cache to opt into result caching for all eligible tools or a specific list. Caching + is off by default and must be enabled for the team. + :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] :return: JSON object @@ -6577,11 +6635,24 @@ async def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: connections the session's tool calls use, matched against connection ``user_id``. When set it must use the same alphabet as a connection's ``user_id``"" , ``[A-Za-z0-9._-]``"" , at most 64 characters; anything else is rejected with 400. - "config": {}, # Optional. Optional session options. config.preloadTools may - contain concrete tool names (optionally version-pinned) and version-pinned - toolbelt references. config.customInstructions is a string of at most 1000 - characters. config.outputViews maps up to 100 tool slugs to the name of an output - view to apply to that tool's results. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables caching for every + called tool version with a catalog cache policy, including tools that + become eligible after session creation. Do not combine with tools. True + "maxAgeSeconds": 0, # Optional. Maximum cache lifetime in + seconds for this session. Omit to use each tool's lifetime, up to 300 + seconds. A smaller tool lifetime or provider response cache header can + shorten it. Per-call max_age_seconds can require a fresher result but + cannot increase this limit. + "tools": [ + "str" # Optional. Provider-qualified tool slugs to + cache. Every listed tool must resolve for the team and have a catalog + cache policy, or session creation fails. Use slugs without version + suffixes or toolbelt references. An empty array enables no tools. + ] + } + }, "insights": { "logs": bool, # Optional. Whether the session's customer logs are sent to Insights. @@ -6634,8 +6705,26 @@ async def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: session. Empty for sessions created through this API. "agentUrn": "str", # Optional. URN of the agent that started the session. Empty for sessions created through this API. - "config": {}, # Optional. Session options as supplied at creation. - Omitted when none were supplied. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables caching for + every called tool version with a catalog cache policy, including + tools that become eligible after session creation. Do not combine + with tools. True + "maxAgeSeconds": 0, # Optional. Maximum cache + lifetime in seconds for this session. Omit to use each tool's + lifetime, up to 300 seconds. A smaller tool lifetime or provider + response cache header can shorten it. Per-call max_age_seconds can + require a fresher result but cannot increase this limit. + "tools": [ + "str" # Optional. Provider-qualified tool + slugs to cache. Every listed tool must resolve for the team and + have a catalog cache policy, or session creation fails. Use slugs + without version suffixes or toolbelt references. An empty array + enables no tools. + ] + } + }, "createdAt": "2020-02-20 00:00:00", # Optional. When the session was created. "insights": { @@ -6845,8 +6934,27 @@ async def list( started the session. Empty for sessions created through this API. "agentUrn": "str", # Optional. URN of the agent that started the session. Empty for sessions created through this API. - "config": {}, # Optional. Session options as supplied at - creation. Omitted when none were supplied. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables + caching for every called tool version with a catalog cache + policy, including tools that become eligible after session + creation. Do not combine with tools. True + "maxAgeSeconds": 0, # Optional. Maximum + cache lifetime in seconds for this session. Omit to use each + tool's lifetime, up to 300 seconds. A smaller tool lifetime or + provider response cache header can shorten it. Per-call + max_age_seconds can require a fresher result but cannot increase + this limit. + "tools": [ + "str" # Optional. Provider-qualified + tool slugs to cache. Every listed tool must resolve for the + team and have a catalog cache policy, or session creation + fails. Use slugs without version suffixes or toolbelt + references. An empty array enables no tools. + ] + } + }, "createdAt": "2020-02-20 00:00:00", # Optional. When the session was created. "insights": { @@ -7023,8 +7131,27 @@ async def list_search( started the session. Empty for sessions created through this API. "agentUrn": "str", # Optional. URN of the agent that started the session. Empty for sessions created through this API. - "config": {}, # Optional. Session options as supplied at - creation. Omitted when none were supplied. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables + caching for every called tool version with a catalog cache + policy, including tools that become eligible after session + creation. Do not combine with tools. True + "maxAgeSeconds": 0, # Optional. Maximum + cache lifetime in seconds for this session. Omit to use each + tool's lifetime, up to 300 seconds. A smaller tool lifetime or + provider response cache header can shorten it. Per-call + max_age_seconds can require a fresher result but cannot increase + this limit. + "tools": [ + "str" # Optional. Provider-qualified + tool slugs to cache. Every listed tool must resolve for the + team and have a catalog cache policy, or session creation + fails. Use slugs without version suffixes or toolbelt + references. An empty array enables no tools. + ] + } + }, "createdAt": "2020-02-20 00:00:00", # Optional. When the session was created. "insights": { @@ -9439,6 +9566,10 @@ async def list( the tool requests. ] }, + "cache": { + "ttlSeconds": 0 # Maximum cache lifetime in seconds + for this tool version. Required. + }, "description": "str", # Optional. What the tool does. "inputSchema": {}, # Optional. The JSON Schema the tool's arguments must satisfy. @@ -11487,16 +11618,14 @@ async def list_search( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -11522,6 +11651,13 @@ async def list_search( query in the request. "results": [ { + "cache": { + "maxAgeSeconds": 0 # Maximum + result age the session allows, or 300 if the session sets + no limit. The tool's own cache lifetime can be shorter. + Invoke controls use max_age_seconds, not this field's + camelCase spelling. Required. + }, "description": "str", # Optional. One result group per query, in request order. "inputSchema": { @@ -11622,16 +11758,14 @@ async def list_search( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -11657,6 +11791,13 @@ async def list_search( query in the request. "results": [ { + "cache": { + "maxAgeSeconds": 0 # Maximum + result age the session allows, or 300 if the session sets + no limit. The tool's own cache lifetime can be shorter. + Invoke controls use max_age_seconds, not this field's + camelCase spelling. Required. + }, "description": "str", # Optional. One result group per query, in request order. "inputSchema": { @@ -11773,16 +11914,14 @@ async def list_search( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -11808,6 +11947,13 @@ async def list_search( query in the request. "results": [ { + "cache": { + "maxAgeSeconds": 0 # Maximum + result age the session allows, or 300 if the session sets + no limit. The tool's own cache lifetime can be shorter. + Invoke controls use max_age_seconds, not this field's + camelCase spelling. Required. + }, "description": "str", # Optional. One result group per query, in request order. "inputSchema": { @@ -12004,6 +12150,11 @@ async def run( needs the end user to connect a provider fails with ``_meta.status`` set to ``requires_authorization`` or ``requires_connection_configuration``. + Tools opted into result caching use the session's settings automatically. Set cache on an + individual tools entry to bypass caching or require a fresher result. The result's _meta.cache + reports cache hits. Hits still incur the standard gateway invocation charge but no additional + provider charge, because the provider is not called. + :param body: Required. :type body: JSON :keyword x_session_id: The session to act in: the UUID at the end of the session's @@ -12030,6 +12181,18 @@ async def run( "str": {} # Optional. The tool's arguments, matching its ``inputSchema``. }, + "cache": { + "max_age_seconds": 0, # Optional. Oldest cached + result this call accepts, in seconds. Zero bypasses caching. Values + above 300 are clamped to 300; larger values cannot increase the + session or tool lifetime. This controls accepted result age, not the + lifetime of a newly stored entry. + "mode": "auto" # Optional. Default value is "auto". + auto uses a sufficiently recent cached result or calls the provider + and can store a successful result. bypass skips lookup and storage + without clearing or refreshing existing entries. Known values are: + "auto" and "bypass". + }, "version": "str" # Optional. An immutable tool version. Omit to use the released version. } @@ -12051,18 +12214,15 @@ async def run( "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result - metadata. Keys include: * ``status``"" : - ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped - before running. * ``approval_id``"" , ``tool_name``"" , - ``expires_at``"" , and ``decide``"" : present with - ``requires_approval``. ``decide`` gives the ``method``"" , - ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": - bool}` when the gateway retried the call. * - ``output_view``"" : the output view applied to the result. + "cache": { + "status": "str", # HIT returned a + cached result without calling the provider. MISS found no + usable result and called the provider. BYPASS skipped + caching. Required. Known values are: "HIT", "MISS", and + "BYPASS". + "age_seconds": 0 # Optional. Age of + the cached result in seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure @@ -12155,6 +12315,11 @@ async def run( needs the end user to connect a provider fails with ``_meta.status`` set to ``requires_authorization`` or ``requires_connection_configuration``. + Tools opted into result caching use the session's settings automatically. Set cache on an + individual tools entry to bypass caching or require a fresher result. The result's _meta.cache + reports cache hits. Hits still incur the standard gateway invocation charge but no additional + provider charge, because the provider is not called. + :param body: Required. :type body: IO[bytes] :keyword x_session_id: The session to act in: the UUID at the end of the session's @@ -12184,18 +12349,15 @@ async def run( "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result - metadata. Keys include: * ``status``"" : - ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped - before running. * ``approval_id``"" , ``tool_name``"" , - ``expires_at``"" , and ``decide``"" : present with - ``requires_approval``. ``decide`` gives the ``method``"" , - ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": - bool}` when the gateway retried the call. * - ``output_view``"" : the output view applied to the result. + "cache": { + "status": "str", # HIT returned a + cached result without calling the provider. MISS found no + usable result and called the provider. BYPASS skipped + caching. Required. Known values are: "HIT", "MISS", and + "BYPASS". + "age_seconds": 0 # Optional. Age of + the cached result in seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure @@ -12283,6 +12445,11 @@ async def run( needs the end user to connect a provider fails with ``_meta.status`` set to ``requires_authorization`` or ``requires_connection_configuration``. + Tools opted into result caching use the session's settings automatically. Set cache on an + individual tools entry to bypass caching or require a fresher result. The result's _meta.cache + reports cache hits. Hits still incur the standard gateway invocation charge but no additional + provider charge, because the provider is not called. + :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] :keyword x_session_id: The session to act in: the UUID at the end of the session's @@ -12306,6 +12473,18 @@ async def run( "str": {} # Optional. The tool's arguments, matching its ``inputSchema``. }, + "cache": { + "max_age_seconds": 0, # Optional. Oldest cached + result this call accepts, in seconds. Zero bypasses caching. Values + above 300 are clamped to 300; larger values cannot increase the + session or tool lifetime. This controls accepted result age, not the + lifetime of a newly stored entry. + "mode": "auto" # Optional. Default value is "auto". + auto uses a sufficiently recent cached result or calls the provider + and can store a successful result. bypass skips lookup and storage + without clearing or refreshing existing entries. Known values are: + "auto" and "bypass". + }, "version": "str" # Optional. An immutable tool version. Omit to use the released version. } @@ -12327,18 +12506,15 @@ async def run( "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result - metadata. Keys include: * ``status``"" : - ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped - before running. * ``approval_id``"" , ``tool_name``"" , - ``expires_at``"" , and ``decide``"" : present with - ``requires_approval``. ``decide`` gives the ``method``"" , - ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": - bool}` when the gateway retried the call. * - ``output_view``"" : the output view applied to the result. + "cache": { + "status": "str", # HIT returned a + cached result without calling the provider. MISS found no + usable result and called the provider. BYPASS skipped + caching. Required. Known values are: "HIT", "MISS", and + "BYPASS". + "age_seconds": 0 # Optional. Age of + the cached result in seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure @@ -12611,16 +12787,14 @@ async def run( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -12725,16 +12899,14 @@ async def run( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -12838,16 +13010,14 @@ async def run( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -20799,7 +20969,7 @@ async def list_config_sessions( with 409. Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. - Drives the inactivity policy that destroys idle sessions. + Drives the inactivity policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the @@ -21071,7 +21241,7 @@ async def list_sessions( with 409. Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. - Drives the inactivity policy that destroys idle sessions. + Drives the inactivity policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the @@ -21369,7 +21539,7 @@ async def create_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -21554,7 +21724,7 @@ async def create_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -21749,7 +21919,7 @@ async def create_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -22579,7 +22749,7 @@ async def get_session(self, session_id: str, **kwargs: Any) -> JSON: Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -22844,7 +23014,7 @@ async def update_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -22992,7 +23162,7 @@ async def update_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -23140,7 +23310,7 @@ async def update_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -24359,7 +24529,7 @@ async def revert_session_checkpoint( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -24678,7 +24848,7 @@ async def create_session_fork( with 409. Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. - Drives the inactivity policy that destroys idle sessions. + Drives the inactivity policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the @@ -24834,7 +25004,7 @@ async def create_session_fork( with 409. Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. - Drives the inactivity policy that destroys idle sessions. + Drives the inactivity policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the @@ -24995,7 +25165,7 @@ async def create_session_fork( with 409. Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. - Drives the inactivity policy that destroys idle sessions. + Drives the inactivity policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the @@ -163944,6 +164114,8 @@ class of Droplets created from this size. For example: Basic, General Droplets of this size. Required. "disk_info": [ { + "ephemeral": bool, # Optional. + Indicates an ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -163994,6 +164166,8 @@ class of Droplets created from this size. For example: Basic, General ], "disk_info": [ { + "ephemeral": bool, # Optional. Indicates an + ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -164625,6 +164799,8 @@ async def get(self, droplet_id: int, **kwargs: Any) -> JSON: this size. Required. "disk_info": [ { + "ephemeral": bool, # Optional. Indicates an + ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -164672,6 +164848,8 @@ async def get(self, droplet_id: int, **kwargs: Any) -> JSON: ], "disk_info": [ { + "ephemeral": bool, # Optional. Indicates an + ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -166215,6 +166393,8 @@ class of Droplets created from this size. For example: Basic, General Droplets of this size. Required. "disk_info": [ { + "ephemeral": bool, # Optional. + Indicates an ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -166265,6 +166445,8 @@ class of Droplets created from this size. For example: Basic, General ], "disk_info": [ { + "ephemeral": bool, # Optional. Indicates an + ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -188149,8 +188331,10 @@ async def list_consents( Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when + present. Dual-emitted during the rename; omitted when agent_id is empty. } ], "source": "str" # Optional. Echoes the ``source`` filter when the request @@ -188267,14 +188451,14 @@ async def update_team_consent( To revoke consent, send the same request with ``enabled`` set to ``false``. The ``source`` query parameter is required. Per-environment consent for Harness - Runtime environments is managed with ``PUT /v1/consent/{agent_id}`` instead. + Runtime environments is managed with ``PUT /v1/consent/{environment_id}`` instead. :param body: Required. :type body: JSON :keyword source: The consent source to update. Only team-level sources are accepted on this endpoint; currently ``inference`` (Serverless Inference chat completions). Per-environment - consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{agent_id}`` instead. "inference" - Required. + consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{environment_id}`` instead. + "inference" Required. :paramtype source: str :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -188308,8 +188492,10 @@ async def update_team_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400 @@ -188345,14 +188531,14 @@ async def update_team_consent( To revoke consent, send the same request with ``enabled`` set to ``false``. The ``source`` query parameter is required. Per-environment consent for Harness - Runtime environments is managed with ``PUT /v1/consent/{agent_id}`` instead. + Runtime environments is managed with ``PUT /v1/consent/{environment_id}`` instead. :param body: Required. :type body: IO[bytes] :keyword source: The consent source to update. Only team-level sources are accepted on this endpoint; currently ``inference`` (Serverless Inference chat completions). Per-environment - consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{agent_id}`` instead. "inference" - Required. + consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{environment_id}`` instead. + "inference" Required. :paramtype source: str :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -188380,8 +188566,10 @@ async def update_team_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400 @@ -188412,14 +188600,14 @@ async def update_team_consent( To revoke consent, send the same request with ``enabled`` set to ``false``. The ``source`` query parameter is required. Per-environment consent for Harness - Runtime environments is managed with ``PUT /v1/consent/{agent_id}`` instead. + Runtime environments is managed with ``PUT /v1/consent/{environment_id}`` instead. :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] :keyword source: The consent source to update. Only team-level sources are accepted on this endpoint; currently ``inference`` (Serverless Inference chat completions). Per-environment - consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{agent_id}`` instead. "inference" - Required. + consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{environment_id}`` instead. + "inference" Required. :paramtype source: str :return: JSON object :rtype: JSON @@ -188450,8 +188638,10 @@ async def update_team_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400 @@ -188559,20 +188749,20 @@ async def update_team_consent( return cast(JSON, deserialized) # type: ignore @distributed_trace_async - async def get_consent(self, agent_id: str, **kwargs: Any) -> JSON: + async def get_consent(self, environment_id: str, **kwargs: Any) -> JSON: # pylint: disable=line-too-long """Retrieve Consent for an Environment. To retrieve the consent record for a specific environment, send a GET - request to ``/v1/consent/{agent_id}``. The response includes an ``enabled`` + request to ``/v1/consent/{environment_id}``. The response includes an ``enabled`` field indicating whether signals collection is on for this environment. This endpoint only serves per-environment (\\ ``source: agent``\\ ) records. Team-level inference consent is read from ``GET /v1/consent?source=inference``. - :param agent_id: A unique identifier for an environment. For Harness Runtime, this is the - Environment Config ID. Required. - :type agent_id: str + :param environment_id: A unique identifier for an environment. For Harness Runtime, this is the + Environment Config ID. Formerly named agent_id. Required. + :type environment_id: str :return: JSON object :rtype: JSON :raises ~azure.core.exceptions.HttpResponseError: @@ -188586,6 +188776,8 @@ async def get_consent(self, agent_id: str, **kwargs: Any) -> JSON: Runtime, this is the Environment Config ID. Required. "enabled": bool, # Whether signals collection is enabled for this environment. Required. + "environment_id": "str", # Same as agent_id. Dual-emitted during the rename. + Required. "source": "str", # The source this consent applies to. Always ``agent`` for per-environment records returned by this endpoint. Required. "agent" "team_id": 0, # The team ID that owns this consent record. Required. @@ -188624,7 +188816,7 @@ async def get_consent(self, agent_id: str, **kwargs: Any) -> JSON: cls: ClsType[JSON] = kwargs.pop("cls", None) _request = build_signals_get_consent_request( - agent_id=agent_id, + environment_id=environment_id, headers=_headers, params=_params, ) @@ -188702,7 +188894,7 @@ async def get_consent(self, agent_id: str, **kwargs: Any) -> JSON: @overload async def update_consent( self, - agent_id: str, + environment_id: str, body: JSON, *, content_type: str = "application/json", @@ -188712,16 +188904,16 @@ async def update_consent( """Update Consent for an Environment. To enable or disable signals collection for a specific environment, send a - PUT request to ``/v1/consent/{agent_id}`` with an ``enabled`` boolean in the + PUT request to ``/v1/consent/{environment_id}`` with an ``enabled`` boolean in the request body. This endpoint only manages per-environment (\\ ``source: agent``\\ ) consent. To manage team-level consent for Serverless Inference, use ``PUT /v1/consent?source=inference`` instead. - :param agent_id: A unique identifier for an environment. For Harness Runtime, this is the - Environment Config ID. Required. - :type agent_id: str + :param environment_id: A unique identifier for an environment. For Harness Runtime, this is the + Environment Config ID. Formerly named agent_id. Required. + :type environment_id: str :param body: Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. @@ -188756,8 +188948,10 @@ async def update_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400, 404 @@ -188776,7 +188970,7 @@ async def update_consent( @overload async def update_consent( self, - agent_id: str, + environment_id: str, body: IO[bytes], *, content_type: str = "application/json", @@ -188786,16 +188980,16 @@ async def update_consent( """Update Consent for an Environment. To enable or disable signals collection for a specific environment, send a - PUT request to ``/v1/consent/{agent_id}`` with an ``enabled`` boolean in the + PUT request to ``/v1/consent/{environment_id}`` with an ``enabled`` boolean in the request body. This endpoint only manages per-environment (\\ ``source: agent``\\ ) consent. To manage team-level consent for Serverless Inference, use ``PUT /v1/consent?source=inference`` instead. - :param agent_id: A unique identifier for an environment. For Harness Runtime, this is the - Environment Config ID. Required. - :type agent_id: str + :param environment_id: A unique identifier for an environment. For Harness Runtime, this is the + Environment Config ID. Formerly named agent_id. Required. + :type environment_id: str :param body: Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. @@ -188824,8 +189018,10 @@ async def update_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400, 404 @@ -188843,22 +189039,22 @@ async def update_consent( @distributed_trace_async async def update_consent( - self, agent_id: str, body: Union[JSON, IO[bytes]], **kwargs: Any + self, environment_id: str, body: Union[JSON, IO[bytes]], **kwargs: Any ) -> JSON: # pylint: disable=line-too-long """Update Consent for an Environment. To enable or disable signals collection for a specific environment, send a - PUT request to ``/v1/consent/{agent_id}`` with an ``enabled`` boolean in the + PUT request to ``/v1/consent/{environment_id}`` with an ``enabled`` boolean in the request body. This endpoint only manages per-environment (\\ ``source: agent``\\ ) consent. To manage team-level consent for Serverless Inference, use ``PUT /v1/consent?source=inference`` instead. - :param agent_id: A unique identifier for an environment. For Harness Runtime, this is the - Environment Config ID. Required. - :type agent_id: str + :param environment_id: A unique identifier for an environment. For Harness Runtime, this is the + Environment Config ID. Formerly named agent_id. Required. + :type environment_id: str :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] :return: JSON object @@ -188890,8 +189086,10 @@ async def update_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400, 404 @@ -188936,7 +189134,7 @@ async def update_consent( _json = body _request = build_signals_update_consent_request( - agent_id=agent_id, + environment_id=environment_id, content_type=content_type, json=_json, content=_content, @@ -189017,7 +189215,7 @@ async def update_consent( @distributed_trace_async async def list_agent_sessions( self, - agent_id: str, + environment_id: str, *, limit: int = 20, after: Optional[str] = None, @@ -189030,12 +189228,12 @@ async def list_agent_sessions( """List Sessions for an Environment. To list signals sessions for a specific environment, send a GET request to - ``/v1/signals/agents/{agent_id}/sessions``. Results are paginated using cursor-based + ``/v1/signals/agents/{environment_id}/sessions``. Results are paginated using cursor-based pagination with ``limit`` and ``after`` parameters. - :param agent_id: A unique identifier for an environment. For Harness Runtime, this is the - Environment Config ID. Required. - :type agent_id: str + :param environment_id: A unique identifier for an environment. For Harness Runtime, this is the + Environment Config ID. Formerly named agent_id. Required. + :type environment_id: str :keyword limit: Maximum number of items to return per page. Default value is 20. :paramtype limit: int :keyword after: An opaque cursor string returned from a previous page. Pass this value to @@ -189113,7 +189311,7 @@ async def list_agent_sessions( cls: ClsType[JSON] = kwargs.pop("cls", None) _request = build_signals_list_agent_sessions_request( - agent_id=agent_id, + environment_id=environment_id, limit=limit, after=after, start_time=start_time, @@ -189344,7 +189542,13 @@ async def list_session_dialogues( @distributed_trace_async async def list_exports( - self, *, limit: int = 20, after: Optional[str] = None, **kwargs: Any + self, + *, + environment_id: Optional[str] = None, + agent_id: Optional[str] = None, + limit: int = 20, + after: Optional[str] = None, + **kwargs: Any ) -> JSON: # pylint: disable=line-too-long """List Export Jobs. @@ -189353,6 +189557,12 @@ async def list_exports( ``/v1/signals/exports``. Results are paginated using cursor-based pagination with ``limit`` and ``after`` parameters. + :keyword environment_id: Optional filter by environment ID. Default value is None. + :paramtype environment_id: str + :keyword agent_id: Deprecated alias for environment_id. Accepted for backward compatibility; + must equal environment_id when both are set. Both set and different returns 400. Default value + is None. + :paramtype agent_id: str :keyword limit: Maximum number of items to return per page. Default value is 20. :paramtype limit: int :keyword after: An opaque cursor string returned from a previous page. Pass this value to @@ -189372,23 +189582,10 @@ async def list_exports( "cursor": "str", # Optional. An opaque cursor for pagination. "node": { - "agent_id": "str", # The environment whose data is - being exported. For Harness Runtime, this is the Environment Config - ID. Not meaningful for ``inference`` exports; use ``type`` to - distinguish the export scope. Required. "created_at": 0, # Unix timestamp when the export was created. Required. "export_id": "str", # The unique identifier for the export job. Required. - "status": "str", # The current status of the export - job. Required. Known values are: "pending", "processing", "complete", - and "failed". - "completed_at": 0, # Optional. Unix timestamp when - the export completed, or null if still in progress. - "error_message": "str", # Optional. Error message if - the export failed, or null on success. - "expires_at": 0, # Optional. Unix timestamp when the - export download link expires. "filters": { "session_ids": [ "str" # Optional. Specific session @@ -189399,6 +189596,21 @@ async def list_exports( included in the export. ] }, + "status": "str", # The current status of the export + job. Required. Known values are: "pending", "processing", "complete", + and "failed". + "agent_id": "str", # Optional. The environment whose + data is being exported. For Harness Runtime, this is the Environment + Config ID. Not meaningful for ``inference`` exports; use ``type`` to + distinguish the export scope. + "completed_at": 0, # Optional. Unix timestamp when + the export completed, or null if still in progress. + "environment_id": "str", # Optional. Same as + agent_id. Dual-emitted during the rename. + "error_message": "str", # Optional. Error message if + the export failed, or null on success. + "expires_at": 0, # Optional. Unix timestamp when the + export download link expires. "type": "str" # Optional. The scope of the export. ``agent`` covers one Harness Runtime environment; ``inference`` covers the team's Serverless Inference Signals conversations. Known @@ -189431,6 +189643,8 @@ async def list_exports( cls: ClsType[JSON] = kwargs.pop("cls", None) _request = build_signals_list_exports_request( + environment_id=environment_id, + agent_id=agent_id, limit=limit, after=after, headers=_headers, @@ -189483,9 +189697,10 @@ async def create_export( To create a new signals data export, send a POST request to ``/v1/signals/exports``. To export one Harness Runtime environment, include its - ``agent_id`` (\\ ``type`` defaults to ``agent``\\ ). To export the team's Serverless - Inference Signals conversations, set ``type`` to ``inference`` and omit - ``agent_id``. You may optionally filter the export by ``signal_type``\\ , + ``environment_id`` (\\ ``type`` defaults to ``agent``\\ ). Deprecated ``agent_id`` is still + accepted. To export the team's Serverless Inference Signals conversations, set + ``type`` to ``inference`` and omit ``environment_id`` and ``agent_id``. You may + optionally filter the export by ``signal_type``\\ , ``session_ids``\\ , ``start_time``\\ , and ``end_time``. Use the export options endpoint to discover available signal types. @@ -189507,11 +189722,16 @@ async def create_export( # JSON input template you can fill out and use as your body input. body = { - "agent_id": "str", # Optional. The environment whose data should be - exported. For Harness Runtime, this is the Environment Config ID. Required when - ``type`` is ``agent``"" ; must be omitted when ``type`` is ``inference``. + "agent_id": "str", # Optional. Deprecated alias for ``environment_id``. + Accepted for backward compatibility; must equal ``environment_id`` when both are + set. Both set and different returns 400. Required when ``type`` is ``agent`` if + ``environment_id`` is omitted; must be omitted when ``type`` is ``inference``. "end_time": "2020-02-20 00:00:00", # Optional. Include only sessions that started at or before this timestamp. + "environment_id": "str", # Optional. The environment whose data should be + exported. For Harness Runtime, this is the Environment Config ID. Required when + ``type`` is ``agent`` if ``agent_id`` is omitted; must be omitted when ``type`` + is ``inference``. Prefer this over ``agent_id``. "session_ids": [ "str" # Optional. Optional list of specific session IDs to include in the export. @@ -189523,28 +189743,18 @@ async def create_export( "start_time": "2020-02-20 00:00:00", # Optional. Include only sessions that started at or after this timestamp. "type": "str" # Optional. The scope of the export. ``agent`` exports Signals - conversations for one Harness Runtime environment and requires ``agent_id``. - ``inference`` exports Serverless Inference Signals conversations for the whole - team (team-wide; omit ``agent_id``"" ). Defaults to ``agent`` when ``agent_id`` - is provided and to ``inference`` when it is omitted. Known values are: "agent" + conversations for one Harness Runtime environment and requires ``environment_id`` + (or deprecated ``agent_id``"" ). ``inference`` exports Serverless Inference + Signals conversations for the whole team (team-wide; omit ``environment_id`` and + ``agent_id``"" ). Defaults to ``agent`` when ``environment_id`` or ``agent_id`` + is provided and to ``inference`` when both are omitted. Known values are: "agent" and "inference". } # response body for status code(s): 201 response == { - "agent_id": "str", # The environment whose data is being exported. For - Harness Runtime, this is the Environment Config ID. Not meaningful for - ``inference`` exports; use ``type`` to distinguish the export scope. Required. "created_at": 0, # Unix timestamp when the export was created. Required. "export_id": "str", # The unique identifier for the export job. Required. - "status": "str", # The current status of the export job. Required. Known - values are: "pending", "processing", "complete", and "failed". - "completed_at": 0, # Optional. Unix timestamp when the export completed, or - null if still in progress. - "error_message": "str", # Optional. Error message if the export failed, or - null on success. - "expires_at": 0, # Optional. Unix timestamp when the export download link - expires. "filters": { "session_ids": [ "str" # Optional. Specific session IDs included in the @@ -189554,6 +189764,19 @@ async def create_export( "str" # Optional. Signal types included in the export. ] }, + "status": "str", # The current status of the export job. Required. Known + values are: "pending", "processing", "complete", and "failed". + "agent_id": "str", # Optional. The environment whose data is being exported. + For Harness Runtime, this is the Environment Config ID. Not meaningful for + ``inference`` exports; use ``type`` to distinguish the export scope. + "completed_at": 0, # Optional. Unix timestamp when the export completed, or + null if still in progress. + "environment_id": "str", # Optional. Same as agent_id. Dual-emitted during + the rename. + "error_message": "str", # Optional. Error message if the export failed, or + null on success. + "expires_at": 0, # Optional. Unix timestamp when the export download link + expires. "type": "str" # Optional. The scope of the export. ``agent`` covers one Harness Runtime environment; ``inference`` covers the team's Serverless Inference Signals conversations. Known values are: "agent" and "inference". @@ -189580,9 +189803,10 @@ async def create_export( To create a new signals data export, send a POST request to ``/v1/signals/exports``. To export one Harness Runtime environment, include its - ``agent_id`` (\\ ``type`` defaults to ``agent``\\ ). To export the team's Serverless - Inference Signals conversations, set ``type`` to ``inference`` and omit - ``agent_id``. You may optionally filter the export by ``signal_type``\\ , + ``environment_id`` (\\ ``type`` defaults to ``agent``\\ ). Deprecated ``agent_id`` is still + accepted. To export the team's Serverless Inference Signals conversations, set + ``type`` to ``inference`` and omit ``environment_id`` and ``agent_id``. You may + optionally filter the export by ``signal_type``\\ , ``session_ids``\\ , ``start_time``\\ , and ``end_time``. Use the export options endpoint to discover available signal types. @@ -189604,19 +189828,8 @@ async def create_export( # response body for status code(s): 201 response == { - "agent_id": "str", # The environment whose data is being exported. For - Harness Runtime, this is the Environment Config ID. Not meaningful for - ``inference`` exports; use ``type`` to distinguish the export scope. Required. "created_at": 0, # Unix timestamp when the export was created. Required. "export_id": "str", # The unique identifier for the export job. Required. - "status": "str", # The current status of the export job. Required. Known - values are: "pending", "processing", "complete", and "failed". - "completed_at": 0, # Optional. Unix timestamp when the export completed, or - null if still in progress. - "error_message": "str", # Optional. Error message if the export failed, or - null on success. - "expires_at": 0, # Optional. Unix timestamp when the export download link - expires. "filters": { "session_ids": [ "str" # Optional. Specific session IDs included in the @@ -189626,6 +189839,19 @@ async def create_export( "str" # Optional. Signal types included in the export. ] }, + "status": "str", # The current status of the export job. Required. Known + values are: "pending", "processing", "complete", and "failed". + "agent_id": "str", # Optional. The environment whose data is being exported. + For Harness Runtime, this is the Environment Config ID. Not meaningful for + ``inference`` exports; use ``type`` to distinguish the export scope. + "completed_at": 0, # Optional. Unix timestamp when the export completed, or + null if still in progress. + "environment_id": "str", # Optional. Same as agent_id. Dual-emitted during + the rename. + "error_message": "str", # Optional. Error message if the export failed, or + null on success. + "expires_at": 0, # Optional. Unix timestamp when the export download link + expires. "type": "str" # Optional. The scope of the export. ``agent`` covers one Harness Runtime environment; ``inference`` covers the team's Serverless Inference Signals conversations. Known values are: "agent" and "inference". @@ -189650,9 +189876,10 @@ async def create_export(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JS To create a new signals data export, send a POST request to ``/v1/signals/exports``. To export one Harness Runtime environment, include its - ``agent_id`` (\\ ``type`` defaults to ``agent``\\ ). To export the team's Serverless - Inference Signals conversations, set ``type`` to ``inference`` and omit - ``agent_id``. You may optionally filter the export by ``signal_type``\\ , + ``environment_id`` (\\ ``type`` defaults to ``agent``\\ ). Deprecated ``agent_id`` is still + accepted. To export the team's Serverless Inference Signals conversations, set + ``type`` to ``inference`` and omit ``environment_id`` and ``agent_id``. You may + optionally filter the export by ``signal_type``\\ , ``session_ids``\\ , ``start_time``\\ , and ``end_time``. Use the export options endpoint to discover available signal types. @@ -189671,11 +189898,16 @@ async def create_export(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JS # JSON input template you can fill out and use as your body input. body = { - "agent_id": "str", # Optional. The environment whose data should be - exported. For Harness Runtime, this is the Environment Config ID. Required when - ``type`` is ``agent``"" ; must be omitted when ``type`` is ``inference``. + "agent_id": "str", # Optional. Deprecated alias for ``environment_id``. + Accepted for backward compatibility; must equal ``environment_id`` when both are + set. Both set and different returns 400. Required when ``type`` is ``agent`` if + ``environment_id`` is omitted; must be omitted when ``type`` is ``inference``. "end_time": "2020-02-20 00:00:00", # Optional. Include only sessions that started at or before this timestamp. + "environment_id": "str", # Optional. The environment whose data should be + exported. For Harness Runtime, this is the Environment Config ID. Required when + ``type`` is ``agent`` if ``agent_id`` is omitted; must be omitted when ``type`` + is ``inference``. Prefer this over ``agent_id``. "session_ids": [ "str" # Optional. Optional list of specific session IDs to include in the export. @@ -189687,28 +189919,18 @@ async def create_export(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JS "start_time": "2020-02-20 00:00:00", # Optional. Include only sessions that started at or after this timestamp. "type": "str" # Optional. The scope of the export. ``agent`` exports Signals - conversations for one Harness Runtime environment and requires ``agent_id``. - ``inference`` exports Serverless Inference Signals conversations for the whole - team (team-wide; omit ``agent_id``"" ). Defaults to ``agent`` when ``agent_id`` - is provided and to ``inference`` when it is omitted. Known values are: "agent" + conversations for one Harness Runtime environment and requires ``environment_id`` + (or deprecated ``agent_id``"" ). ``inference`` exports Serverless Inference + Signals conversations for the whole team (team-wide; omit ``environment_id`` and + ``agent_id``"" ). Defaults to ``agent`` when ``environment_id`` or ``agent_id`` + is provided and to ``inference`` when both are omitted. Known values are: "agent" and "inference". } # response body for status code(s): 201 response == { - "agent_id": "str", # The environment whose data is being exported. For - Harness Runtime, this is the Environment Config ID. Not meaningful for - ``inference`` exports; use ``type`` to distinguish the export scope. Required. "created_at": 0, # Unix timestamp when the export was created. Required. "export_id": "str", # The unique identifier for the export job. Required. - "status": "str", # The current status of the export job. Required. Known - values are: "pending", "processing", "complete", and "failed". - "completed_at": 0, # Optional. Unix timestamp when the export completed, or - null if still in progress. - "error_message": "str", # Optional. Error message if the export failed, or - null on success. - "expires_at": 0, # Optional. Unix timestamp when the export download link - expires. "filters": { "session_ids": [ "str" # Optional. Specific session IDs included in the @@ -189718,6 +189940,19 @@ async def create_export(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JS "str" # Optional. Signal types included in the export. ] }, + "status": "str", # The current status of the export job. Required. Known + values are: "pending", "processing", "complete", and "failed". + "agent_id": "str", # Optional. The environment whose data is being exported. + For Harness Runtime, this is the Environment Config ID. Not meaningful for + ``inference`` exports; use ``type`` to distinguish the export scope. + "completed_at": 0, # Optional. Unix timestamp when the export completed, or + null if still in progress. + "environment_id": "str", # Optional. Same as agent_id. Dual-emitted during + the rename. + "error_message": "str", # Optional. Error message if the export failed, or + null on success. + "expires_at": 0, # Optional. Unix timestamp when the export download link + expires. "type": "str" # Optional. The scope of the export. ``agent`` covers one Harness Runtime environment; ``inference`` covers the team's Serverless Inference Signals conversations. Known values are: "agent" and "inference". @@ -189945,19 +190180,8 @@ async def get_export(self, export_id: str, **kwargs: Any) -> JSON: # response body for status code(s): 200 response == { - "agent_id": "str", # The environment whose data is being exported. For - Harness Runtime, this is the Environment Config ID. Not meaningful for - ``inference`` exports; use ``type`` to distinguish the export scope. Required. "created_at": 0, # Unix timestamp when the export was created. Required. "export_id": "str", # The unique identifier for the export job. Required. - "status": "str", # The current status of the export job. Required. Known - values are: "pending", "processing", "complete", and "failed". - "completed_at": 0, # Optional. Unix timestamp when the export completed, or - null if still in progress. - "error_message": "str", # Optional. Error message if the export failed, or - null on success. - "expires_at": 0, # Optional. Unix timestamp when the export download link - expires. "filters": { "session_ids": [ "str" # Optional. Specific session IDs included in the @@ -189967,6 +190191,19 @@ async def get_export(self, export_id: str, **kwargs: Any) -> JSON: "str" # Optional. Signal types included in the export. ] }, + "status": "str", # The current status of the export job. Required. Known + values are: "pending", "processing", "complete", and "failed". + "agent_id": "str", # Optional. The environment whose data is being exported. + For Harness Runtime, this is the Environment Config ID. Not meaningful for + ``inference`` exports; use ``type`` to distinguish the export scope. + "completed_at": 0, # Optional. Unix timestamp when the export completed, or + null if still in progress. + "environment_id": "str", # Optional. Same as agent_id. Dual-emitted during + the rename. + "error_message": "str", # Optional. Error message if the export failed, or + null on success. + "expires_at": 0, # Optional. Unix timestamp when the export download link + expires. "type": "str" # Optional. The scope of the export. ``agent`` covers one Harness Runtime environment; ``inference`` covers the team's Serverless Inference Signals conversations. Known values are: "agent" and "inference". @@ -190225,6 +190462,9 @@ async def list_deletions( deleted. Only present for ``agent`` deletions. "completed_at": 0, # Optional. Unix timestamp when the deletion finished, or null if still in progress. + "environment_id": "str", # Optional. Same as + agent_id when present. Dual-emitted during the rename; omitted when + agent_id is omitted. "error_message": "str", # Optional. Error message if the deletion failed, or null otherwise. "started_at": 0 # Optional. Unix timestamp when @@ -190344,15 +190584,16 @@ async def create_deletion( * ``agent`` — deletes Signals conversations for one Harness Runtime environment and - turns off collection for that environment. Requires ``agent_id``\\ , which is the - environment's Environment Config ID (the environment's ``agent_id``\\ ). On create, matching - conversations are hidden from Signals reads immediately. Wait until the + turns off collection for that environment. Requires ``environment_id`` (the + environment's Environment Config ID). Deprecated ``agent_id`` is still accepted; + both set and equal is accepted, both set and different returns 400. On create, + matching conversations are hidden from Signals reads immediately. Wait until the job is ``complete`` before enabling Signals for the environment again. * ``inference`` — deletes Serverless Inference Signals conversations for your whole team (team-wide; not limited to one endpoint or model) that were collected at or before the deletion request, and turns off team inference - collection (\\ ``source=inference``\\ ). Do not send ``agent_id``. On create, - matching conversations are hidden from Signals reads immediately. + collection (\\ ``source=inference``\\ ). Do not send ``environment_id`` or ``agent_id``. + On create, matching conversations are hidden from Signals reads immediately. The job runs asynchronously; poll the get endpoint until ``status`` is ``complete`` or ``failed``. DigitalOcean may retry transient processing errors @@ -190388,14 +190629,18 @@ async def create_deletion( "team_id": 0, # The team whose data should be deleted. Must match the authenticated team. Required. "type": "str", # The scope of the deletion. ``agent`` deletes Signals - conversations for one Harness Runtime environment and requires ``agent_id``. - ``inference`` deletes Serverless Inference Signals conversations for the whole - team (team-wide; omit ``agent_id``"" ). Required. Known values are: "agent" and - "inference". - "agent_id": "str" # Optional. The Harness Runtime Environment Config ID of - the environment whose conversations should be deleted. This is the environment's - ``agent_id``. Required when ``type`` is ``agent``"" ; must be omitted when - ``type`` is ``inference``. + conversations for one Harness Runtime environment and requires ``environment_id`` + (or deprecated ``agent_id``"" ). ``inference`` deletes Serverless Inference + Signals conversations for the whole team (team-wide; omit ``environment_id`` and + ``agent_id``"" ). Required. Known values are: "agent" and "inference". + "agent_id": "str", # Optional. Deprecated alias for ``environment_id``. + Accepted for backward compatibility; must equal ``environment_id`` when both are + set. Both set and different returns 400. Required when ``type`` is ``agent`` if + ``environment_id`` is omitted; must be omitted when ``type`` is ``inference``. + "environment_id": "str" # Optional. The Harness Runtime Environment Config + ID of the environment whose conversations should be deleted. Required when + ``type`` is ``agent`` if ``agent_id`` is omitted; must be omitted when ``type`` + is ``inference``. Prefer this over ``agent_id``. } # response body for status code(s): 200, 202 @@ -190416,6 +190661,8 @@ async def create_deletion( deletions. "completed_at": 0, # Optional. Unix timestamp when the deletion finished, or null if still in progress. + "environment_id": "str", # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is omitted. "error_message": "str", # Optional. Error message if the deletion failed, or null otherwise. "started_at": 0 # Optional. Unix timestamp when processing started, or null @@ -190448,15 +190695,16 @@ async def create_deletion( * ``agent`` — deletes Signals conversations for one Harness Runtime environment and - turns off collection for that environment. Requires ``agent_id``\\ , which is the - environment's Environment Config ID (the environment's ``agent_id``\\ ). On create, matching - conversations are hidden from Signals reads immediately. Wait until the + turns off collection for that environment. Requires ``environment_id`` (the + environment's Environment Config ID). Deprecated ``agent_id`` is still accepted; + both set and equal is accepted, both set and different returns 400. On create, + matching conversations are hidden from Signals reads immediately. Wait until the job is ``complete`` before enabling Signals for the environment again. * ``inference`` — deletes Serverless Inference Signals conversations for your whole team (team-wide; not limited to one endpoint or model) that were collected at or before the deletion request, and turns off team inference - collection (\\ ``source=inference``\\ ). Do not send ``agent_id``. On create, - matching conversations are hidden from Signals reads immediately. + collection (\\ ``source=inference``\\ ). Do not send ``environment_id`` or ``agent_id``. + On create, matching conversations are hidden from Signals reads immediately. The job runs asynchronously; poll the get endpoint until ``status`` is ``complete`` or ``failed``. DigitalOcean may retry transient processing errors @@ -190505,6 +190753,8 @@ async def create_deletion( deletions. "completed_at": 0, # Optional. Unix timestamp when the deletion finished, or null if still in progress. + "environment_id": "str", # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is omitted. "error_message": "str", # Optional. Error message if the deletion failed, or null otherwise. "started_at": 0 # Optional. Unix timestamp when processing started, or null @@ -190537,15 +190787,16 @@ async def create_deletion( * ``agent`` — deletes Signals conversations for one Harness Runtime environment and - turns off collection for that environment. Requires ``agent_id``\\ , which is the - environment's Environment Config ID (the environment's ``agent_id``\\ ). On create, matching - conversations are hidden from Signals reads immediately. Wait until the + turns off collection for that environment. Requires ``environment_id`` (the + environment's Environment Config ID). Deprecated ``agent_id`` is still accepted; + both set and equal is accepted, both set and different returns 400. On create, + matching conversations are hidden from Signals reads immediately. Wait until the job is ``complete`` before enabling Signals for the environment again. * ``inference`` — deletes Serverless Inference Signals conversations for your whole team (team-wide; not limited to one endpoint or model) that were collected at or before the deletion request, and turns off team inference - collection (\\ ``source=inference``\\ ). Do not send ``agent_id``. On create, - matching conversations are hidden from Signals reads immediately. + collection (\\ ``source=inference``\\ ). Do not send ``environment_id`` or ``agent_id``. + On create, matching conversations are hidden from Signals reads immediately. The job runs asynchronously; poll the get endpoint until ``status`` is ``complete`` or ``failed``. DigitalOcean may retry transient processing errors @@ -190578,14 +190829,18 @@ async def create_deletion( "team_id": 0, # The team whose data should be deleted. Must match the authenticated team. Required. "type": "str", # The scope of the deletion. ``agent`` deletes Signals - conversations for one Harness Runtime environment and requires ``agent_id``. - ``inference`` deletes Serverless Inference Signals conversations for the whole - team (team-wide; omit ``agent_id``"" ). Required. Known values are: "agent" and - "inference". - "agent_id": "str" # Optional. The Harness Runtime Environment Config ID of - the environment whose conversations should be deleted. This is the environment's - ``agent_id``. Required when ``type`` is ``agent``"" ; must be omitted when - ``type`` is ``inference``. + conversations for one Harness Runtime environment and requires ``environment_id`` + (or deprecated ``agent_id``"" ). ``inference`` deletes Serverless Inference + Signals conversations for the whole team (team-wide; omit ``environment_id`` and + ``agent_id``"" ). Required. Known values are: "agent" and "inference". + "agent_id": "str", # Optional. Deprecated alias for ``environment_id``. + Accepted for backward compatibility; must equal ``environment_id`` when both are + set. Both set and different returns 400. Required when ``type`` is ``agent`` if + ``environment_id`` is omitted; must be omitted when ``type`` is ``inference``. + "environment_id": "str" # Optional. The Harness Runtime Environment Config + ID of the environment whose conversations should be deleted. Required when + ``type`` is ``agent`` if ``agent_id`` is omitted; must be omitted when ``type`` + is ``inference``. Prefer this over ``agent_id``. } # response body for status code(s): 200, 202 @@ -190606,6 +190861,8 @@ async def create_deletion( deletions. "completed_at": 0, # Optional. Unix timestamp when the deletion finished, or null if still in progress. + "environment_id": "str", # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is omitted. "error_message": "str", # Optional. Error message if the deletion failed, or null otherwise. "started_at": 0 # Optional. Unix timestamp when processing started, or null @@ -190797,6 +191054,8 @@ async def get_deletion(self, deletion_id: str, **kwargs: Any) -> JSON: deletions. "completed_at": 0, # Optional. Unix timestamp when the deletion finished, or null if still in progress. + "environment_id": "str", # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is omitted. "error_message": "str", # Optional. Error message if the deletion failed, or null otherwise. "started_at": 0 # Optional. Unix timestamp when processing started, or null @@ -235884,6 +236143,8 @@ async def list(self, *, per_page: int = 20, page: int = 1, **kwargs: Any) -> JSO this size. Required. "disk_info": [ { + "ephemeral": bool, # Optional. Indicates an + ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -306484,11 +306745,10 @@ async def create_model_evaluation_run( evaluate. "dataset_uuid": "str", # Optional. UUID of the dataset to use for evaluation. - "epochs": 0, # Optional. Number of times to evaluate each dataset row - (n-pass/epochs), so the result reports avg@k/pass@k/cons@k instead of a single - score. Defaults to 1 when unset. Capped at 3 until throughput/sharding work - lands, since each extra epoch roughly multiplies wall-clock run time. Not - persisted on presets. + "epochs": 0, # Optional. How many times each dataset row is evaluated. + Defaults to 1, maximum 10. When more than 1, the results show how consistent the + model is across attempts (avg@k, pass@k, cons@k). Each extra attempt makes the + run take longer. Not saved in presets. "eval_preset_uuid": "str", # Optional. "judge_model_uuid": "str", # Optional. UUID of the judge model used to score responses. @@ -306630,11 +306890,10 @@ async def create_model_evaluation_run( evaluate. "dataset_uuid": "str", # Optional. UUID of the dataset to use for evaluation. - "epochs": 0, # Optional. Number of times to evaluate each dataset row - (n-pass/epochs), so the result reports avg@k/pass@k/cons@k instead of a single - score. Defaults to 1 when unset. Capped at 3 until throughput/sharding work - lands, since each extra epoch roughly multiplies wall-clock run time. Not - persisted on presets. + "epochs": 0, # Optional. How many times each dataset row is evaluated. + Defaults to 1, maximum 10. When more than 1, the results show how consistent the + model is across attempts (avg@k, pass@k, cons@k). Each extra attempt makes the + run take longer. Not saved in presets. "eval_preset_uuid": "str", # Optional. "judge_model_uuid": "str", # Optional. UUID of the judge model used to score responses. diff --git a/src/pydo/operations/_operations.py b/src/pydo/operations/_operations.py index 9b87bf00..7290e003 100644 --- a/src/pydo/operations/_operations.py +++ b/src/pydo/operations/_operations.py @@ -9635,15 +9635,17 @@ def build_signals_update_team_consent_request( # pylint: disable=name-too-long ) -def build_signals_get_consent_request(agent_id: str, **kwargs: Any) -> HttpRequest: +def build_signals_get_consent_request( + environment_id: str, **kwargs: Any +) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/v1/consent/{agent_id}" + _url = "/v1/consent/{environment_id}" path_format_arguments = { - "agent_id": _SERIALIZER.url("agent_id", agent_id, "str"), + "environment_id": _SERIALIZER.url("environment_id", environment_id, "str"), } _url: str = _url.format(**path_format_arguments) # type: ignore @@ -9654,7 +9656,9 @@ def build_signals_get_consent_request(agent_id: str, **kwargs: Any) -> HttpReque return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) -def build_signals_update_consent_request(agent_id: str, **kwargs: Any) -> HttpRequest: +def build_signals_update_consent_request( + environment_id: str, **kwargs: Any +) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) content_type: Optional[str] = kwargs.pop( @@ -9663,9 +9667,9 @@ def build_signals_update_consent_request(agent_id: str, **kwargs: Any) -> HttpRe accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/v1/consent/{agent_id}" + _url = "/v1/consent/{environment_id}" path_format_arguments = { - "agent_id": _SERIALIZER.url("agent_id", agent_id, "str"), + "environment_id": _SERIALIZER.url("environment_id", environment_id, "str"), } _url: str = _url.format(**path_format_arguments) # type: ignore @@ -9681,7 +9685,7 @@ def build_signals_update_consent_request(agent_id: str, **kwargs: Any) -> HttpRe def build_signals_list_agent_sessions_request( # pylint: disable=name-too-long - agent_id: str, + environment_id: str, *, limit: int = 20, after: Optional[str] = None, @@ -9696,9 +9700,9 @@ def build_signals_list_agent_sessions_request( # pylint: disable=name-too-long accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/v1/signals/agents/{agent_id}/sessions" + _url = "/v1/signals/agents/{environment_id}/sessions" path_format_arguments = { - "agent_id": _SERIALIZER.url("agent_id", agent_id, "str"), + "environment_id": _SERIALIZER.url("environment_id", environment_id, "str"), } _url: str = _url.format(**path_format_arguments) # type: ignore @@ -9771,7 +9775,12 @@ def build_signals_list_session_dialogues_request( # pylint: disable=name-too-lo def build_signals_list_exports_request( - *, limit: int = 20, after: Optional[str] = None, **kwargs: Any + *, + environment_id: Optional[str] = None, + agent_id: Optional[str] = None, + limit: int = 20, + after: Optional[str] = None, + **kwargs: Any, ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) @@ -9782,6 +9791,12 @@ def build_signals_list_exports_request( _url = "/v1/signals/exports" # Construct parameters + if environment_id is not None: + _params["environment_id"] = _SERIALIZER.query( + "environment_id", environment_id, "str" + ) + if agent_id is not None: + _params["agent_id"] = _SERIALIZER.query("agent_id", agent_id, "str") if limit is not None: _params["limit"] = _SERIALIZER.query( "limit", limit, "int", maximum=100, minimum=1 @@ -27109,6 +27124,9 @@ def create( connects to. tools selects the tools and toolbelts the session exposes, and policy decides which calls run, need approval, or are refused. + Set config.cache to opt into result caching for all eligible tools or a specific list. Caching + is off by default and must be enabled for the team. + :param body: Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. @@ -27128,11 +27146,24 @@ def create( connections the session's tool calls use, matched against connection ``user_id``. When set it must use the same alphabet as a connection's ``user_id``"" , ``[A-Za-z0-9._-]``"" , at most 64 characters; anything else is rejected with 400. - "config": {}, # Optional. Optional session options. config.preloadTools may - contain concrete tool names (optionally version-pinned) and version-pinned - toolbelt references. config.customInstructions is a string of at most 1000 - characters. config.outputViews maps up to 100 tool slugs to the name of an output - view to apply to that tool's results. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables caching for every + called tool version with a catalog cache policy, including tools that + become eligible after session creation. Do not combine with tools. True + "maxAgeSeconds": 0, # Optional. Maximum cache lifetime in + seconds for this session. Omit to use each tool's lifetime, up to 300 + seconds. A smaller tool lifetime or provider response cache header can + shorten it. Per-call max_age_seconds can require a fresher result but + cannot increase this limit. + "tools": [ + "str" # Optional. Provider-qualified tool slugs to + cache. Every listed tool must resolve for the team and have a catalog + cache policy, or session creation fails. Use slugs without version + suffixes or toolbelt references. An empty array enables no tools. + ] + } + }, "insights": { "logs": bool, # Optional. Whether the session's customer logs are sent to Insights. @@ -27185,8 +27216,26 @@ def create( session. Empty for sessions created through this API. "agentUrn": "str", # Optional. URN of the agent that started the session. Empty for sessions created through this API. - "config": {}, # Optional. Session options as supplied at creation. - Omitted when none were supplied. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables caching for + every called tool version with a catalog cache policy, including + tools that become eligible after session creation. Do not combine + with tools. True + "maxAgeSeconds": 0, # Optional. Maximum cache + lifetime in seconds for this session. Omit to use each tool's + lifetime, up to 300 seconds. A smaller tool lifetime or provider + response cache header can shorten it. Per-call max_age_seconds can + require a fresher result but cannot increase this limit. + "tools": [ + "str" # Optional. Provider-qualified tool + slugs to cache. Every listed tool must resolve for the team and + have a catalog cache policy, or session creation fails. Use slugs + without version suffixes or toolbelt references. An empty array + enables no tools. + ] + } + }, "createdAt": "2020-02-20 00:00:00", # Optional. When the session was created. "insights": { @@ -27272,6 +27321,9 @@ def create( connects to. tools selects the tools and toolbelts the session exposes, and policy decides which calls run, need approval, or are refused. + Set config.cache to opt into result caching for all eligible tools or a specific list. Caching + is off by default and must be enabled for the team. + :param body: Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. @@ -27295,8 +27347,26 @@ def create( session. Empty for sessions created through this API. "agentUrn": "str", # Optional. URN of the agent that started the session. Empty for sessions created through this API. - "config": {}, # Optional. Session options as supplied at creation. - Omitted when none were supplied. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables caching for + every called tool version with a catalog cache policy, including + tools that become eligible after session creation. Do not combine + with tools. True + "maxAgeSeconds": 0, # Optional. Maximum cache + lifetime in seconds for this session. Omit to use each tool's + lifetime, up to 300 seconds. A smaller tool lifetime or provider + response cache header can shorten it. Per-call max_age_seconds can + require a fresher result but cannot increase this limit. + "tools": [ + "str" # Optional. Provider-qualified tool + slugs to cache. Every listed tool must resolve for the team and + have a catalog cache policy, or session creation fails. Use slugs + without version suffixes or toolbelt references. An empty array + enables no tools. + ] + } + }, "createdAt": "2020-02-20 00:00:00", # Optional. When the session was created. "insights": { @@ -27380,6 +27450,9 @@ def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: connects to. tools selects the tools and toolbelts the session exposes, and policy decides which calls run, need approval, or are refused. + Set config.cache to opt into result caching for all eligible tools or a specific list. Caching + is off by default and must be enabled for the team. + :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] :return: JSON object @@ -27396,11 +27469,24 @@ def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: connections the session's tool calls use, matched against connection ``user_id``. When set it must use the same alphabet as a connection's ``user_id``"" , ``[A-Za-z0-9._-]``"" , at most 64 characters; anything else is rejected with 400. - "config": {}, # Optional. Optional session options. config.preloadTools may - contain concrete tool names (optionally version-pinned) and version-pinned - toolbelt references. config.customInstructions is a string of at most 1000 - characters. config.outputViews maps up to 100 tool slugs to the name of an output - view to apply to that tool's results. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables caching for every + called tool version with a catalog cache policy, including tools that + become eligible after session creation. Do not combine with tools. True + "maxAgeSeconds": 0, # Optional. Maximum cache lifetime in + seconds for this session. Omit to use each tool's lifetime, up to 300 + seconds. A smaller tool lifetime or provider response cache header can + shorten it. Per-call max_age_seconds can require a fresher result but + cannot increase this limit. + "tools": [ + "str" # Optional. Provider-qualified tool slugs to + cache. Every listed tool must resolve for the team and have a catalog + cache policy, or session creation fails. Use slugs without version + suffixes or toolbelt references. An empty array enables no tools. + ] + } + }, "insights": { "logs": bool, # Optional. Whether the session's customer logs are sent to Insights. @@ -27453,8 +27539,26 @@ def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: session. Empty for sessions created through this API. "agentUrn": "str", # Optional. URN of the agent that started the session. Empty for sessions created through this API. - "config": {}, # Optional. Session options as supplied at creation. - Omitted when none were supplied. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables caching for + every called tool version with a catalog cache policy, including + tools that become eligible after session creation. Do not combine + with tools. True + "maxAgeSeconds": 0, # Optional. Maximum cache + lifetime in seconds for this session. Omit to use each tool's + lifetime, up to 300 seconds. A smaller tool lifetime or provider + response cache header can shorten it. Per-call max_age_seconds can + require a fresher result but cannot increase this limit. + "tools": [ + "str" # Optional. Provider-qualified tool + slugs to cache. Every listed tool must resolve for the team and + have a catalog cache policy, or session creation fails. Use slugs + without version suffixes or toolbelt references. An empty array + enables no tools. + ] + } + }, "createdAt": "2020-02-20 00:00:00", # Optional. When the session was created. "insights": { @@ -27664,8 +27768,27 @@ def list( started the session. Empty for sessions created through this API. "agentUrn": "str", # Optional. URN of the agent that started the session. Empty for sessions created through this API. - "config": {}, # Optional. Session options as supplied at - creation. Omitted when none were supplied. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables + caching for every called tool version with a catalog cache + policy, including tools that become eligible after session + creation. Do not combine with tools. True + "maxAgeSeconds": 0, # Optional. Maximum + cache lifetime in seconds for this session. Omit to use each + tool's lifetime, up to 300 seconds. A smaller tool lifetime or + provider response cache header can shorten it. Per-call + max_age_seconds can require a fresher result but cannot increase + this limit. + "tools": [ + "str" # Optional. Provider-qualified + tool slugs to cache. Every listed tool must resolve for the + team and have a catalog cache policy, or session creation + fails. Use slugs without version suffixes or toolbelt + references. An empty array enables no tools. + ] + } + }, "createdAt": "2020-02-20 00:00:00", # Optional. When the session was created. "insights": { @@ -27842,8 +27965,27 @@ def list_search( started the session. Empty for sessions created through this API. "agentUrn": "str", # Optional. URN of the agent that started the session. Empty for sessions created through this API. - "config": {}, # Optional. Session options as supplied at - creation. Omitted when none were supplied. + "config": { + "cache": { + "allEligible": bool, # Optional. Enables + caching for every called tool version with a catalog cache + policy, including tools that become eligible after session + creation. Do not combine with tools. True + "maxAgeSeconds": 0, # Optional. Maximum + cache lifetime in seconds for this session. Omit to use each + tool's lifetime, up to 300 seconds. A smaller tool lifetime or + provider response cache header can shorten it. Per-call + max_age_seconds can require a fresher result but cannot increase + this limit. + "tools": [ + "str" # Optional. Provider-qualified + tool slugs to cache. Every listed tool must resolve for the + team and have a catalog cache policy, or session creation + fails. Use slugs without version suffixes or toolbelt + references. An empty array enables no tools. + ] + } + }, "createdAt": "2020-02-20 00:00:00", # Optional. When the session was created. "insights": { @@ -30256,6 +30398,10 @@ def list( the tool requests. ] }, + "cache": { + "ttlSeconds": 0 # Maximum cache lifetime in seconds + for this tool version. Required. + }, "description": "str", # Optional. What the tool does. "inputSchema": {}, # Optional. The JSON Schema the tool's arguments must satisfy. @@ -32304,16 +32450,14 @@ def list_search( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -32339,6 +32483,13 @@ def list_search( query in the request. "results": [ { + "cache": { + "maxAgeSeconds": 0 # Maximum + result age the session allows, or 300 if the session sets + no limit. The tool's own cache lifetime can be shorter. + Invoke controls use max_age_seconds, not this field's + camelCase spelling. Required. + }, "description": "str", # Optional. One result group per query, in request order. "inputSchema": { @@ -32439,16 +32590,14 @@ def list_search( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -32474,6 +32623,13 @@ def list_search( query in the request. "results": [ { + "cache": { + "maxAgeSeconds": 0 # Maximum + result age the session allows, or 300 if the session sets + no limit. The tool's own cache lifetime can be shorter. + Invoke controls use max_age_seconds, not this field's + camelCase spelling. Required. + }, "description": "str", # Optional. One result group per query, in request order. "inputSchema": { @@ -32590,16 +32746,14 @@ def list_search( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -32625,6 +32779,13 @@ def list_search( query in the request. "results": [ { + "cache": { + "maxAgeSeconds": 0 # Maximum + result age the session allows, or 300 if the session sets + no limit. The tool's own cache lifetime can be shorter. + Invoke controls use max_age_seconds, not this field's + camelCase spelling. Required. + }, "description": "str", # Optional. One result group per query, in request order. "inputSchema": { @@ -32821,6 +32982,11 @@ def run( needs the end user to connect a provider fails with ``_meta.status`` set to ``requires_authorization`` or ``requires_connection_configuration``. + Tools opted into result caching use the session's settings automatically. Set cache on an + individual tools entry to bypass caching or require a fresher result. The result's _meta.cache + reports cache hits. Hits still incur the standard gateway invocation charge but no additional + provider charge, because the provider is not called. + :param body: Required. :type body: JSON :keyword x_session_id: The session to act in: the UUID at the end of the session's @@ -32847,6 +33013,18 @@ def run( "str": {} # Optional. The tool's arguments, matching its ``inputSchema``. }, + "cache": { + "max_age_seconds": 0, # Optional. Oldest cached + result this call accepts, in seconds. Zero bypasses caching. Values + above 300 are clamped to 300; larger values cannot increase the + session or tool lifetime. This controls accepted result age, not the + lifetime of a newly stored entry. + "mode": "auto" # Optional. Default value is "auto". + auto uses a sufficiently recent cached result or calls the provider + and can store a successful result. bypass skips lookup and storage + without clearing or refreshing existing entries. Known values are: + "auto" and "bypass". + }, "version": "str" # Optional. An immutable tool version. Omit to use the released version. } @@ -32868,18 +33046,15 @@ def run( "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result - metadata. Keys include: * ``status``"" : - ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped - before running. * ``approval_id``"" , ``tool_name``"" , - ``expires_at``"" , and ``decide``"" : present with - ``requires_approval``. ``decide`` gives the ``method``"" , - ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": - bool}` when the gateway retried the call. * - ``output_view``"" : the output view applied to the result. + "cache": { + "status": "str", # HIT returned a + cached result without calling the provider. MISS found no + usable result and called the provider. BYPASS skipped + caching. Required. Known values are: "HIT", "MISS", and + "BYPASS". + "age_seconds": 0 # Optional. Age of + the cached result in seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure @@ -32972,6 +33147,11 @@ def run( needs the end user to connect a provider fails with ``_meta.status`` set to ``requires_authorization`` or ``requires_connection_configuration``. + Tools opted into result caching use the session's settings automatically. Set cache on an + individual tools entry to bypass caching or require a fresher result. The result's _meta.cache + reports cache hits. Hits still incur the standard gateway invocation charge but no additional + provider charge, because the provider is not called. + :param body: Required. :type body: IO[bytes] :keyword x_session_id: The session to act in: the UUID at the end of the session's @@ -33001,18 +33181,15 @@ def run( "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result - metadata. Keys include: * ``status``"" : - ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped - before running. * ``approval_id``"" , ``tool_name``"" , - ``expires_at``"" , and ``decide``"" : present with - ``requires_approval``. ``decide`` gives the ``method``"" , - ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": - bool}` when the gateway retried the call. * - ``output_view``"" : the output view applied to the result. + "cache": { + "status": "str", # HIT returned a + cached result without calling the provider. MISS found no + usable result and called the provider. BYPASS skipped + caching. Required. Known values are: "HIT", "MISS", and + "BYPASS". + "age_seconds": 0 # Optional. Age of + the cached result in seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure @@ -33100,6 +33277,11 @@ def run( needs the end user to connect a provider fails with ``_meta.status`` set to ``requires_authorization`` or ``requires_connection_configuration``. + Tools opted into result caching use the session's settings automatically. Set cache on an + individual tools entry to bypass caching or require a fresher result. The result's _meta.cache + reports cache hits. Hits still incur the standard gateway invocation charge but no additional + provider charge, because the provider is not called. + :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] :keyword x_session_id: The session to act in: the UUID at the end of the session's @@ -33123,6 +33305,18 @@ def run( "str": {} # Optional. The tool's arguments, matching its ``inputSchema``. }, + "cache": { + "max_age_seconds": 0, # Optional. Oldest cached + result this call accepts, in seconds. Zero bypasses caching. Values + above 300 are clamped to 300; larger values cannot increase the + session or tool lifetime. This controls accepted result age, not the + lifetime of a newly stored entry. + "mode": "auto" # Optional. Default value is "auto". + auto uses a sufficiently recent cached result or calls the provider + and can store a successful result. bypass skips lookup and storage + without clearing or refreshing existing entries. Known values are: + "auto" and "bypass". + }, "version": "str" # Optional. An immutable tool version. Omit to use the released version. } @@ -33144,18 +33338,15 @@ def run( "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result - metadata. Keys include: * ``status``"" : - ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped - before running. * ``approval_id``"" , ``tool_name``"" , - ``expires_at``"" , and ``decide``"" : present with - ``requires_approval``. ``decide`` gives the ``method``"" , - ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": - bool}` when the gateway retried the call. * - ``output_view``"" : the output view applied to the result. + "cache": { + "status": "str", # HIT returned a + cached result without calling the provider. MISS found no + usable result and called the provider. BYPASS skipped + caching. Required. Known values are: "HIT", "MISS", and + "BYPASS". + "age_seconds": 0 # Optional. Age of + the cached result in seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure @@ -33428,16 +33619,14 @@ def run( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -33542,16 +33731,14 @@ def run( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -33655,16 +33842,14 @@ def run( contacting support. Required. "status": "str", # Required. Known values are: "succeeded" and "failed". "_meta": { - "str": {} # Optional. Additional result metadata. Keys include: * - ``status``"" : ``requires_approval``"" , ``requires_authorization``"" , or - ``requires_connection_configuration`` when the call stopped before running. - * ``approval_id``"" , ``tool_name``"" , ``expires_at``"" , and - ``decide``"" : present with ``requires_approval``. ``decide`` gives the - ``method``"" , ``path``"" , and ``body`` of the approval request to send. - Approve the call, then repeat it with the same arguments before - ``expires_at``. * `retry`: `{"attempt_count": N, "exhausted": bool}` when - the gateway retried the call. * ``output_view``"" : the output view - applied to the result. + "cache": { + "status": "str", # HIT returned a cached result without + calling the provider. MISS found no usable result and called the + provider. BYPASS skipped caching. Required. Known values are: "HIT", + "MISS", and "BYPASS". + "age_seconds": 0 # Optional. Age of the cached result in + seconds. Present only on a hit. + } }, "error": { "class": "str", # Optional. The failure class. Branch on this value @@ -41614,7 +41799,7 @@ def list_config_sessions( with 409. Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. - Drives the inactivity policy that destroys idle sessions. + Drives the inactivity policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the @@ -41886,7 +42071,7 @@ def list_sessions( with 409. Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. - Drives the inactivity policy that destroys idle sessions. + Drives the inactivity policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the @@ -42184,7 +42369,7 @@ def create_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -42369,7 +42554,7 @@ def create_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -42564,7 +42749,7 @@ def create_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -43394,7 +43579,7 @@ def get_session(self, session_id: str, **kwargs: Any) -> JSON: Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -43659,7 +43844,7 @@ def update_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -43807,7 +43992,7 @@ def update_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -43955,7 +44140,7 @@ def update_session( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -45174,7 +45359,7 @@ def revert_session_checkpoint( Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. Drives the inactivity - policy that destroys idle sessions. + policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the ListSessions ?name= filter; the @@ -45493,7 +45678,7 @@ def create_session_fork( with 409. Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. - Drives the inactivity policy that destroys idle sessions. + Drives the inactivity policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the @@ -45649,7 +45834,7 @@ def create_session_fork( with 409. Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. - Drives the inactivity policy that destroys idle sessions. + Drives the inactivity policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the @@ -45810,7 +45995,7 @@ def create_session_fork( with 409. Omitted when false. "last_event_at": "2020-02-20 00:00:00", # Optional. Timestamp of the most recent event in this session's canonical stream. - Drives the inactivity policy that destroys idle sessions. + Drives the inactivity policy that pauses idle sessions. "name": "str", # Optional. User-assignable display name, unique per team among non-terminal sessions. Usable in place of session_id by clients (doctl / Console resolve it to the id via the @@ -184729,6 +184914,8 @@ class of Droplets created from this size. For example: Basic, General Droplets of this size. Required. "disk_info": [ { + "ephemeral": bool, # Optional. + Indicates an ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -184779,6 +184966,8 @@ class of Droplets created from this size. For example: Basic, General ], "disk_info": [ { + "ephemeral": bool, # Optional. Indicates an + ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -185410,6 +185599,8 @@ def get(self, droplet_id: int, **kwargs: Any) -> JSON: this size. Required. "disk_info": [ { + "ephemeral": bool, # Optional. Indicates an + ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -185457,6 +185648,8 @@ def get(self, droplet_id: int, **kwargs: Any) -> JSON: ], "disk_info": [ { + "ephemeral": bool, # Optional. Indicates an + ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -187000,6 +187193,8 @@ class of Droplets created from this size. For example: Basic, General Droplets of this size. Required. "disk_info": [ { + "ephemeral": bool, # Optional. + Indicates an ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -187050,6 +187245,8 @@ class of Droplets created from this size. For example: Basic, General ], "disk_info": [ { + "ephemeral": bool, # Optional. Indicates an + ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -208922,8 +209119,10 @@ def list_consents(self, *, source: Optional[str] = None, **kwargs: Any) -> JSON: Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when + present. Dual-emitted during the rename; omitted when agent_id is empty. } ], "source": "str" # Optional. Echoes the ``source`` filter when the request @@ -209040,14 +209239,14 @@ def update_team_consent( To revoke consent, send the same request with ``enabled`` set to ``false``. The ``source`` query parameter is required. Per-environment consent for Harness - Runtime environments is managed with ``PUT /v1/consent/{agent_id}`` instead. + Runtime environments is managed with ``PUT /v1/consent/{environment_id}`` instead. :param body: Required. :type body: JSON :keyword source: The consent source to update. Only team-level sources are accepted on this endpoint; currently ``inference`` (Serverless Inference chat completions). Per-environment - consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{agent_id}`` instead. "inference" - Required. + consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{environment_id}`` instead. + "inference" Required. :paramtype source: str :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -209081,8 +209280,10 @@ def update_team_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400 @@ -209118,14 +209319,14 @@ def update_team_consent( To revoke consent, send the same request with ``enabled`` set to ``false``. The ``source`` query parameter is required. Per-environment consent for Harness - Runtime environments is managed with ``PUT /v1/consent/{agent_id}`` instead. + Runtime environments is managed with ``PUT /v1/consent/{environment_id}`` instead. :param body: Required. :type body: IO[bytes] :keyword source: The consent source to update. Only team-level sources are accepted on this endpoint; currently ``inference`` (Serverless Inference chat completions). Per-environment - consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{agent_id}`` instead. "inference" - Required. + consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{environment_id}`` instead. + "inference" Required. :paramtype source: str :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -209153,8 +209354,10 @@ def update_team_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400 @@ -209185,14 +209388,14 @@ def update_team_consent( To revoke consent, send the same request with ``enabled`` set to ``false``. The ``source`` query parameter is required. Per-environment consent for Harness - Runtime environments is managed with ``PUT /v1/consent/{agent_id}`` instead. + Runtime environments is managed with ``PUT /v1/consent/{environment_id}`` instead. :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] :keyword source: The consent source to update. Only team-level sources are accepted on this endpoint; currently ``inference`` (Serverless Inference chat completions). Per-environment - consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{agent_id}`` instead. "inference" - Required. + consent (\\ ``agent``\\ ) is managed with ``PUT /v1/consent/{environment_id}`` instead. + "inference" Required. :paramtype source: str :return: JSON object :rtype: JSON @@ -209223,8 +209426,10 @@ def update_team_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400 @@ -209332,20 +209537,20 @@ def update_team_consent( return cast(JSON, deserialized) # type: ignore @distributed_trace - def get_consent(self, agent_id: str, **kwargs: Any) -> JSON: + def get_consent(self, environment_id: str, **kwargs: Any) -> JSON: # pylint: disable=line-too-long """Retrieve Consent for an Environment. To retrieve the consent record for a specific environment, send a GET - request to ``/v1/consent/{agent_id}``. The response includes an ``enabled`` + request to ``/v1/consent/{environment_id}``. The response includes an ``enabled`` field indicating whether signals collection is on for this environment. This endpoint only serves per-environment (\\ ``source: agent``\\ ) records. Team-level inference consent is read from ``GET /v1/consent?source=inference``. - :param agent_id: A unique identifier for an environment. For Harness Runtime, this is the - Environment Config ID. Required. - :type agent_id: str + :param environment_id: A unique identifier for an environment. For Harness Runtime, this is the + Environment Config ID. Formerly named agent_id. Required. + :type environment_id: str :return: JSON object :rtype: JSON :raises ~azure.core.exceptions.HttpResponseError: @@ -209359,6 +209564,8 @@ def get_consent(self, agent_id: str, **kwargs: Any) -> JSON: Runtime, this is the Environment Config ID. Required. "enabled": bool, # Whether signals collection is enabled for this environment. Required. + "environment_id": "str", # Same as agent_id. Dual-emitted during the rename. + Required. "source": "str", # The source this consent applies to. Always ``agent`` for per-environment records returned by this endpoint. Required. "agent" "team_id": 0, # The team ID that owns this consent record. Required. @@ -209397,7 +209604,7 @@ def get_consent(self, agent_id: str, **kwargs: Any) -> JSON: cls: ClsType[JSON] = kwargs.pop("cls", None) _request = build_signals_get_consent_request( - agent_id=agent_id, + environment_id=environment_id, headers=_headers, params=_params, ) @@ -209475,7 +209682,7 @@ def get_consent(self, agent_id: str, **kwargs: Any) -> JSON: @overload def update_consent( self, - agent_id: str, + environment_id: str, body: JSON, *, content_type: str = "application/json", @@ -209485,16 +209692,16 @@ def update_consent( """Update Consent for an Environment. To enable or disable signals collection for a specific environment, send a - PUT request to ``/v1/consent/{agent_id}`` with an ``enabled`` boolean in the + PUT request to ``/v1/consent/{environment_id}`` with an ``enabled`` boolean in the request body. This endpoint only manages per-environment (\\ ``source: agent``\\ ) consent. To manage team-level consent for Serverless Inference, use ``PUT /v1/consent?source=inference`` instead. - :param agent_id: A unique identifier for an environment. For Harness Runtime, this is the - Environment Config ID. Required. - :type agent_id: str + :param environment_id: A unique identifier for an environment. For Harness Runtime, this is the + Environment Config ID. Formerly named agent_id. Required. + :type environment_id: str :param body: Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. @@ -209529,8 +209736,10 @@ def update_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400, 404 @@ -209549,7 +209758,7 @@ def update_consent( @overload def update_consent( self, - agent_id: str, + environment_id: str, body: IO[bytes], *, content_type: str = "application/json", @@ -209559,16 +209768,16 @@ def update_consent( """Update Consent for an Environment. To enable or disable signals collection for a specific environment, send a - PUT request to ``/v1/consent/{agent_id}`` with an ``enabled`` boolean in the + PUT request to ``/v1/consent/{environment_id}`` with an ``enabled`` boolean in the request body. This endpoint only manages per-environment (\\ ``source: agent``\\ ) consent. To manage team-level consent for Serverless Inference, use ``PUT /v1/consent?source=inference`` instead. - :param agent_id: A unique identifier for an environment. For Harness Runtime, this is the - Environment Config ID. Required. - :type agent_id: str + :param environment_id: A unique identifier for an environment. For Harness Runtime, this is the + Environment Config ID. Formerly named agent_id. Required. + :type environment_id: str :param body: Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. @@ -209597,8 +209806,10 @@ def update_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400, 404 @@ -209616,22 +209827,22 @@ def update_consent( @distributed_trace def update_consent( - self, agent_id: str, body: Union[JSON, IO[bytes]], **kwargs: Any + self, environment_id: str, body: Union[JSON, IO[bytes]], **kwargs: Any ) -> JSON: # pylint: disable=line-too-long """Update Consent for an Environment. To enable or disable signals collection for a specific environment, send a - PUT request to ``/v1/consent/{agent_id}`` with an ``enabled`` boolean in the + PUT request to ``/v1/consent/{environment_id}`` with an ``enabled`` boolean in the request body. This endpoint only manages per-environment (\\ ``source: agent``\\ ) consent. To manage team-level consent for Serverless Inference, use ``PUT /v1/consent?source=inference`` instead. - :param agent_id: A unique identifier for an environment. For Harness Runtime, this is the - Environment Config ID. Required. - :type agent_id: str + :param environment_id: A unique identifier for an environment. For Harness Runtime, this is the + Environment Config ID. Formerly named agent_id. Required. + :type environment_id: str :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] :return: JSON object @@ -209663,8 +209874,10 @@ def update_consent( consent for Serverless Inference chat completions. Required. Known values are: "agent" and "inference". "team_id": 0, # The team ID that owns this consent record. Required. - "updated_at": "2020-02-20 00:00:00" # A time value given in ISO8601 + "updated_at": "2020-02-20 00:00:00", # A time value given in ISO8601 combined date and time format. Required. + "environment_id": "str" # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is empty. } } # response body for status code(s): 400, 404 @@ -209709,7 +209922,7 @@ def update_consent( _json = body _request = build_signals_update_consent_request( - agent_id=agent_id, + environment_id=environment_id, content_type=content_type, json=_json, content=_content, @@ -209790,7 +210003,7 @@ def update_consent( @distributed_trace def list_agent_sessions( self, - agent_id: str, + environment_id: str, *, limit: int = 20, after: Optional[str] = None, @@ -209803,12 +210016,12 @@ def list_agent_sessions( """List Sessions for an Environment. To list signals sessions for a specific environment, send a GET request to - ``/v1/signals/agents/{agent_id}/sessions``. Results are paginated using cursor-based + ``/v1/signals/agents/{environment_id}/sessions``. Results are paginated using cursor-based pagination with ``limit`` and ``after`` parameters. - :param agent_id: A unique identifier for an environment. For Harness Runtime, this is the - Environment Config ID. Required. - :type agent_id: str + :param environment_id: A unique identifier for an environment. For Harness Runtime, this is the + Environment Config ID. Formerly named agent_id. Required. + :type environment_id: str :keyword limit: Maximum number of items to return per page. Default value is 20. :paramtype limit: int :keyword after: An opaque cursor string returned from a previous page. Pass this value to @@ -209886,7 +210099,7 @@ def list_agent_sessions( cls: ClsType[JSON] = kwargs.pop("cls", None) _request = build_signals_list_agent_sessions_request( - agent_id=agent_id, + environment_id=environment_id, limit=limit, after=after, start_time=start_time, @@ -210117,7 +210330,13 @@ def list_session_dialogues( @distributed_trace def list_exports( - self, *, limit: int = 20, after: Optional[str] = None, **kwargs: Any + self, + *, + environment_id: Optional[str] = None, + agent_id: Optional[str] = None, + limit: int = 20, + after: Optional[str] = None, + **kwargs: Any, ) -> JSON: # pylint: disable=line-too-long """List Export Jobs. @@ -210126,6 +210345,12 @@ def list_exports( ``/v1/signals/exports``. Results are paginated using cursor-based pagination with ``limit`` and ``after`` parameters. + :keyword environment_id: Optional filter by environment ID. Default value is None. + :paramtype environment_id: str + :keyword agent_id: Deprecated alias for environment_id. Accepted for backward compatibility; + must equal environment_id when both are set. Both set and different returns 400. Default value + is None. + :paramtype agent_id: str :keyword limit: Maximum number of items to return per page. Default value is 20. :paramtype limit: int :keyword after: An opaque cursor string returned from a previous page. Pass this value to @@ -210145,23 +210370,10 @@ def list_exports( "cursor": "str", # Optional. An opaque cursor for pagination. "node": { - "agent_id": "str", # The environment whose data is - being exported. For Harness Runtime, this is the Environment Config - ID. Not meaningful for ``inference`` exports; use ``type`` to - distinguish the export scope. Required. "created_at": 0, # Unix timestamp when the export was created. Required. "export_id": "str", # The unique identifier for the export job. Required. - "status": "str", # The current status of the export - job. Required. Known values are: "pending", "processing", "complete", - and "failed". - "completed_at": 0, # Optional. Unix timestamp when - the export completed, or null if still in progress. - "error_message": "str", # Optional. Error message if - the export failed, or null on success. - "expires_at": 0, # Optional. Unix timestamp when the - export download link expires. "filters": { "session_ids": [ "str" # Optional. Specific session @@ -210172,6 +210384,21 @@ def list_exports( included in the export. ] }, + "status": "str", # The current status of the export + job. Required. Known values are: "pending", "processing", "complete", + and "failed". + "agent_id": "str", # Optional. The environment whose + data is being exported. For Harness Runtime, this is the Environment + Config ID. Not meaningful for ``inference`` exports; use ``type`` to + distinguish the export scope. + "completed_at": 0, # Optional. Unix timestamp when + the export completed, or null if still in progress. + "environment_id": "str", # Optional. Same as + agent_id. Dual-emitted during the rename. + "error_message": "str", # Optional. Error message if + the export failed, or null on success. + "expires_at": 0, # Optional. Unix timestamp when the + export download link expires. "type": "str" # Optional. The scope of the export. ``agent`` covers one Harness Runtime environment; ``inference`` covers the team's Serverless Inference Signals conversations. Known @@ -210204,6 +210431,8 @@ def list_exports( cls: ClsType[JSON] = kwargs.pop("cls", None) _request = build_signals_list_exports_request( + environment_id=environment_id, + agent_id=agent_id, limit=limit, after=after, headers=_headers, @@ -210256,9 +210485,10 @@ def create_export( To create a new signals data export, send a POST request to ``/v1/signals/exports``. To export one Harness Runtime environment, include its - ``agent_id`` (\\ ``type`` defaults to ``agent``\\ ). To export the team's Serverless - Inference Signals conversations, set ``type`` to ``inference`` and omit - ``agent_id``. You may optionally filter the export by ``signal_type``\\ , + ``environment_id`` (\\ ``type`` defaults to ``agent``\\ ). Deprecated ``agent_id`` is still + accepted. To export the team's Serverless Inference Signals conversations, set + ``type`` to ``inference`` and omit ``environment_id`` and ``agent_id``. You may + optionally filter the export by ``signal_type``\\ , ``session_ids``\\ , ``start_time``\\ , and ``end_time``. Use the export options endpoint to discover available signal types. @@ -210280,11 +210510,16 @@ def create_export( # JSON input template you can fill out and use as your body input. body = { - "agent_id": "str", # Optional. The environment whose data should be - exported. For Harness Runtime, this is the Environment Config ID. Required when - ``type`` is ``agent``"" ; must be omitted when ``type`` is ``inference``. + "agent_id": "str", # Optional. Deprecated alias for ``environment_id``. + Accepted for backward compatibility; must equal ``environment_id`` when both are + set. Both set and different returns 400. Required when ``type`` is ``agent`` if + ``environment_id`` is omitted; must be omitted when ``type`` is ``inference``. "end_time": "2020-02-20 00:00:00", # Optional. Include only sessions that started at or before this timestamp. + "environment_id": "str", # Optional. The environment whose data should be + exported. For Harness Runtime, this is the Environment Config ID. Required when + ``type`` is ``agent`` if ``agent_id`` is omitted; must be omitted when ``type`` + is ``inference``. Prefer this over ``agent_id``. "session_ids": [ "str" # Optional. Optional list of specific session IDs to include in the export. @@ -210296,28 +210531,18 @@ def create_export( "start_time": "2020-02-20 00:00:00", # Optional. Include only sessions that started at or after this timestamp. "type": "str" # Optional. The scope of the export. ``agent`` exports Signals - conversations for one Harness Runtime environment and requires ``agent_id``. - ``inference`` exports Serverless Inference Signals conversations for the whole - team (team-wide; omit ``agent_id``"" ). Defaults to ``agent`` when ``agent_id`` - is provided and to ``inference`` when it is omitted. Known values are: "agent" + conversations for one Harness Runtime environment and requires ``environment_id`` + (or deprecated ``agent_id``"" ). ``inference`` exports Serverless Inference + Signals conversations for the whole team (team-wide; omit ``environment_id`` and + ``agent_id``"" ). Defaults to ``agent`` when ``environment_id`` or ``agent_id`` + is provided and to ``inference`` when both are omitted. Known values are: "agent" and "inference". } # response body for status code(s): 201 response == { - "agent_id": "str", # The environment whose data is being exported. For - Harness Runtime, this is the Environment Config ID. Not meaningful for - ``inference`` exports; use ``type`` to distinguish the export scope. Required. "created_at": 0, # Unix timestamp when the export was created. Required. "export_id": "str", # The unique identifier for the export job. Required. - "status": "str", # The current status of the export job. Required. Known - values are: "pending", "processing", "complete", and "failed". - "completed_at": 0, # Optional. Unix timestamp when the export completed, or - null if still in progress. - "error_message": "str", # Optional. Error message if the export failed, or - null on success. - "expires_at": 0, # Optional. Unix timestamp when the export download link - expires. "filters": { "session_ids": [ "str" # Optional. Specific session IDs included in the @@ -210327,6 +210552,19 @@ def create_export( "str" # Optional. Signal types included in the export. ] }, + "status": "str", # The current status of the export job. Required. Known + values are: "pending", "processing", "complete", and "failed". + "agent_id": "str", # Optional. The environment whose data is being exported. + For Harness Runtime, this is the Environment Config ID. Not meaningful for + ``inference`` exports; use ``type`` to distinguish the export scope. + "completed_at": 0, # Optional. Unix timestamp when the export completed, or + null if still in progress. + "environment_id": "str", # Optional. Same as agent_id. Dual-emitted during + the rename. + "error_message": "str", # Optional. Error message if the export failed, or + null on success. + "expires_at": 0, # Optional. Unix timestamp when the export download link + expires. "type": "str" # Optional. The scope of the export. ``agent`` covers one Harness Runtime environment; ``inference`` covers the team's Serverless Inference Signals conversations. Known values are: "agent" and "inference". @@ -210353,9 +210591,10 @@ def create_export( To create a new signals data export, send a POST request to ``/v1/signals/exports``. To export one Harness Runtime environment, include its - ``agent_id`` (\\ ``type`` defaults to ``agent``\\ ). To export the team's Serverless - Inference Signals conversations, set ``type`` to ``inference`` and omit - ``agent_id``. You may optionally filter the export by ``signal_type``\\ , + ``environment_id`` (\\ ``type`` defaults to ``agent``\\ ). Deprecated ``agent_id`` is still + accepted. To export the team's Serverless Inference Signals conversations, set + ``type`` to ``inference`` and omit ``environment_id`` and ``agent_id``. You may + optionally filter the export by ``signal_type``\\ , ``session_ids``\\ , ``start_time``\\ , and ``end_time``. Use the export options endpoint to discover available signal types. @@ -210377,19 +210616,8 @@ def create_export( # response body for status code(s): 201 response == { - "agent_id": "str", # The environment whose data is being exported. For - Harness Runtime, this is the Environment Config ID. Not meaningful for - ``inference`` exports; use ``type`` to distinguish the export scope. Required. "created_at": 0, # Unix timestamp when the export was created. Required. "export_id": "str", # The unique identifier for the export job. Required. - "status": "str", # The current status of the export job. Required. Known - values are: "pending", "processing", "complete", and "failed". - "completed_at": 0, # Optional. Unix timestamp when the export completed, or - null if still in progress. - "error_message": "str", # Optional. Error message if the export failed, or - null on success. - "expires_at": 0, # Optional. Unix timestamp when the export download link - expires. "filters": { "session_ids": [ "str" # Optional. Specific session IDs included in the @@ -210399,6 +210627,19 @@ def create_export( "str" # Optional. Signal types included in the export. ] }, + "status": "str", # The current status of the export job. Required. Known + values are: "pending", "processing", "complete", and "failed". + "agent_id": "str", # Optional. The environment whose data is being exported. + For Harness Runtime, this is the Environment Config ID. Not meaningful for + ``inference`` exports; use ``type`` to distinguish the export scope. + "completed_at": 0, # Optional. Unix timestamp when the export completed, or + null if still in progress. + "environment_id": "str", # Optional. Same as agent_id. Dual-emitted during + the rename. + "error_message": "str", # Optional. Error message if the export failed, or + null on success. + "expires_at": 0, # Optional. Unix timestamp when the export download link + expires. "type": "str" # Optional. The scope of the export. ``agent`` covers one Harness Runtime environment; ``inference`` covers the team's Serverless Inference Signals conversations. Known values are: "agent" and "inference". @@ -210423,9 +210664,10 @@ def create_export(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: To create a new signals data export, send a POST request to ``/v1/signals/exports``. To export one Harness Runtime environment, include its - ``agent_id`` (\\ ``type`` defaults to ``agent``\\ ). To export the team's Serverless - Inference Signals conversations, set ``type`` to ``inference`` and omit - ``agent_id``. You may optionally filter the export by ``signal_type``\\ , + ``environment_id`` (\\ ``type`` defaults to ``agent``\\ ). Deprecated ``agent_id`` is still + accepted. To export the team's Serverless Inference Signals conversations, set + ``type`` to ``inference`` and omit ``environment_id`` and ``agent_id``. You may + optionally filter the export by ``signal_type``\\ , ``session_ids``\\ , ``start_time``\\ , and ``end_time``. Use the export options endpoint to discover available signal types. @@ -210444,11 +210686,16 @@ def create_export(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: # JSON input template you can fill out and use as your body input. body = { - "agent_id": "str", # Optional. The environment whose data should be - exported. For Harness Runtime, this is the Environment Config ID. Required when - ``type`` is ``agent``"" ; must be omitted when ``type`` is ``inference``. + "agent_id": "str", # Optional. Deprecated alias for ``environment_id``. + Accepted for backward compatibility; must equal ``environment_id`` when both are + set. Both set and different returns 400. Required when ``type`` is ``agent`` if + ``environment_id`` is omitted; must be omitted when ``type`` is ``inference``. "end_time": "2020-02-20 00:00:00", # Optional. Include only sessions that started at or before this timestamp. + "environment_id": "str", # Optional. The environment whose data should be + exported. For Harness Runtime, this is the Environment Config ID. Required when + ``type`` is ``agent`` if ``agent_id`` is omitted; must be omitted when ``type`` + is ``inference``. Prefer this over ``agent_id``. "session_ids": [ "str" # Optional. Optional list of specific session IDs to include in the export. @@ -210460,28 +210707,18 @@ def create_export(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: "start_time": "2020-02-20 00:00:00", # Optional. Include only sessions that started at or after this timestamp. "type": "str" # Optional. The scope of the export. ``agent`` exports Signals - conversations for one Harness Runtime environment and requires ``agent_id``. - ``inference`` exports Serverless Inference Signals conversations for the whole - team (team-wide; omit ``agent_id``"" ). Defaults to ``agent`` when ``agent_id`` - is provided and to ``inference`` when it is omitted. Known values are: "agent" + conversations for one Harness Runtime environment and requires ``environment_id`` + (or deprecated ``agent_id``"" ). ``inference`` exports Serverless Inference + Signals conversations for the whole team (team-wide; omit ``environment_id`` and + ``agent_id``"" ). Defaults to ``agent`` when ``environment_id`` or ``agent_id`` + is provided and to ``inference`` when both are omitted. Known values are: "agent" and "inference". } # response body for status code(s): 201 response == { - "agent_id": "str", # The environment whose data is being exported. For - Harness Runtime, this is the Environment Config ID. Not meaningful for - ``inference`` exports; use ``type`` to distinguish the export scope. Required. "created_at": 0, # Unix timestamp when the export was created. Required. "export_id": "str", # The unique identifier for the export job. Required. - "status": "str", # The current status of the export job. Required. Known - values are: "pending", "processing", "complete", and "failed". - "completed_at": 0, # Optional. Unix timestamp when the export completed, or - null if still in progress. - "error_message": "str", # Optional. Error message if the export failed, or - null on success. - "expires_at": 0, # Optional. Unix timestamp when the export download link - expires. "filters": { "session_ids": [ "str" # Optional. Specific session IDs included in the @@ -210491,6 +210728,19 @@ def create_export(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: "str" # Optional. Signal types included in the export. ] }, + "status": "str", # The current status of the export job. Required. Known + values are: "pending", "processing", "complete", and "failed". + "agent_id": "str", # Optional. The environment whose data is being exported. + For Harness Runtime, this is the Environment Config ID. Not meaningful for + ``inference`` exports; use ``type`` to distinguish the export scope. + "completed_at": 0, # Optional. Unix timestamp when the export completed, or + null if still in progress. + "environment_id": "str", # Optional. Same as agent_id. Dual-emitted during + the rename. + "error_message": "str", # Optional. Error message if the export failed, or + null on success. + "expires_at": 0, # Optional. Unix timestamp when the export download link + expires. "type": "str" # Optional. The scope of the export. ``agent`` covers one Harness Runtime environment; ``inference`` covers the team's Serverless Inference Signals conversations. Known values are: "agent" and "inference". @@ -210718,19 +210968,8 @@ def get_export(self, export_id: str, **kwargs: Any) -> JSON: # response body for status code(s): 200 response == { - "agent_id": "str", # The environment whose data is being exported. For - Harness Runtime, this is the Environment Config ID. Not meaningful for - ``inference`` exports; use ``type`` to distinguish the export scope. Required. "created_at": 0, # Unix timestamp when the export was created. Required. "export_id": "str", # The unique identifier for the export job. Required. - "status": "str", # The current status of the export job. Required. Known - values are: "pending", "processing", "complete", and "failed". - "completed_at": 0, # Optional. Unix timestamp when the export completed, or - null if still in progress. - "error_message": "str", # Optional. Error message if the export failed, or - null on success. - "expires_at": 0, # Optional. Unix timestamp when the export download link - expires. "filters": { "session_ids": [ "str" # Optional. Specific session IDs included in the @@ -210740,6 +210979,19 @@ def get_export(self, export_id: str, **kwargs: Any) -> JSON: "str" # Optional. Signal types included in the export. ] }, + "status": "str", # The current status of the export job. Required. Known + values are: "pending", "processing", "complete", and "failed". + "agent_id": "str", # Optional. The environment whose data is being exported. + For Harness Runtime, this is the Environment Config ID. Not meaningful for + ``inference`` exports; use ``type`` to distinguish the export scope. + "completed_at": 0, # Optional. Unix timestamp when the export completed, or + null if still in progress. + "environment_id": "str", # Optional. Same as agent_id. Dual-emitted during + the rename. + "error_message": "str", # Optional. Error message if the export failed, or + null on success. + "expires_at": 0, # Optional. Unix timestamp when the export download link + expires. "type": "str" # Optional. The scope of the export. ``agent`` covers one Harness Runtime environment; ``inference`` covers the team's Serverless Inference Signals conversations. Known values are: "agent" and "inference". @@ -210998,6 +211250,9 @@ def list_deletions( deleted. Only present for ``agent`` deletions. "completed_at": 0, # Optional. Unix timestamp when the deletion finished, or null if still in progress. + "environment_id": "str", # Optional. Same as + agent_id when present. Dual-emitted during the rename; omitted when + agent_id is omitted. "error_message": "str", # Optional. Error message if the deletion failed, or null otherwise. "started_at": 0 # Optional. Unix timestamp when @@ -211117,15 +211372,16 @@ def create_deletion( * ``agent`` — deletes Signals conversations for one Harness Runtime environment and - turns off collection for that environment. Requires ``agent_id``\\ , which is the - environment's Environment Config ID (the environment's ``agent_id``\\ ). On create, matching - conversations are hidden from Signals reads immediately. Wait until the + turns off collection for that environment. Requires ``environment_id`` (the + environment's Environment Config ID). Deprecated ``agent_id`` is still accepted; + both set and equal is accepted, both set and different returns 400. On create, + matching conversations are hidden from Signals reads immediately. Wait until the job is ``complete`` before enabling Signals for the environment again. * ``inference`` — deletes Serverless Inference Signals conversations for your whole team (team-wide; not limited to one endpoint or model) that were collected at or before the deletion request, and turns off team inference - collection (\\ ``source=inference``\\ ). Do not send ``agent_id``. On create, - matching conversations are hidden from Signals reads immediately. + collection (\\ ``source=inference``\\ ). Do not send ``environment_id`` or ``agent_id``. + On create, matching conversations are hidden from Signals reads immediately. The job runs asynchronously; poll the get endpoint until ``status`` is ``complete`` or ``failed``. DigitalOcean may retry transient processing errors @@ -211161,14 +211417,18 @@ def create_deletion( "team_id": 0, # The team whose data should be deleted. Must match the authenticated team. Required. "type": "str", # The scope of the deletion. ``agent`` deletes Signals - conversations for one Harness Runtime environment and requires ``agent_id``. - ``inference`` deletes Serverless Inference Signals conversations for the whole - team (team-wide; omit ``agent_id``"" ). Required. Known values are: "agent" and - "inference". - "agent_id": "str" # Optional. The Harness Runtime Environment Config ID of - the environment whose conversations should be deleted. This is the environment's - ``agent_id``. Required when ``type`` is ``agent``"" ; must be omitted when - ``type`` is ``inference``. + conversations for one Harness Runtime environment and requires ``environment_id`` + (or deprecated ``agent_id``"" ). ``inference`` deletes Serverless Inference + Signals conversations for the whole team (team-wide; omit ``environment_id`` and + ``agent_id``"" ). Required. Known values are: "agent" and "inference". + "agent_id": "str", # Optional. Deprecated alias for ``environment_id``. + Accepted for backward compatibility; must equal ``environment_id`` when both are + set. Both set and different returns 400. Required when ``type`` is ``agent`` if + ``environment_id`` is omitted; must be omitted when ``type`` is ``inference``. + "environment_id": "str" # Optional. The Harness Runtime Environment Config + ID of the environment whose conversations should be deleted. Required when + ``type`` is ``agent`` if ``agent_id`` is omitted; must be omitted when ``type`` + is ``inference``. Prefer this over ``agent_id``. } # response body for status code(s): 200, 202 @@ -211189,6 +211449,8 @@ def create_deletion( deletions. "completed_at": 0, # Optional. Unix timestamp when the deletion finished, or null if still in progress. + "environment_id": "str", # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is omitted. "error_message": "str", # Optional. Error message if the deletion failed, or null otherwise. "started_at": 0 # Optional. Unix timestamp when processing started, or null @@ -211221,15 +211483,16 @@ def create_deletion( * ``agent`` — deletes Signals conversations for one Harness Runtime environment and - turns off collection for that environment. Requires ``agent_id``\\ , which is the - environment's Environment Config ID (the environment's ``agent_id``\\ ). On create, matching - conversations are hidden from Signals reads immediately. Wait until the + turns off collection for that environment. Requires ``environment_id`` (the + environment's Environment Config ID). Deprecated ``agent_id`` is still accepted; + both set and equal is accepted, both set and different returns 400. On create, + matching conversations are hidden from Signals reads immediately. Wait until the job is ``complete`` before enabling Signals for the environment again. * ``inference`` — deletes Serverless Inference Signals conversations for your whole team (team-wide; not limited to one endpoint or model) that were collected at or before the deletion request, and turns off team inference - collection (\\ ``source=inference``\\ ). Do not send ``agent_id``. On create, - matching conversations are hidden from Signals reads immediately. + collection (\\ ``source=inference``\\ ). Do not send ``environment_id`` or ``agent_id``. + On create, matching conversations are hidden from Signals reads immediately. The job runs asynchronously; poll the get endpoint until ``status`` is ``complete`` or ``failed``. DigitalOcean may retry transient processing errors @@ -211278,6 +211541,8 @@ def create_deletion( deletions. "completed_at": 0, # Optional. Unix timestamp when the deletion finished, or null if still in progress. + "environment_id": "str", # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is omitted. "error_message": "str", # Optional. Error message if the deletion failed, or null otherwise. "started_at": 0 # Optional. Unix timestamp when processing started, or null @@ -211308,15 +211573,16 @@ def create_deletion(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: * ``agent`` — deletes Signals conversations for one Harness Runtime environment and - turns off collection for that environment. Requires ``agent_id``\\ , which is the - environment's Environment Config ID (the environment's ``agent_id``\\ ). On create, matching - conversations are hidden from Signals reads immediately. Wait until the + turns off collection for that environment. Requires ``environment_id`` (the + environment's Environment Config ID). Deprecated ``agent_id`` is still accepted; + both set and equal is accepted, both set and different returns 400. On create, + matching conversations are hidden from Signals reads immediately. Wait until the job is ``complete`` before enabling Signals for the environment again. * ``inference`` — deletes Serverless Inference Signals conversations for your whole team (team-wide; not limited to one endpoint or model) that were collected at or before the deletion request, and turns off team inference - collection (\\ ``source=inference``\\ ). Do not send ``agent_id``. On create, - matching conversations are hidden from Signals reads immediately. + collection (\\ ``source=inference``\\ ). Do not send ``environment_id`` or ``agent_id``. + On create, matching conversations are hidden from Signals reads immediately. The job runs asynchronously; poll the get endpoint until ``status`` is ``complete`` or ``failed``. DigitalOcean may retry transient processing errors @@ -211349,14 +211615,18 @@ def create_deletion(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: "team_id": 0, # The team whose data should be deleted. Must match the authenticated team. Required. "type": "str", # The scope of the deletion. ``agent`` deletes Signals - conversations for one Harness Runtime environment and requires ``agent_id``. - ``inference`` deletes Serverless Inference Signals conversations for the whole - team (team-wide; omit ``agent_id``"" ). Required. Known values are: "agent" and - "inference". - "agent_id": "str" # Optional. The Harness Runtime Environment Config ID of - the environment whose conversations should be deleted. This is the environment's - ``agent_id``. Required when ``type`` is ``agent``"" ; must be omitted when - ``type`` is ``inference``. + conversations for one Harness Runtime environment and requires ``environment_id`` + (or deprecated ``agent_id``"" ). ``inference`` deletes Serverless Inference + Signals conversations for the whole team (team-wide; omit ``environment_id`` and + ``agent_id``"" ). Required. Known values are: "agent" and "inference". + "agent_id": "str", # Optional. Deprecated alias for ``environment_id``. + Accepted for backward compatibility; must equal ``environment_id`` when both are + set. Both set and different returns 400. Required when ``type`` is ``agent`` if + ``environment_id`` is omitted; must be omitted when ``type`` is ``inference``. + "environment_id": "str" # Optional. The Harness Runtime Environment Config + ID of the environment whose conversations should be deleted. Required when + ``type`` is ``agent`` if ``agent_id`` is omitted; must be omitted when ``type`` + is ``inference``. Prefer this over ``agent_id``. } # response body for status code(s): 200, 202 @@ -211377,6 +211647,8 @@ def create_deletion(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: deletions. "completed_at": 0, # Optional. Unix timestamp when the deletion finished, or null if still in progress. + "environment_id": "str", # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is omitted. "error_message": "str", # Optional. Error message if the deletion failed, or null otherwise. "started_at": 0 # Optional. Unix timestamp when processing started, or null @@ -211568,6 +211840,8 @@ def get_deletion(self, deletion_id: str, **kwargs: Any) -> JSON: deletions. "completed_at": 0, # Optional. Unix timestamp when the deletion finished, or null if still in progress. + "environment_id": "str", # Optional. Same as agent_id when present. + Dual-emitted during the rename; omitted when agent_id is omitted. "error_message": "str", # Optional. Error message if the deletion failed, or null otherwise. "started_at": 0 # Optional. Unix timestamp when processing started, or null @@ -256635,6 +256909,8 @@ def list(self, *, per_page: int = 20, page: int = 1, **kwargs: Any) -> JSON: this size. Required. "disk_info": [ { + "ephemeral": bool, # Optional. Indicates an + ephemeral (non-persistent) disk. "size": { "amount": 0, # Optional. The amount of space allocated to the disk. @@ -327223,11 +327499,10 @@ def create_model_evaluation_run( evaluate. "dataset_uuid": "str", # Optional. UUID of the dataset to use for evaluation. - "epochs": 0, # Optional. Number of times to evaluate each dataset row - (n-pass/epochs), so the result reports avg@k/pass@k/cons@k instead of a single - score. Defaults to 1 when unset. Capped at 3 until throughput/sharding work - lands, since each extra epoch roughly multiplies wall-clock run time. Not - persisted on presets. + "epochs": 0, # Optional. How many times each dataset row is evaluated. + Defaults to 1, maximum 10. When more than 1, the results show how consistent the + model is across attempts (avg@k, pass@k, cons@k). Each extra attempt makes the + run take longer. Not saved in presets. "eval_preset_uuid": "str", # Optional. "judge_model_uuid": "str", # Optional. UUID of the judge model used to score responses. @@ -327369,11 +327644,10 @@ def create_model_evaluation_run( evaluate. "dataset_uuid": "str", # Optional. UUID of the dataset to use for evaluation. - "epochs": 0, # Optional. Number of times to evaluate each dataset row - (n-pass/epochs), so the result reports avg@k/pass@k/cons@k instead of a single - score. Defaults to 1 when unset. Capped at 3 until throughput/sharding work - lands, since each extra epoch roughly multiplies wall-clock run time. Not - persisted on presets. + "epochs": 0, # Optional. How many times each dataset row is evaluated. + Defaults to 1, maximum 10. When more than 1, the results show how consistent the + model is across attempts (avg@k, pass@k, cons@k). Each extra attempt makes the + run take longer. Not saved in presets. "eval_preset_uuid": "str", # Optional. "judge_model_uuid": "str", # Optional. UUID of the judge model used to score responses.