Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 92 additions & 1 deletion README.md

Large diffs are not rendered by default.

6 changes: 5 additions & 1 deletion config.json
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,13 @@
"skipValidation": {
"Filesystem": ["ResourceType"]
},
"tableOperations": [
"arrowTableOperations": [
"readTableDataset",
"getResultsSqlQuery"
],
"parquetTableOperations": [
"parquetExperimentSeries",
"parquetExperimentArtifactTable"
]
}
},
Expand Down
2 changes: 1 addition & 1 deletion docs-snippets-npm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"sls": {
"dependencies": {
"com.palantir.foundry.api:api-gateway": {
"minVersion": "1.1483.0",
"minVersion": "1.1485.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
39 changes: 37 additions & 2 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions docs/v1/Core/models/MediaReferenceType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# MediaReferenceType

MediaReferenceType

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**type** | Literal["mediaReference"] | Yes | None |


[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md)
1 change: 1 addition & 0 deletions docs/v1/Ontologies/models/OntologyDataType.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ BooleanType | boolean
CipherTextType | cipherText
MarkingType | marking
UnsupportedType | unsupported
MediaReferenceType | mediaReference
OntologyArrayType | array
OntologyObjectSetType | objectSet
BinaryType | binary
Expand Down
1 change: 1 addition & 0 deletions docs/v1/Ontologies/models/QueryDataType.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ LongType | long
BooleanType | boolean
UnsupportedType | unsupported
AttachmentType | attachment
MediaReferenceType | mediaReference
NullType | null
QueryArrayType | array
OntologyObjectSetType | objectSet
Expand Down
1 change: 1 addition & 0 deletions docs/v2/Functions/models/QueryDataType.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ LongType | long
BooleanType | boolean
UnsupportedType | unsupported
AttachmentType | attachment
MediaReferenceType | mediaReference
NullType | null
QueryArrayType | array
TwoDimensionalAggregation | twoDimensionalAggregation
Expand Down
4 changes: 4 additions & 0 deletions docs/v2/LanguageModels/AnthropicModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Name | Type | Description | Notes |
**max_tokens** | int | The maximum number of tokens to generate before stopping. | |
**messages** | List[AnthropicMessage] | Input messages to the model. This can include a single user-role message or multiple messages with alternating user and assistant roles. | |
**attribution** | Optional[Attribution] | | [optional] |
**output_config** | Optional[AnthropicOutputConfig] | Configuration to control the shape of the model's output | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
**stop_sequences** | Optional[List[str]] | Custom text sequences that will cause the model to stop generating. | [optional] |
**system** | Optional[List[AnthropicSystemMessage]] | A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. As of now, sending multiple system prompts is not supported. | [optional] |
Expand Down Expand Up @@ -45,6 +46,8 @@ max_tokens = None
messages = [{"role": "USER"}]
# Optional[Attribution]
attribution = None
# Optional[AnthropicOutputConfig] | Configuration to control the shape of the model's output
output_config = {"effort": "LOW"}
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None
# Optional[List[str]] | Custom text sequences that will cause the model to stop generating.
Expand All @@ -71,6 +74,7 @@ try:
max_tokens=max_tokens,
messages=messages,
attribution=attribution,
output_config=output_config,
preview=preview,
stop_sequences=stop_sequences,
system=system,
Expand Down
18 changes: 18 additions & 0 deletions docs/v2/LanguageModels/models/AnthropicEffort.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# AnthropicEffort

https://docs.anthropic.com/en/docs/build-with-claude/extended-thinking#effort

Controls how many tokens Claude uses when responding.
Supported by Claude models beginning with Opus 4.5.
Setting effort to HIGH produces the same behavior as omitting the parameter entirely.


| **Value** |
| --------- |
| `"LOW"` |
| `"MEDIUM"` |
| `"HIGH"` |
| `"MAX"` |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
12 changes: 12 additions & 0 deletions docs/v2/LanguageModels/models/AnthropicJsonSchemaOutputFormat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AnthropicJsonSchemaOutputFormat

AnthropicJsonSchemaOutputFormat

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**schema_** | JsonSchema | Yes | |
**type** | Literal["jsonSchema"] | Yes | None |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
1 change: 1 addition & 0 deletions docs/v2/LanguageModels/models/AnthropicMessagesRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ AnthropicMessagesRequest
**tools** | Optional[List[AnthropicTool]] | No | Definitions of tools that the model may use. |
**top_k** | Optional[int] | No | Only sample from the top K options for each subsequent token. |
**top_p** | Optional[float] | No | Use nucleus sampling. You should either alter temperature or top_p, but not both |
**output_config** | Optional[AnthropicOutputConfig] | No | Configuration to control the shape of the model's output |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
12 changes: 12 additions & 0 deletions docs/v2/LanguageModels/models/AnthropicOutputConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AnthropicOutputConfig

AnthropicOutputConfig

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**format** | Optional[AnthropicOutputFormat] | No | |
**effort** | Optional[AnthropicEffort] | No | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
11 changes: 11 additions & 0 deletions docs/v2/LanguageModels/models/AnthropicOutputFormat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AnthropicOutputFormat

AnthropicOutputFormat

## Type
```python
AnthropicJsonSchemaOutputFormat
```


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
133 changes: 133 additions & 0 deletions docs/v2/Models/Experiment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Experiment

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**get**](#get) | **GET** /v2/models/{modelRid}/experiments/{experimentRid} | Private Beta |
[**search**](#search) | **POST** /v2/models/{modelRid}/experiments/search | Private Beta |

# **get**
Retrieve a single experiment with all metadata, parameters, series metadata, and summary metrics.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**model_rid** | ModelRid | | |
**experiment_rid** | ExperimentRid | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**Experiment**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ModelRid
model_rid = None
# ExperimentRid
experiment_rid = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.models.Model.Experiment.get(model_rid, experiment_rid, preview=preview)
print("The get response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Experiment.get: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | Experiment | | application/json |

[[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)

# **search**
Search experiments using complex nested queries on experiment metadata, parameters, series,
and summary metrics. Supports AND/OR/NOT combinations and various predicates.
Returns a maximum of 100 results per page.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**model_rid** | ModelRid | | |
**order_by** | Optional[SearchExperimentsOrderBy] | The field to sort by. Default is to sort by relevance. | [optional] |
**page_size** | Optional[PageSize] | The maximum number of results to return. Default 50, maximum of 100. | [optional] |
**page_token** | Optional[PageToken] | PageToken to identify the next page to retrieve. Leave empty for the first request. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
**where** | Optional[SearchExperimentsFilter] | Optional search filter for filtering experiments. If not provided, all experiments for the model are returned. | [optional] |

### Return type
**SearchExperimentsResponse**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ModelRid
model_rid = None
# Optional[SearchExperimentsOrderBy] | The field to sort by. Default is to sort by relevance.
order_by = {"field": "EXPERIMENT_NAME", "direction": "ASC"}
# Optional[PageSize] | The maximum number of results to return. Default 50, maximum of 100.
page_size = 100
# Optional[PageToken] | PageToken to identify the next page to retrieve. Leave empty for the first request.
page_token = "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None
# Optional[SearchExperimentsFilter] | Optional search filter for filtering experiments. If not provided, all experiments for the model are returned.
where = None


try:
api_response = client.models.Model.Experiment.search(
model_rid,
order_by=order_by,
page_size=page_size,
page_token=page_token,
preview=preview,
where=where,
)
print("The search response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Experiment.search: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | SearchExperimentsResponse | | application/json |

[[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)

Loading