acryl-datahub-cloud 0.3.10rc4__py3-none-any.whl → 0.3.16.1rc0__py3-none-any.whl

acryl_datahub_cloud/metadata/schemas/DataHubAiConversationInfo.avsc

@@ -0,0 +1,256 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubAiConversationInfo"
+  },
+  "name": "DataHubAiConversationInfo",
+  "namespace": "com.linkedin.pegasus2avro.conversation",
+  "fields": [
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "title",
+      "default": null,
+      "doc": "Optional title for the conversation. "
+    },
+    {
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "DataHubAiConversationMessage",
+          "namespace": "com.linkedin.pegasus2avro.conversation",
+          "fields": [
+            {
+              "type": {
+                "type": "enum",
+                "name": "DataHubAiConversationMessageType",
+                "namespace": "com.linkedin.pegasus2avro.conversation",
+                "symbols": [
+                  "TEXT",
+                  "TOOL_CALL",
+                  "TOOL_RESULT",
+                  "THINKING"
+                ]
+              },
+              "name": "type",
+              "doc": "The type of message"
+            },
+            {
+              "type": "long",
+              "name": "time",
+              "doc": "Timestamp in milliseconds"
+            },
+            {
+              "type": {
+                "type": "record",
+                "name": "DataHubAiConversationActor",
+                "namespace": "com.linkedin.pegasus2avro.conversation",
+                "fields": [
+                  {
+                    "type": {
+                      "type": "enum",
+                      "symbolDocs": {
+                        "AGENT": "An agent initiated message. ",
+                        "USER": "A user initiated message. "
+                      },
+                      "name": "DataHubAiConversationActorType",
+                      "namespace": "com.linkedin.pegasus2avro.conversation",
+                      "symbols": [
+                        "USER",
+                        "AGENT"
+                      ]
+                    },
+                    "name": "type",
+                    "doc": "The type of actor "
+                  },
+                  {
+                    "Relationship": {
+                      "entityTypes": [
+                        "corpuser",
+                        "corpGroup"
+                      ],
+                      "name": "AuthoredBy"
+                    },
+                    "java": {
+                      "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                    },
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "name": "actor",
+                    "default": null,
+                    "doc": "The actor that has sent the message.\nRequired if type is not AGENT.",
+                    "Urn": "Urn",
+                    "entityTypes": [
+                      "corpuser",
+                      "corpGroup"
+                    ]
+                  }
+                ]
+              },
+              "name": "actor",
+              "doc": "Messages in the conversation"
+            },
+            {
+              "type": {
+                "type": "record",
+                "name": "DataHubAiConversationMessageContent",
+                "namespace": "com.linkedin.pegasus2avro.conversation",
+                "fields": [
+                  {
+                    "type": "string",
+                    "name": "text",
+                    "doc": "Raw message text"
+                  }
+                ],
+                "doc": "Conversation message content info "
+              },
+              "name": "content",
+              "doc": "The contents of the message."
+            },
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "agentName",
+              "default": null,
+              "doc": "The name of the agent that generated this message (if applicable)."
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "DataHubAiConversationContext",
+                  "namespace": "com.linkedin.pegasus2avro.conversation",
+                  "fields": [
+                    {
+                      "type": "string",
+                      "name": "text",
+                      "doc": "Natural language context description for the AI agent.\nThis will be included in the system prompt to help the agent\nunderstand what the user is looking at and working on.\nExample use cases: troubleshooting execution runs, configuring ingestion sources."
+                    },
+                    {
+                      "type": [
+                        "null",
+                        {
+                          "type": "array",
+                          "items": "string"
+                        }
+                      ],
+                      "name": "entityUrns",
+                      "default": null,
+                      "doc": "Optional URNs of the entities this conversation is about.\nUseful for linking conversations to specific entities such as execution runs or datasets.",
+                      "Urn": "Urn",
+                      "urn_is_array": true
+                    }
+                  ],
+                  "doc": "Context about where and how a conversation is being used.\nThis helps the AI agent understand what the user is looking at and working on."
+                }
+              ],
+              "name": "context",
+              "default": null,
+              "doc": "Optional context about where and how this message is being sent.\nWhen provided, this context is combined with the conversation-level context\nto give the AI agent the most up-to-date information about what the user is working on.\nThis allows for dynamic context that changes as the user navigates through different screens or steps."
+            }
+          ],
+          "doc": "Conversation info "
+        }
+      },
+      "name": "messages",
+      "doc": "Messages in the conversation"
+    },
+    {
+      "Searchable": {
+        "/actor": {
+          "fieldName": "creator",
+          "fieldType": "URN"
+        },
+        "/time": {
+          "fieldName": "createdAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": {
+        "type": "record",
+        "name": "AuditStamp",
+        "namespace": "com.linkedin.pegasus2avro.common",
+        "fields": [
+          {
+            "type": "long",
+            "name": "time",
+            "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+            },
+            "type": "string",
+            "name": "actor",
+            "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.",
+            "Urn": "Urn"
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+            },
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "impersonator",
+            "default": null,
+            "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor.",
+            "Urn": "Urn"
+          },
+          {
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "message",
+            "default": null,
+            "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."
+          }
+        ],
+        "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."
+      },
+      "name": "created",
+      "doc": "The time and actor who initiated the conversation"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "DATAHUB_UI": "Chat session originated in DataHub UI",
+          "INGESTION_UI": "Chat session originated in Ingestion UI"
+        },
+        "name": "DataHubAiConversationOriginType",
+        "namespace": "com.linkedin.pegasus2avro.conversation",
+        "symbols": [
+          "DATAHUB_UI",
+          "INGESTION_UI"
+        ]
+      },
+      "name": "originType",
+      "default": "DATAHUB_UI",
+      "doc": "Origin type for the chat session"
+    },
+    {
+      "type": [
+        "null",
+        "com.linkedin.pegasus2avro.conversation.DataHubAiConversationContext"
+      ],
+      "name": "context",
+      "default": null,
+      "doc": "Optional context about where and how this conversation is being used.\nProvides natural language context to help the AI agent understand\nwhat the user is looking at and working on."
+    }
+  ],
+  "doc": "Conversation info "
+}

