Excavator: Upgrade API Version

Author: svc-excavator-bot

README.md

@@ -1569,6 +1569,7 @@ Namespace | Name | Import |
 **Functions** | [RangesConstraint](docs/v2/Functions/models/RangesConstraint.md) | `from foundry_sdk.v2.functions.models import RangesConstraint` |
 **Functions** | [RegexConstraint](docs/v2/Functions/models/RegexConstraint.md) | `from foundry_sdk.v2.functions.models import RegexConstraint` |
 **Functions** | [RidConstraint](docs/v2/Functions/models/RidConstraint.md) | `from foundry_sdk.v2.functions.models import RidConstraint` |
+**Functions** | [StreamingExecuteQueryRequest](docs/v2/Functions/models/StreamingExecuteQueryRequest.md) | `from foundry_sdk.v2.functions.models import StreamingExecuteQueryRequest` |
 **Functions** | [StructConstraint](docs/v2/Functions/models/StructConstraint.md) | `from foundry_sdk.v2.functions.models import StructConstraint` |
 **Functions** | [StructFieldApiName](docs/v2/Functions/models/StructFieldApiName.md) | `from foundry_sdk.v2.functions.models import StructFieldApiName` |
 **Functions** | [StructFieldName](docs/v2/Functions/models/StructFieldName.md) | `from foundry_sdk.v2.functions.models import StructFieldName` |
@@ -2805,6 +2806,7 @@ Namespace | Name | Import |
 **Functions** | QueryRuntimeError | `from foundry_sdk.v2.functions.errors import QueryRuntimeError` |
 **Functions** | QueryTimeExceededLimit | `from foundry_sdk.v2.functions.errors import QueryTimeExceededLimit` |
 **Functions** | QueryVersionNotFound | `from foundry_sdk.v2.functions.errors import QueryVersionNotFound` |
+**Functions** | StreamingExecuteQueryPermissionDenied | `from foundry_sdk.v2.functions.errors import StreamingExecuteQueryPermissionDenied` |
 **Functions** | UnknownParameter | `from foundry_sdk.v2.functions.errors import UnknownParameter` |
 **Functions** | ValueTypeNotFound | `from foundry_sdk.v2.functions.errors import ValueTypeNotFound` |
 **Functions** | VersionIdNotFound | `from foundry_sdk.v2.functions.errors import VersionIdNotFound` |

docs-snippets-npm/package.json

@@ -24,7 +24,7 @@
   "sls": {
     "dependencies": {
       "com.palantir.foundry.api:api-gateway": {
-        "minVersion": "1.1350.0",
+        "minVersion": "1.1362.0",
         "maxVersion": "1.x.x",
         "optional": false
       }

docs-snippets-npm/src/index.ts

@@ -1038,6 +1038,11 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets<typeof PLATFORM_API_DOCS_SPEC
             "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# FunctionRid\nrid = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n# Optional[FunctionVersion]\nversion = None\n\n\ntry:\n    api_response = client.functions.Query.get_by_rid(rid=rid, preview=preview, version=version)\n    print(\"The get_by_rid response:\\n\")\n    pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n    print(\"HTTP error when calling Query.get_by_rid: %s\\n\" % e)"
           }
         ],
