Skip to content

Excavator: Upgrade API Version #365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
svc-excavator-bot wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Excavator: Upgrade API Version #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -845,10 +845,33 @@ Namespace | Resource | Operation | HTTP request |
**MediaSets** | MediaSet | [**transform**](docs/v2/MediaSets/MediaSet.md#transform) | **POST** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform |
**MediaSets** | MediaSet | [**upload**](docs/v2/MediaSets/MediaSet.md#upload) | **POST** /v2/mediasets/{mediaSetRid}/items |
**MediaSets** | MediaSet | [**upload_media**](docs/v2/MediaSets/MediaSet.md#upload_media) | **PUT** /v2/mediasets/media/upload |
**Models** | Experiment | [**get**](docs/v2/Models/Experiment.md#get) | **GET** /v2/models/{modelRid}/experiments/{experimentRid} |
**Models** | Experiment | [**search**](docs/v2/Models/Experiment.md#search) | **POST** /v2/models/{modelRid}/experiments/search |
**Models** | ExperimentArtifactTable | [**json**](docs/v2/Models/ExperimentArtifactTable.md#json) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/json |
**Models** | ExperimentArtifactTable | [**parquet**](docs/v2/Models/ExperimentArtifactTable.md#parquet) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/parquet |
**Models** | ExperimentSeries | [**json**](docs/v2/Models/ExperimentSeries.md#json) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/json |
**Models** | ExperimentSeries | [**parquet**](docs/v2/Models/ExperimentSeries.md#parquet) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/parquet |
**Models** | LiveDeployment | [**create**](docs/v2/Models/LiveDeployment.md#create) | **POST** /v2/models/liveDeployments |
**Models** | LiveDeployment | [**get**](docs/v2/Models/LiveDeployment.md#get) | **GET** /v2/models/liveDeployments/{liveDeploymentRid} |
**Models** | LiveDeployment | [**list**](docs/v2/Models/LiveDeployment.md#list) | **GET** /v2/models/liveDeployments |
**Models** | LiveDeployment | [**replace**](docs/v2/Models/LiveDeployment.md#replace) | **PUT** /v2/models/liveDeployments/{liveDeploymentRid} |
**Models** | LiveDeployment | [**transform_json**](docs/v2/Models/LiveDeployment.md#transform_json) | **POST** /v2/models/liveDeployments/{liveDeploymentRid}/transformJson |
**Models** | Model | [**create**](docs/v2/Models/Model.md#create) | **POST** /v2/models |
**Models** | Model | [**get**](docs/v2/Models/Model.md#get) | **GET** /v2/models/{modelRid} |
**Models** | Model | [**promote_version**](docs/v2/Models/Model.md#promote_version) | **POST** /v2/models/{modelRid}/promoteVersion |
**Models** | ModelFunction | [**create**](docs/v2/Models/ModelFunction.md#create) | **POST** /v2/models/{modelRid}/function |
**Models** | ModelFunction | [**get**](docs/v2/Models/ModelFunction.md#get) | **GET** /v2/models/{modelRid}/function |
**Models** | ModelFunction | [**replace**](docs/v2/Models/ModelFunction.md#replace) | **PUT** /v2/models/{modelRid}/function |
**Models** | ModelStudio | [**create**](docs/v2/Models/ModelStudio.md#create) | **POST** /v2/models/modelStudios |
**Models** | ModelStudio | [**get**](docs/v2/Models/ModelStudio.md#get) | **GET** /v2/models/modelStudios/{modelStudioRid} |
**Models** | ModelStudio | [**launch**](docs/v2/Models/ModelStudio.md#launch) | **POST** /v2/models/modelStudios/{modelStudioRid}/launch |
**Models** | ModelStudioConfigVersion | [**create**](docs/v2/Models/ModelStudioConfigVersion.md#create) | **POST** /v2/models/modelStudios/{modelStudioRid}/configVersions |
**Models** | ModelStudioConfigVersion | [**get**](docs/v2/Models/ModelStudioConfigVersion.md#get) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions/{modelStudioConfigVersionVersion} |
**Models** | ModelStudioConfigVersion | [**latest**](docs/v2/Models/ModelStudioConfigVersion.md#latest) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions/latest |
**Models** | ModelStudioConfigVersion | [**list**](docs/v2/Models/ModelStudioConfigVersion.md#list) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions |
**Models** | ModelStudioRun | [**list**](docs/v2/Models/ModelStudioRun.md#list) | **GET** /v2/models/modelStudios/{modelStudioRid}/runs |
**Models** | ModelStudioTrainer | [**get**](docs/v2/Models/ModelStudioTrainer.md#get) | **GET** /v2/models/modelStudioTrainers/{modelStudioTrainerTrainerId} |
**Models** | ModelStudioTrainer | [**list**](docs/v2/Models/ModelStudioTrainer.md#list) | **GET** /v2/models/modelStudioTrainers |
**Models** | ModelVersion | [**get**](docs/v2/Models/ModelVersion.md#get) | **GET** /v2/models/{modelRid}/versions/{modelVersionRid} |
**Models** | ModelVersion | [**list**](docs/v2/Models/ModelVersion.md#list) | **GET** /v2/models/{modelRid}/versions |
**Ontologies** | Action | [**apply**](docs/v2/Ontologies/Action.md#apply) | **POST** /v2/ontologies/{ontology}/actions/{action}/apply |
Expand Down Expand Up @@ -2154,7 +2177,6 @@ Namespace | Name | Import |
**Models** | [ExperimentArtifactMetadata](docs/v2/Models/models/ExperimentArtifactMetadata.md) | `from foundry_sdk.v2.models.models import ExperimentArtifactMetadata` |
**Models** | [ExperimentArtifactName](docs/v2/Models/models/ExperimentArtifactName.md) | `from foundry_sdk.v2.models.models import ExperimentArtifactName` |
**Models** | [ExperimentAuthoringSource](docs/v2/Models/models/ExperimentAuthoringSource.md) | `from foundry_sdk.v2.models.models import ExperimentAuthoringSource` |
**Models** | [ExperimentBranch](docs/v2/Models/models/ExperimentBranch.md) | `from foundry_sdk.v2.models.models import ExperimentBranch` |
**Models** | [ExperimentCodeWorkspaceSource](docs/v2/Models/models/ExperimentCodeWorkspaceSource.md) | `from foundry_sdk.v2.models.models import ExperimentCodeWorkspaceSource` |
**Models** | [ExperimentRid](docs/v2/Models/models/ExperimentRid.md) | `from foundry_sdk.v2.models.models import ExperimentRid` |
**Models** | [ExperimentSdkSource](docs/v2/Models/models/ExperimentSdkSource.md) | `from foundry_sdk.v2.models.models import ExperimentSdkSource` |
Expand Down
2 changes: 1 addition & 1 deletion docs-snippets-npm/package.json
View file
Open in desktop
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.1656.0",
"minVersion": "1.1665.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
2 changes: 1 addition & 1 deletion docs-snippets-npm/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1390,7 +1390,7 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets<typeof PLATFORM_API_DOCS_SPEC
],
"v2.createModelStudioConfigVersion": [
{
"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# ModelStudioRid\nmodel_studio_rid = None\n# ModelStudioConfigVersionName | Human readable name of the configuration version and experiment.\nname = None\n# ResourceConfiguration | The compute resources allocated for training runs.\nresources = {\"gpu\": \"A100\"}\n# TrainerId | The identifier of the trainer to use for this configuration.\ntrainer_id = \"autogluon\"\n# ModelStudioWorkerConfig | The worker configuration including inputs, outputs, and custom settings.\nworker_config = None\n# Optional[str] | Changelog describing changes in this version.\nchangelog = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.ModelStudio.ConfigVersion.create(\n model_studio_rid,\n name=name,\n resources=resources,\n trainer_id=trainer_id,\n worker_config=worker_config,\n changelog=changelog,\n preview=preview,\n )\n print(\"The create response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ConfigVersion.create: %s\\n\" % e)"
"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# ModelStudioRid\nmodel_studio_rid = None\n# ModelStudioConfigVersionName | Human readable name of the configuration version and experiment.\nname = \"Initial configuration\"\n# ResourceConfiguration | The compute resources allocated for training runs.\nresources = {\"memory\": \"4G\", \"cpu\": \"2\"}\n# TrainerId | The identifier of the trainer to use for this configuration.\ntrainer_id = \"ri.models..trainer.autogluon_tabular_regression\"\n# ModelStudioWorkerConfig | The worker configuration including inputs, outputs, and custom settings.\nworker_config = {\n \"outputs\": {\n \"model\": {\n \"type\": \"model\",\n \"modelRid\": \"ri.models.main.model.a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n }\n },\n \"inputs\": {\n \"input_df\": {\n \"type\": \"dataset\",\n \"rid\": \"ri.foundry.main.dataset.a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"columnMapping\": {\"target_column\": [\"target\"]},\n \"ignoreColumns\": [],\n \"selectColumns\": [],\n }\n },\n}\n# Optional[str] | Changelog describing changes in this version.\nchangelog = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.ModelStudio.ConfigVersion.create(\n model_studio_rid,\n name=name,\n resources=resources,\n trainer_id=trainer_id,\n worker_config=worker_config,\n changelog=changelog,\n preview=preview,\n )\n print(\"The create response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ConfigVersion.create: %s\\n\" % e)"
}
],
"v2.getModelStudioConfigVersion": [
Expand Down
1 change: 0 additions & 1 deletion docs/v2/Admin/models/ListAuthenticationProvidersResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ ListAuthenticationProvidersResponse
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data** | List[AuthenticationProvider] | Yes | |
**next_page_token** | Optional[PageToken] | No | |


[[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: 0 additions & 1 deletion docs/v2/Admin/models/ListEnrollmentRoleAssignmentsResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ ListEnrollmentRoleAssignmentsResponse
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data** | List[EnrollmentRoleAssignment] | Yes | |
**next_page_token** | Optional[PageToken] | No | |


[[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: 0 additions & 1 deletion docs/v2/Admin/models/ListOrganizationGuestMembersResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ ListOrganizationGuestMembersResponse
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data** | List[OrganizationGuestMember] | Yes | |
**next_page_token** | Optional[PageToken] | No | |


[[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: 0 additions & 1 deletion docs/v2/Admin/models/ListOrganizationRoleAssignmentsResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ ListOrganizationRoleAssignmentsResponse
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data** | List[OrganizationRoleAssignment] | Yes | |
**next_page_token** | Optional[PageToken] | No | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
4 changes: 2 additions & 2 deletions docs/v2/Models/Experiment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

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**](#get) | **GET** /v2/models/{modelRid}/experiments/{experimentRid} | Public Beta |
[**search**](#search) | **POST** /v2/models/{modelRid}/experiments/search | Public Beta |

# **get**
Retrieve a single experiment with all metadata, parameters, series metadata, and summary metrics.
Expand Down
4 changes: 2 additions & 2 deletions docs/v2/Models/ExperimentArtifactTable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**json**](#json) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/json | Private Beta |
[**parquet**](#parquet) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/parquet | Private Beta |
[**json**](#json) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/json | Public Beta |
[**parquet**](#parquet) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/parquet | Public Beta |

# **json**
Read table data from an experiment artifact as a streamed binary response containing JSON.
Expand Down
4 changes: 2 additions & 2 deletions docs/v2/Models/ExperimentSeries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**json**](#json) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/json | Private Beta |
[**parquet**](#parquet) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/parquet | Private Beta |
[**json**](#json) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/json | Public Beta |
[**parquet**](#parquet) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/parquet | Public Beta |

# **json**
Retrieve raw time-series data for a single series in JSON format.
Expand Down
8 changes: 4 additions & 4 deletions docs/v2/Models/LiveDeployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**create**](#create) | **POST** /v2/models/liveDeployments | Private Beta |
[**get**](#get) | **GET** /v2/models/liveDeployments/{liveDeploymentRid} | Private Beta |
[**list**](#list) | **GET** /v2/models/liveDeployments | Private Beta |
[**replace**](#replace) | **PUT** /v2/models/liveDeployments/{liveDeploymentRid} | Private Beta |
[**create**](#create) | **POST** /v2/models/liveDeployments | Public Beta |
[**get**](#get) | **GET** /v2/models/liveDeployments/{liveDeploymentRid} | Public Beta |
[**list**](#list) | **GET** /v2/models/liveDeployments | Public Beta |
[**replace**](#replace) | **PUT** /v2/models/liveDeployments/{liveDeploymentRid} | Public Beta |
[**transform_json**](#transform_json) | **POST** /v2/models/liveDeployments/{liveDeploymentRid}/transformJson | Public Beta |

# **create**
Expand Down
6 changes: 3 additions & 3 deletions docs/v2/Models/ModelFunction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**create**](#create) | **POST** /v2/models/{modelRid}/function | Private Beta |
[**get**](#get) | **GET** /v2/models/{modelRid}/function | Private Beta |
[**replace**](#replace) | **PUT** /v2/models/{modelRid}/function | Private Beta |
[**create**](#create) | **POST** /v2/models/{modelRid}/function | Public Beta |
[**get**](#get) | **GET** /v2/models/{modelRid}/function | Public Beta |
[**replace**](#replace) | **PUT** /v2/models/{modelRid}/function | Public Beta |

# **create**
Creates a function for the model.
Expand Down
6 changes: 3 additions & 3 deletions docs/v2/Models/ModelStudio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**create**](#create) | **POST** /v2/models/modelStudios | Private Beta |
[**get**](#get) | **GET** /v2/models/modelStudios/{modelStudioRid} | Private Beta |
[**launch**](#launch) | **POST** /v2/models/modelStudios/{modelStudioRid}/launch | Private Beta |
[**create**](#create) | **POST** /v2/models/modelStudios | Public Beta |
[**get**](#get) | **GET** /v2/models/modelStudios/{modelStudioRid} | Public Beta |
[**launch**](#launch) | **POST** /v2/models/modelStudios/{modelStudioRid}/launch | Public Beta |

# **create**
Creates a new Model Studio.
Expand Down
32 changes: 24 additions & 8 deletions docs/v2/Models/ModelStudioConfigVersion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**create**](#create) | **POST** /v2/models/modelStudios/{modelStudioRid}/configVersions | Private Beta |
[**get**](#get) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions/{modelStudioConfigVersionVersion} | Private Beta |
[**latest**](#latest) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions/latest | Private Beta |
[**list**](#list) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions | Private Beta |
[**create**](#create) | **POST** /v2/models/modelStudios/{modelStudioRid}/configVersions | Public Beta |
[**get**](#get) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions/{modelStudioConfigVersionVersion} | Public Beta |
[**latest**](#latest) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions/latest | Public Beta |
[**list**](#list) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions | Public Beta |

# **create**
Creates a new Model Studio configuration version.
Expand Down Expand Up @@ -37,13 +37,29 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
# ModelStudioRid
model_studio_rid = None
# ModelStudioConfigVersionName | Human readable name of the configuration version and experiment.
name = None
name = "Initial configuration"
# ResourceConfiguration | The compute resources allocated for training runs.
resources = {"gpu": "A100"}
resources = {"memory": "4G", "cpu": "2"}
# TrainerId | The identifier of the trainer to use for this configuration.
trainer_id = "autogluon"
trainer_id = "ri.models..trainer.autogluon_tabular_regression"
# ModelStudioWorkerConfig | The worker configuration including inputs, outputs, and custom settings.
worker_config = None
worker_config = {
"outputs": {
"model": {
"type": "model",
"modelRid": "ri.models.main.model.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
}
},
"inputs": {
"input_df": {
"type": "dataset",
"rid": "ri.foundry.main.dataset.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"columnMapping": {"target_column": ["target"]},
"ignoreColumns": [],
"selectColumns": [],
}
},
}
# Optional[str] | Changelog describing changes in this version.
changelog = None
# Optional[PreviewMode] | Enables the use of preview functionality.
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/Models/ModelStudioRun.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**list**](#list) | **GET** /v2/models/modelStudios/{modelStudioRid}/runs | Private Beta |
[**list**](#list) | **GET** /v2/models/modelStudios/{modelStudioRid}/runs | Public Beta |

# **list**
Lists all runs for a Model Studio.
Expand Down
4 changes: 2 additions & 2 deletions docs/v2/Models/ModelStudioTrainer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**get**](#get) | **GET** /v2/models/modelStudioTrainers/{modelStudioTrainerTrainerId} | Private Beta |
[**list**](#list) | **GET** /v2/models/modelStudioTrainers | Private Beta |
[**get**](#get) | **GET** /v2/models/modelStudioTrainers/{modelStudioTrainerTrainerId} | Public Beta |
[**list**](#list) | **GET** /v2/models/modelStudioTrainers | Public Beta |

# **get**
Gets details about a specific trainer by its ID and optional version.
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/Models/models/DatasetInput.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Dataset input configuration.
## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**rid** | RID | Yes | The RID of the input dataset. |
**rid** | DatasetRid | Yes | The RID of the input dataset. |
**column_mapping** | Dict[ColumnTypeSpecId, List[ColumnName]] | Yes | Mapping of column type spec IDs to column names. |
**ignore_columns** | List[ColumnName] | Yes | Columns to ignore from the dataset. |
**select_columns** | List[ColumnName] | Yes | Columns to select from the dataset. If empty, all columns not in ignoreColumns will be used. |
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/Models/models/DatasetSchemaNotFoundError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A schema could not be found for the specified dataset.
## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**dataset_rid** | RID | Yes | The RID of the dataset whose schema was not found. |
**dataset_rid** | DatasetRid | Yes | The RID of the dataset whose schema was not found. |
**type** | Literal["datasetSchemaNotFound"] | Yes | None |


Expand Down
Loading