acryl_datahub_cloud/metadata/schemas/DataHubAiConversationKey.avsc

@@ -0,0 +1,22 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubAiConversationKey",
+    "keyForEntity": "dataHubAiConversation",
+    "entityCategory": "core",
+    "entityAspects": [
+      "dataHubAiConversationInfo"
+    ]
+  },
+  "name": "DataHubAiConversationKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "Searchable": {},
+      "type": "string",
+      "name": "id",
+      "doc": "Unique identifier for the conversation"
+    }
+  ],
+  "doc": "Key for a DataHub conversation"
+}

acryl_datahub_cloud/metadata/schemas/DataHubFileInfo.avsc

@@ -0,0 +1,234 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubFileInfo"
+  },
+  "name": "DataHubFileInfo",
+  "namespace": "com.linkedin.pegasus2avro.file",
+  "fields": [
+    {
+      "type": {
+        "type": "record",
+        "name": "BucketStorageLocation",
+        "namespace": "com.linkedin.pegasus2avro.file",
+        "fields": [
+          {
+            "Searchable": {
+              "fieldType": "KEYWORD"
+            },
+            "type": "string",
+            "name": "storageBucket",
+            "doc": "The storage bucket this file is stored in"
+          },
+          {
+            "Searchable": {
+              "fieldType": "KEYWORD"
+            },
+            "type": "string",
+            "name": "storageKey",
+            "doc": "The key for where this file is stored inside of the given bucket"
+          }
+        ],
+        "doc": "Information where a file is stored"
+      },
+      "name": "bucketStorageLocation",
+      "doc": "Info about where a file is stored"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "originalFileName",
+      "doc": "The original filename as uploaded by the user"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": "string",
+      "name": "mimeType",
+      "doc": "MIME type of the file (e.g., image/png, application/pdf)"
+    },
+    {
+      "type": "long",
+      "name": "sizeInBytes",
+      "doc": "Size of the file in bytes"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "ASSET_DOCUMENTATION": "File uploaded for entity documentation",
+          "ASSET_DOCUMENTATION_LINKS": "Upload for asset documentation links."
+        },
+        "name": "FileUploadScenario",
+        "namespace": "com.linkedin.pegasus2avro.file",
+        "symbols": [
+          "ASSET_DOCUMENTATION",
+          "ASSET_DOCUMENTATION_LINKS"
+        ]
+      },
+      "name": "scenario",
+      "doc": "The scenario/context in which this file was uploaded"
+    },
+    {
+      "Relationship": {
+        "entityTypes": [
+          "dataset",
+          "chart",
+          "container",
+          "dashboard",
+          "dataFlow",
+          "dataJob",
+          "glossaryTerm",
+          "glossaryNode",
+          "mlModel",
+          "mlFeature",
+          "notebook",
+          "mlFeatureTable",
+          "mlPrimaryKey",
+          "mlModelGroup",
+          "domain",
+          "dataProduct",
+          "businessAttribute",
+          "document"
+        ],
+        "name": "ReferencedBy"
+      },
+      "Searchable": {
+        "fieldType": "URN"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "referencedByAsset",
+      "default": null,
+      "doc": "Optional URN of the entity this file is associated with (e.g., the dataset whose docs contain this file)",
+      "Urn": "Urn",
+      "entityTypes": [
+        "dataset",
+        "chart",
+        "container",
+        "dashboard",
+        "dataFlow",
+        "dataJob",
+        "glossaryTerm",
+        "glossaryNode",
+        "mlModel",
+        "mlFeature",
+        "notebook",
+        "mlFeatureTable",
+        "mlPrimaryKey",
+        "mlModelGroup",
+        "domain",
+        "dataProduct",
+        "businessAttribute",
+        "document"
+      ]
+    },
+    {
+      "Relationship": {
+        "entityTypes": [
+          "schemaField"
+        ],
+        "name": "ReferencedBy"
+      },
+      "Searchable": {
+        "fieldType": "URN"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "schemaField",
+      "default": null,
+      "doc": "The dataset schema field urn this file is referenced by",
+      "Urn": "Urn",
+      "entityTypes": [
+        "schemaField"
+      ]
+    },
+    {
+      "Searchable": {
+        "/actor": {
+          "fieldName": "createdBy",
+          "fieldType": "URN"
+        },
+        "/time": {
+          "fieldName": "createdAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": {
+        "type": "record",
+        "name": "AuditStamp",
+        "namespace": "com.linkedin.pegasus2avro.common",
+        "fields": [
+          {
+            "type": "long",
+            "name": "time",
+            "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+            },
+            "type": "string",
+            "name": "actor",
+            "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.",
+            "Urn": "Urn"
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+            },
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "impersonator",
+            "default": null,
+            "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor.",
+            "Urn": "Urn"
+          },
+          {
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "message",
+            "default": null,
+            "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."
+          }
+        ],
+        "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."
+      },
+      "name": "created",
+      "doc": "Timestamp when this file was created and by whom"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "contentHash",
+      "default": null,
+      "doc": "SHA-256 hash of file contents"
+    }
+  ],
+  "doc": "Information about a DataHub file - a file stored in S3 for use within DataHub platform features like documentation, home pages, and announcements."
+}

acryl_datahub_cloud/metadata/schemas/DataHubFileKey.avsc

@@ -0,0 +1,22 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubFileKey",
+    "keyForEntity": "dataHubFile",
+    "entityCategory": "core",
+    "entityAspects": [
+      "dataHubFileInfo",
+      "status"
+    ]
+  },
+  "name": "DataHubFileKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "Unique id for the file."
+    }
+  ],
+  "doc": "Key for a DataHubFile"
+}

