UnstructuredDataProfileResult

Contains the result of an unstructured data profile scan.

JSON representation 
{
  "partialFailureMessage": string,
  "graphProfile": {
    object (GraphProfile)
  },
  "description": string
}
Fields
partialFailureMessage

string

Output only. Optional message for partial failures (e.g. node type extraction failed).
graphProfile

object (GraphProfile)

Output only. The inferred graph profile.
description

string

Output only. The inferred description.

GraphProfile

Contains the strict structure for graph-profile for semantic inference scan result.

JSON representation 
{
  "nodeTypes": [
    {
      object (NodeType)
    }
  ],
  "edgeTypes": [
    {
      object (EdgeType)
    }
  ]
}
Fields
nodeTypes[]

object (NodeType)

Output only. Node types.
edgeTypes[]

object (EdgeType)

Output only. Edge types.

NodeType

Represents a type of node in the graph.

JSON representation 
{
  "name": string,
  "fields": [
    {
      object (Field)
    }
  ],
  "extractionHints": {
    object (ExtractionHints)
  },
  "description": string,
  "primaryKeys": [
    string
  ]
}
Fields
name

string

Output only. Name of the node type.
fields[]

object (Field)

Output only. Fields of the node type.
extractionHints

object (ExtractionHints)

Output only. Extraction hints for the node.
description

string

Output only. Description of the node type.
primaryKeys[]

string

Output only. Field names forming the primary keys. The order in this array defines the key's ordinal positions for composite keys.

Field

Represents a field in a node or edge type.

JSON representation 
{
  "name": string,
  "description": string,
  "dataType": string,
  "metadataType": enum (MetadataType),
  "mode": enum (Mode),
  "extractionHints": {
    object (ExtractionHints)
  },
  "fields": [
    {
      object (Field)
    }
  ]
}
Fields
name

string

Output only. Name of the field.
description

string

Output only. Description of the field.
dataType

string

Output only. The data type of the field, e.g., STRING, INTEGER, DATE.
metadataType

enum (MetadataType)

Output only. The mapped metadata type.
mode

enum (Mode)

Output only. The mode of the field.
extractionHints

object (ExtractionHints)

Output only. Extraction hints for the field.
fields[]

object (Field)

Output only. Sub-fields of this field (for STRUCT types).

MetadataType

MetadataType of the field.

Enums
METADATA_TYPE_UNSPECIFIED Unspecified metadata type.
BOOLEAN Boolean type.
NUMBER Numeric type.
STRING String type.
BYTES Bytes type.
DATETIME Date and time type.
TIMESTAMP Timestamp type.
GEOSPATIAL Geospatial type.
STRUCT Struct (record) type.
OTHER Other types not covered above.

Mode

The mode of the field.

Enums
MODE_UNSPECIFIED Unspecified mode.
NULLABLE Field can be null.
REPEATED Field can be repeated.
REQUIRED Field is required.

ExtractionHints

Extraction hints (field-level).

JSON representation 
{
  "normalization": string,
  "synthesis": string
}
Fields
normalization

string

Output only. Standardizes extracted data (e.g., to ISO 3166-1 alpha-2).
synthesis

string

Output only. Generates value from other data instead of direct extraction (e.g., hashing).

ExtractionHints

Extraction hints (node-level).

JSON representation 
{
  "cardinality": string
}
Fields
cardinality

string

Output only. Expected occurrence frequency of this node type within a document. Format: "[Bounds] - [Description]" Example: "0:N - A document may contain multiple people names."

EdgeType

Represents a type of edge (relationship) in the graph.

JSON representation 
{
  "name": string,
  "sourceNodeType": string,
  "targetNodeType": string,
  "fields": [
    {
      object (Field)
    }
  ],
  "extractionHints": {
    object (ExtractionHints)
  },
  "description": string,
  "foreignKeys": [
    {
      object (ForeignKey)
    }
  ]
}
Fields
name

string

Output only. Name of the edge type.
sourceNodeType

string

Output only. Source node type.
targetNodeType

string

Output only. Target node type.
fields[]

object (Field)

Output only. Fields of the edge type.
extractionHints

object (ExtractionHints)

Output only. Extraction hints for the edge.
description

string

Output only. Description of the edge type.
foreignKeys[]

object (ForeignKey)

Output only. Defines the Foreign Key constraints for the edge.

ExtractionHints

Extraction hints (edge-level).

JSON representation 
{
  "cardinality": string
}
Fields
cardinality

string

Output only. Expected connectivity topology and bounds of this relationship. Format: "[Topology] - [Description]" Example: "1:N - One company can have multiple financial reports."

ForeignKey

Represents a foreign key constraint.

JSON representation 
{
  "name": string,
  "description": string,
  "referencedNodeType": string,
  "fieldMappings": [
    {
      object (FieldMapping)
    }
  ]
}
Fields
name

string

Output only. Name of the foreign key constraint.
description

string

Output only. Description of the foreign key.
referencedNodeType

string

Output only. The node type this constraint references.
fieldMappings[]

object (FieldMapping)

Output only. Field Mappings. Mappings between local fields and the fields they reference in the referenced node type.

FieldMapping

Maps a local field to a referenced field.

JSON representation 
{
  "field": string,
  "referencedField": string
}
Fields
field

string

Output only. Local field name forming part of the foreign key.
referencedField

string

Output only. Field name in the referenced node type.