get_dataset_file_summaries¶

DatasetsApi.get_dataset_file_summaries(id, role_id, file_name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get AI-generated summary for a dataset file

Returns SummaryGenerationStatus and SummaryMetadata for a single dataset file. Required query file-name (else IPV-1020). File must exist in the dataset files table (else IPV-1002). Datasets AI service must be enabled (else AI-1004). Safe to retry (read-only).

Parameters:

id (str) – Dataset ID that owns the file. (required)
role_id (str) – Amorphic role ID the request is authorized against. Must grant access to the dataset. (required)
file_name (str) – Exact FileName key of the dataset file whose summary to return. Missing returns IPV-1020; unknown file returns IPV-1002. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

GetSummaryResponse

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /datasets/{id}/files/summarize

Parameter examples¶

Name	In	Example
`id`	path	`"b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f"`
`file-name`	query	`"sales/monthly_orders/upload_date=2026-08-01/notes.txt"`

Success (HTTP 200)¶

Summary status and metadata returned (GetSummaryResponse). SummaryGenerationStatus may be pending, summarizing, completed, etc. SummaryMetadata includes Summary and ApprovalStatus when generated.

Request / response example

{
  "SummaryGenerationStatus": "completed",
  "SummaryMetadata": {
    "Summary": "Monthly orders file covering August 2026 sales.",
    "ApprovalStatus": "PENDING"
  }
}

Errors¶

Documented error codes: IPV-1020, IPV-1002, AI-1004.

HTTP 400

Validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: IPV-1020 (missing file-name), IPV-1002 (unknown file), AI-1004, AUTH-*.

Missing file-name query param

{
  "Message": "IPV-1020 - Input key 'file-name' is missing."
}

File not in dataset

{
  "Message": "IPV-1002 - FileName sales/.../notes.txt does not exist"
}

HTTP 500

Something went wrong at backend. Input, permission and file-state errors - such as an unsupported file type, a file that is already processed, or a dataset you cannot access - are also reported here.

file-name empty once past gateway validation

{
  "Message": "IPV-1020 - Input key 'file-name' is missing."
}

Datasets AI service is switched off

{
  "Message": "AI-1004 - AI services for feature: Datasets are not currently enabled in the application. Please contact the administrator to enable it."
}