acryl_datahub_cloud/metadata/schemas/DataHubIngestionSourceKey.avsc

@@ -5,7 +5,8 @@
     "keyForEntity": "dataHubIngestionSource",
     "entityCategory": "internal",
     "entityAspects": [
-      "dataHubIngestionSourceInfo"
+      "dataHubIngestionSourceInfo",
+      "ownership"
     ]
   },
   "name": "DataHubIngestionSourceKey",

acryl_datahub_cloud/metadata/schemas/DataHubOpenAPISchemaKey.avsc

@@ -0,0 +1,22 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubOpenAPISchemaKey",
+    "keyForEntity": "dataHubOpenAPISchema",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "systemMetadata"
+    ],
+    "entityDoc": "Contains aspects which are used in OpenAPI requests/responses which are not otherwise present in the data model."
+  },
+  "name": "DataHubOpenAPISchemaKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the DataHub OpenAPI schema."
+    }
+  ],
+  "doc": "Key for a Query"
+}

acryl_datahub_cloud/metadata/schemas/DataHubPageModuleKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPageModuleKey",
+    "keyForEntity": "dataHubPageModule",
+    "entityCategory": "core",
+    "entityAspects": [
+      "dataHubPageModuleProperties"
+    ]
+  },
+  "name": "DataHubPageModuleKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "Unique id for the module."
+    }
+  ],
+  "doc": "Key for a DataHubPageModule"
+}