+        "v2.streamingExecuteQuery": [
+          {
+            "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# QueryApiName\nquery_api_name = None\n# Dict[ParameterId, Optional[DataValue]]\nparameters = None\n# Optional[Attribution]\nattribution = None\n# Optional[OntologyIdentifier] | Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function.\nontology = \"example-ontology\"\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n# Optional[TraceParent]\ntrace_parent = None\n# Optional[TraceState]\ntrace_state = None\n# Optional[FunctionVersion]\nversion = None\n\n\ntry:\n    api_response = client.functions.Query.streaming_execute(\n        query_api_name,\n        parameters=parameters,\n        attribution=attribution,\n        ontology=ontology,\n        preview=preview,\n        trace_parent=trace_parent,\n        trace_state=trace_state,\n        version=version,\n    )\n    print(\"The streaming_execute response:\\n\")\n    pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n    print(\"HTTP error when calling Query.streaming_execute: %s\\n\" % e)"
+          }
+        ],
         "v2.getValueType": [
           {
             "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# ValueTypeRid\nvalue_type_rid = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n    api_response = client.functions.ValueType.get(value_type_rid, preview=preview)\n    print(\"The get response:\\n\")\n    pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n    print(\"HTTP error when calling ValueType.get: %s\\n\" % e)"

docs/v2/Functions/Query.md

@@ -5,11 +5,15 @@ Method | HTTP request | Release Stage |
 [**execute**](#execute) | **POST** /v2/functions/queries/{queryApiName}/execute | Private Beta |
 [**get**](#get) | **GET** /v2/functions/queries/{queryApiName} | Private Beta |
 [**get_by_rid**](#get_by_rid) | **POST** /v2/functions/queries/getByRid | Private Beta |
+[**streaming_execute**](#streaming_execute) | **POST** /v2/functions/queries/{queryApiName}/streamingExecute | Private Beta |
 
 # **execute**
 Executes a Query using the given parameters. By default, this executes the latest version of the query.
 
-Optional parameters do not need to be supplied.
+This endpoint is maintained for backward compatibility only.
+
+For all new implementations, use the `streamingExecute` endpoint, which supports all function types 
+and provides enhanced functionality.
 
 
 ### Parameters
@@ -190,3 +194,105 @@ See [README](../../../README.md#authorization)
 
 [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)
 
+# **streaming_execute**
+Executes a Query using the given parameters, returning results as an NDJSON stream. By default, this executes the latest version of the query.
+
+This endpoint supports all Query functions. The endpoint name 'streamingExecute' refers to the NDJSON
+streaming response format. Both streaming and non-streaming functions can use this endpoint.
+Non-streaming functions return a single-line NDJSON response, while streaming functions return multi-line NDJSON responses.
+This is the recommended endpoint for all query execution.
+
+The response is returned as a binary stream in NDJSON (Newline Delimited JSON) format, where each line
+is a StreamingExecuteQueryResponse containing either a data batch or an error.
+
+For a function returning a list of 5 records with a batch size of 3, the response stream would contain
+two lines. The first line contains the first 3 items, and the second line contains the remaining 2 items:
+
+```
+{"type":"data","value":[{"productId":"SKU-001","price":29.99},{"productId":"SKU-002","price":49.99},{"productId":"SKU-003","price":19.99}]}
+{"type":"data","value":[{"productId":"SKU-004","price":39.99},{"productId":"SKU-005","price":59.99}]}
+```
+
+Each line is a separate JSON object followed by a newline character. Clients should parse the stream
+line-by-line to process results as they arrive. If an error occurs during execution, the stream will
+contain an error line:
+
+```
+{"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes |
+------------- | ------------- | ------------- | ------------- |
+**query_api_name** | QueryApiName |  |  |
+**parameters** | Dict[ParameterId, Optional[DataValue]] |  |  |
+**attribution** | Optional[Attribution] |  | [optional] |
+**ontology** | Optional[OntologyIdentifier] | Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function.  | [optional] |
+**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
+**trace_parent** | Optional[TraceParent] |  | [optional] |
+**trace_state** | Optional[TraceState] |  | [optional] |
+**version** | Optional[FunctionVersion] |  | [optional] |
+
+### Return type
+**bytes**
+
+### Example
+
+```python
+from foundry_sdk import FoundryClient
+import foundry_sdk
+from pprint import pprint
+
+client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
+
+# QueryApiName
+query_api_name = None
+# Dict[ParameterId, Optional[DataValue]]
+parameters = None
+# Optional[Attribution]
+attribution = None
+# Optional[OntologyIdentifier] | Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function.
+ontology = "example-ontology"
+# Optional[PreviewMode] | Enables the use of preview functionality.
+preview = None
+# Optional[TraceParent]
+trace_parent = None
+# Optional[TraceState]
+trace_state = None
+# Optional[FunctionVersion]
+version = None
+
+
+try:
+    api_response = client.functions.Query.streaming_execute(
+        query_api_name,
+        parameters=parameters,
+        attribution=attribution,
+        ontology=ontology,
+        preview=preview,
+        trace_parent=trace_parent,
+        trace_state=trace_state,
+        version=version,
+    )
+    print("The streaming_execute response:\n")
+    pprint(api_response)
+except foundry_sdk.PalantirRPCException as e:
+    print("HTTP error when calling Query.streaming_execute: %s\n" % e)
+
+```
+
+
+
+### Authorization
+
+See [README](../../../README.md#authorization)
+
+### HTTP response details
+| Status Code | Type        | Description | Content Type |
+|-------------|-------------|-------------|------------------|
+**200** | bytes  |  | application/octet-stream |
+
+[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)
+

docs/v2/Functions/models/StreamingExecuteQueryRequest.md

@@ -0,0 +1,13 @@
+# StreamingExecuteQueryRequest
+
+StreamingExecuteQueryRequest
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**ontology** | Optional[OntologyIdentifier] | No | Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function.  |
+**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes |  |
+**version** | Optional[FunctionVersion] | No |  |
+
+
+[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

foundry_sdk/_versions.py

@@ -17,4 +17,4 @@
 # using the autorelease bot
 __version__ = "0.0.0"
 
-__openapi_document_version__ = "1.1350.0"
+__openapi_document_version__ = "1.1362.0"

foundry_sdk/v2/cli.py

@@ -5307,7 +5307,10 @@ def functions_query_op_execute(
     """
     Executes a Query using the given parameters. By default, this executes the latest version of the query.
 
-    Optional parameters do not need to be supplied.
+    This endpoint is maintained for backward compatibility only.
+
+    For all new implementations, use the `streamingExecute` endpoint, which supports all function types
+    and provides enhanced functionality.
 
     """
     result = client.functions.Query.execute(
@@ -5372,6 +5375,77 @@ def functions_query_op_get_by_rid(
     click.echo(repr(result))
 
 
+@functions_query.command("streaming_execute")
+@click.argument("query_api_name", type=str, required=True)
+@click.option("--parameters", type=str, required=True, help="""""")
+@click.option("--attribution", type=str, required=False, help="""""")
+@click.option(
+    "--ontology",
+    type=str,
+    required=False,
+    help="""Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped
+function. When omitted, executes a global function.
+""",
+)
+@click.option(
+    "--preview", type=bool, required=False, help="""Enables the use of preview functionality."""
+)
+@click.option("--trace_parent", type=str, required=False, help="""""")
+@click.option("--trace_state", type=str, required=False, help="""""")
+@click.option("--version", type=str, required=False, help="""""")
+@click.pass_obj
+def functions_query_op_streaming_execute(
+    client: FoundryClient,
+    query_api_name: str,
+    parameters: str,
+    attribution: typing.Optional[str],
+    ontology: typing.Optional[str],
+    preview: typing.Optional[bool],
+    trace_parent: typing.Optional[str],
+    trace_state: typing.Optional[str],
+    version: typing.Optional[str],
+):
+    """
+    Executes a Query using the given parameters, returning results as an NDJSON stream. By default, this executes the latest version of the query.
+
+    This endpoint supports all Query functions. The endpoint name 'streamingExecute' refers to the NDJSON
+    streaming response format. Both streaming and non-streaming functions can use this endpoint.
+    Non-streaming functions return a single-line NDJSON response, while streaming functions return multi-line NDJSON responses.
+    This is the recommended endpoint for all query execution.
+
+    The response is returned as a binary stream in NDJSON (Newline Delimited JSON) format, where each line
+    is a StreamingExecuteQueryResponse containing either a data batch or an error.
+
+    For a function returning a list of 5 records with a batch size of 3, the response stream would contain
+    two lines. The first line contains the first 3 items, and the second line contains the remaining 2 items:
+
+    ```
+    {"type":"data","value":[{"productId":"SKU-001","price":29.99},{"productId":"SKU-002","price":49.99},{"productId":"SKU-003","price":19.99}]}
+    {"type":"data","value":[{"productId":"SKU-004","price":39.99},{"productId":"SKU-005","price":59.99}]}
+    ```
+
+    Each line is a separate JSON object followed by a newline character. Clients should parse the stream
+    line-by-line to process results as they arrive. If an error occurs during execution, the stream will
+    contain an error line:
+
+    ```
+    {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
+    ```
+
+    """
+    result = client.functions.Query.streaming_execute(
+        query_api_name=query_api_name,
+        parameters=json.loads(parameters),
+        attribution=attribution,
+        ontology=ontology,
+        preview=preview,
+        trace_parent=trace_parent,
+        trace_state=trace_state,
+        version=version,
+    )
+    click.echo(result)
+
+
 @cli.group("geo")
 def geo():
     pass

foundry_sdk/v2/functions/errors.py

@@ -211,6 +211,21 @@ class QueryVersionNotFound(errors.NotFoundError):
     error_instance_id: str
 
 
+class StreamingExecuteQueryPermissionDeniedParameters(typing_extensions.TypedDict):
+    """Could not streamingExecute the Query."""
+
+    __pydantic_config__ = {"extra": "allow"}  # type: ignore
+
+    queryApiName: functions_models.QueryApiName
+
+
+@dataclass
+class StreamingExecuteQueryPermissionDenied(errors.PermissionDeniedError):
+    name: typing.Literal["StreamingExecuteQueryPermissionDenied"]
+    parameters: StreamingExecuteQueryPermissionDeniedParameters
+    error_instance_id: str
+
+
 class UnknownParameterParameters(typing_extensions.TypedDict):
     """
     The provided parameters were not found. Please look at the `knownParameters` field
@@ -273,6 +288,7 @@ class VersionIdNotFound(errors.NotFoundError):
     "QueryRuntimeError",
     "QueryTimeExceededLimit",
     "QueryVersionNotFound",
+    "StreamingExecuteQueryPermissionDenied",
     "UnknownParameter",
     "ValueTypeNotFound",
     "VersionIdNotFound",

foundry_sdk/v2/functions/models.py

@@ -22,6 +22,7 @@
 
 from foundry_sdk import _core as core
 from foundry_sdk.v2.core import models as core_models
+from foundry_sdk.v2.ontologies import models as ontologies_models
 
 
 class ArrayConstraint(core.ModelBase):
@@ -285,6 +286,19 @@ class RidConstraint(core.ModelBase):
     type: typing.Literal["rid"] = "rid"
 
 
+class StreamingExecuteQueryRequest(core.ModelBase):
+    """StreamingExecuteQueryRequest"""
+
+    ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None
+    """
+    Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped
+    function. When omitted, executes a global function.
+    """
+
+    parameters: typing.Dict[ParameterId, typing.Optional[DataValue]]
+    version: typing.Optional[FunctionVersion] = None
+
+
 class StructConstraint(core.ModelBase):
     """StructConstraint"""
 
@@ -593,6 +607,7 @@ class VersionId(core.ModelBase):
     "RangesConstraint",
     "RegexConstraint",
     "RidConstraint",
+    "StreamingExecuteQueryRequest",
     "StructConstraint",
     "StructFieldApiName",
     "StructFieldName",