Required. The dataset schema resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema It takes the form projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema.
Query parameters
Parameters
visibleFieldsOnly
boolean
If set, only returns the visible fields of the schema.
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of DatasetSchema.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-10 UTC."],[[["\u003cp\u003eThis endpoint retrieves the \u003ccode\u003eDatasetSchema\u003c/code\u003e of a \u003ccode\u003eDataset\u003c/code\u003e using a GET request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003ename\u003c/code\u003e parameter in the path, specifying the dataset schema resource location.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint can optionally filter for visible fields only using the \u003ccode\u003evisibleFieldsOnly\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe successful response contains an instance of \u003ccode\u003eDatasetSchema\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAccessing this endpoint requires the \u003ccode\u003edocumentai.datasetSchemas.get\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: dataset.getDatasetSchema\n\n**Full name**: projects.locations.processors.dataset.getDatasetSchema\n\nGets the `DatasetSchema` of a `Dataset`.\n\n### HTTP request\n\n`GET https://{endpoint}/v1beta3/{name}`\n\nWhere `{endpoint}` is one of the [supported service endpoints](/document-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [DatasetSchema](/document-ai/docs/reference/rest/v1beta3/DatasetSchema).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `documentai.datasetSchemas.get`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
