@yottagraph-app/elemental-api-skill 1.0.0

package/skill/relationships.md

@@ -0,0 +1,308 @@
+# Relationships
+
+Relationships (also called "links") represent connections between entities in the Knowledge Graph. These connections are derived from articles.
+
+## When to Use
+
+- You want to find entities connected to a given entity
+- You need to understand how two entities are related
+- You're exploring a network of connections (e.g., "Who is connected to this person?")
+- You need link counts or relationship strength between entities
+
+## Key Concepts
+
+- **Linked Entities**: Other entities that have a relationship with a given entity
+- **Link Strength**: Represents the significance of the relationship between two entities
+- **Link Counts**: Number of connections between entity pairs, useful for measuring relationship strength
+- **Relationship Types**: Common types include:
+  - `competes_with`
+  - `compares_to`
+  - `customer_of`
+  - `partnered_with`
+  - `trades_with`
+  - `invests_in`
+  - `is_related_to`
+  - `sues`
+  - `provides_support_to`
+
+## Tips
+
+- Relationships are bidirectional—if A links to B, B links to A
+- High link counts indicate stronger or more frequent connections in the news
+- Use with graph endpoints to visualize relationship networks
+
+<!-- BEGIN GENERATED CONTENT -->
+
+## Endpoints
+
+### Get linked entities
+
+`GET /entities/{source_neid}/linked`
+
+Get list of entities linked to a source entity, optionally filtered by entity type and link type
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| source_neid | string | yes | Source entity NEID |
+| entity_type | string[] | no | Filter by entity type(s) |
+| link_type | string[] | no | Filter by link type(s) |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | List of linked entity NEIDs (`GetLinkedEntitiesResponse`) |
+| 400 | Invalid parameters (`Error`) |
+| 404 | Source entity not found (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /entities/00416400910670863867/linked
+```
+
+**Response:**
+
+```json
+{"entities": ["00416400910670863867"]}
+```
+
+---
+
+### Get links between entities
+
+`GET /entities/{source_neid}/links/{target_neid}`
+
+Get list of links between source and target entities, optionally filtered by link type
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| source_neid | string | yes | Source entity NEID |
+| target_neid | string | yes | Target entity NEID |
+| link_type | string[] | no | Filter by link type(s) |
+| include_mentions | boolean | no | Include mention details in response |
+| include_articles | boolean | no | Include article details in response |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | List of entity links (`GetLinksResponse`) |
+| 400 | Invalid parameters (`Error`) |
+| 404 | Source or target entity not found (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /entities/00416400910670863867/links/04358848009837283240
+```
+
+**Response:**
+
+```json
+{"links": []}
+```
+
+---
+
+### Get graph layout
+
+`GET /graph/{center_neid}/layout`
+
+Get nodes and edges layout data for visualizing a relationship graph. Response is cached for 5 minutes.
+
+#### Guidance
+
+Only use this endpoint if you care about graph-specific properties. Otherwise it is faster to use /entities/{source_neid}/links/{target_neid}. This should always be called with a non-empty list of neids. A typical pattern is to call /graph/{center_neid}/neighborhood and then use the returned NEIDs to call this endpoint.
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| center_neid | string | yes | Center entity NEID |
+| neid | string[] | no | Additional entity NEIDs to include in layout |
+| borderMinX | number | no | Minimum X border for layout |
+| borderMinY | number | no | Minimum Y border for layout |
+| borderMaxX | number | no | Maximum X border for layout |
+| borderMaxY | number | no | Maximum Y border for layout |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Graph layout with nodes and edges (`GraphLayoutResponse`) |
+| 400 | Invalid parameters (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /graph/00416400910670863867/layout?neid=04358848009837283240
+```
+
+**Response:**
+
+```json
+{"nodes": [{"neid": "00416400910670863867", "label": "organization|Apple|nationality: us...", "isCentralNode": true, "x": -333.33, "y": -200, "width": 666.67, "height": 266.67}], "edges": [{"source": "00416400910670863867", "target": "04358848009837283240", "label": "competes_with", "path": [{"X": 0, "Y": 0}, {"X": 0, "Y": 66.67}], "article_ids": ["02861951941133789623"], "snippets": ["Apple and Google are mentioned as companies..."], "weight": 0.0267}]}
+```
+
+---
+
+### Get graph neighborhood
+
+`GET /graph/{center_neid}/neighborhood`
+
+Get list of neighboring entities in the relationship graph, optionally filtered by entity type. Response is cached for 5 minutes.
+
+#### Guidance
+
+Only use this endpoint if you care about graph-specific properties. Otherwise it is faster to use /entities/{source_neid}/linked. Response includes the center entity itself in the results with a weight of 1.0. The 'neighbors' and 'weights' arrays are parallel (same indices correspond).
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| center_neid | string | yes | Center entity NEID |
+| size | integer | no | Maximum number of neighbors to return |
+| type | string[] | no | Filter by entity type(s) |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Neighbors and their weights (`GraphNeighborhoodResponse`) |
+| 400 | Invalid parameters (`Error`) |
+| 404 | Center entity not found (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /graph/00416400910670863867/neighborhood?size=5
+```
+
+**Response:**
+
+```json
+{"neighbors": ["00416400910670863867", "04358848009837283240", "00315863961550087877"], "weights": [1, 0.0267, 0.0167]}
+```
+
+---
+
+### Get link counts between entities
+
+`GET /graph/{source_neid}/links/{target_neid}/counts`
+
+Get counts of links between source and target entities over time
+
+#### Guidance
+
+Only use this endpoint if you care about graph-specific properties. Otherwise it is faster to use /entities/{source_neid}/links/{target_neid}. Returns link_counts object with relationship types as keys. Values are arrays of timestamps in Excel/OLE serial date format (days since 1899-12-30). Example: 46019.64453125 = 2025-12-28 15:28:07 UTC. The count for each relationship type is the array length (number of observations).
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| source_neid | string | yes | Source entity NEID |
+| target_neid | string | yes | Target entity NEID |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Link counts by type (`GetLinkCountsResponse`) |
+| 400 | Invalid parameters (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /graph/00416400910670863867/links/04358848009837283240/counts
+```
+
+**Response:**
+
+```json
+{"link_counts": {"compares_to": [46019.64453125, 45999.3515625], "competes_with": [45847.5625, 45850.60546875], "customer_of": [45836.9296875], "partnered_with": [], "trades_with": []}}
+```
+
+## Types
+
+### EntityLink
+
+A link between two entities
+
+| Field | Type | Description |
+|-------|------|-------------|
+| article_ids | string[] | Article IDs where this link was found |
+| recorded_at | string | Time when the link was recorded @Format date-time |
+| source | string | Source entity NEID |
+| target | string | Target entity NEID |
+| type | string | Type of link/relationship |
+
+### GetLinkCountsResponse
+
+Response containing link counts between entities
+
+| Field | Type | Description |
+|-------|------|-------------|
+| link_counts | object | Map of link type to count values |
+
+### GetLinkedEntitiesResponse
+
+Response containing linked entities
+
+| Field | Type | Description |
+|-------|------|-------------|
+| entities | string[] | List of linked entity NEIDs |
+
+### GetLinksResponse
+
+Response containing links between entities
+
+| Field | Type | Description |
+|-------|------|-------------|
+| articles | `ArticleDetail`[] | Articles tied to the returned links (only included when requested) |
+| links | `EntityLink`[] | List of entity links |
+| mentions | `MentionDetail`[] | Mentions tied to the returned links (only included when requested) |
+
+### GraphNeighborhoodResponse
+
+Response containing neighbors of an entity in the relationship graph
+
+| Field | Type | Description |
+|-------|------|-------------|
+| neighbors | string[] | List of neighbor NEIDs |
+| weights | number[] | Weights corresponding to each neighbor (same order as neighbors) |
+
+### LinkedExpression
+
+| Field | Type | Description |
+|-------|------|-------------|
+| **linked** | `Linked` |  |
+
+### Linked
+
+| Field | Type | Description |
+|-------|------|-------------|
+| **distance** | integer | Maximum relationship distance to traverse |
+| pids | integer[] | Property identifiers defining the relationship types to follow |
+| to_entity | string | Target entity ID for relationship traversal |
+
+<!-- END GENERATED CONTENT -->

package/skill/schema.md

@@ -0,0 +1,351 @@
+# Schema
+
+The schema defines the data model: what **entity types** (flavors) exist and what **properties** they can have. Understanding the schema is essential for constructing queries and interpreting results.
+
+## When to Use
+
+- You need to discover available entity types (flavors) and their IDs (FIDs)
+- You need to discover available properties and their IDs (PIDs)
+- You need human-readable names, units, or domain information for properties
+- You're exploring the data model before constructing a search expression
+
+## Key Concepts
+
+- **Flavors** = Entity types. Each entity belongs to exactly one flavor.
+  - Examples: "ship" (FID 1), "organization" (FID 10), "person" (FID 9)
+  - Identified by a Flavor ID (FID) — a small integer
+- **Properties** = Attributes that entities can have. Each property has:
+  - A Property ID (PID) — a small integer
+  - A name (e.g., "name", "length", "mailing_address", "acquires")
+  - A data type (e.g., "data_cat" for text, "data_float" for numbers)
+  - Domain flavors — which entity types can have this property
+
+## Choosing a Schema Endpoint
+
+There are two schema endpoints with different levels of detail:
+
+| Endpoint | Flavors include | Properties include |
+|----------|-----------------|-------------------|
+| `GET /schema` | findex, name, singular/plural display names | pid, name, display_name, unit, value_type, domain_findexes, target_findexes |
+| `GET /elemental/metadata/schema` | fid, name only | pid, name, type only |
+
+**Use `/schema`** (recommended) when you need:
+- Human-readable display names (e.g., "Ship" vs "ship")
+- Units of measurement (e.g., "m", "kg", "knots")
+- Which flavors a property applies to (`domain_findexes`)
+
+**Use `/elemental/metadata/schema`** when you just need basic FID/PID to name mappings.
+
+## Tips
+
+- Many API responses return only FIDs and PIDs (not names) — use the schema to translate these to human-readable names
+- Cache schema results; the data model changes infrequently
+- Use `/elemental/metadata/properties/{pid}/summary` to understand value distributions before filtering
+
+## Common Workflow
+
+1. **Get the schema** → `GET /schema` to learn available flavors and properties
+2. **Find entities of a type** → `POST /elemental/find` with `is_type` expression
+3. **Get property values** → `POST /elemental/entities/properties` to fetch values for those entities
+
+<!-- BEGIN GENERATED CONTENT -->
+
+## Endpoints
+
+### Get detailed schema information
+
+`GET /schema`
+
+Returns detailed schema information including entity types (flavors) with display names and properties with display names, units, and domain/target relationships. This endpoint provides more detail than /elemental/metadata/schema.
+
+#### Guidance
+
+This endpoint returns richer metadata than /elemental/metadata/schema, including display names, units, and relationship domains. Use this when you need human-readable names or property metadata.
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Schema information (`SchemaResponse`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /schema
+```
+
+**Response:**
+
+```json
+{"flavors": [{"findex": 1, "name": "ship", "singular_display_name": "Ship", "plural_display_name": "Ships"}, {"findex": 10, "name": "organization", "singular_display_name": "Organization", "plural_display_name": "Organizations"}], "properties": [{"pid": 8, "name": "name", "display_name": "Name", "value_type": "data_cat"}, {"pid": 22, "name": "length", "display_name": "Length", "unit": "m", "value_type": "data_float"}]}
+```
+
+---
+
+### Find entities by expression
+
+`POST /elemental/find`
+
+Search for entities using a powerful expression language. The expression parameter supports complex nested queries with logical operators, geographic constraints, property comparisons, and more.
+
+#### Guidance
+
+CRITICAL: This endpoint REQUIRES Content-Type: application/x-www-form-urlencoded. Sending a JSON body will fail with 400 error. The expression parameter must be URL-encoded form data, not a JSON request body. For the full expression language reference including all expression types, comparison operators, and examples, see find.md.
+
+#### Request Body
+
+**Content-Type:** `application/x-www-form-urlencoded`
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| expression | string | yes | JSON-encoded expression object defining the search criteria |
+| deadline | any | no | Response deadline in milliseconds or duration format |
+| limit | integer | no | Maximum number of entity IDs to return in first response |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Find operation successful (`FindResponse`) |
+| 400 | Bad request - invalid parameters or malformed expression (`Error`) |
+| 500 | Internal server error (`Error`) |
+| 501 | Elemental API capability not enabled (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+POST /elemental/find
+Content-Type: application/x-www-form-urlencoded
+
+expression={"type":"is_type","is_type":{"fid":10}}&limit=5
+```
+
+**Response:**
+
+```json
+{"op_id": "98cc54e9-0108-4361-9c96-18ea97cda7a2", "follow_up": true, "eids": ["01601807036815568643", "08115040994665529432", "02045070050429461063"]}
+```
+
+---
+
+### Get property values for entities
+
+`POST /elemental/entities/properties`
+
+Retrieves property values for specified entities. Returns the current values of requested properties for each entity.
+
+#### Guidance
+
+Pass entity IDs as a JSON array in the 'eids' form field (eids and neids are interchangeable terms for entity IDs). Optionally filter to specific properties via 'pids'. If pids is omitted, returns all available properties. Set include_attributes=true to get additional metadata about each property value.
+
+#### Request Body
+
+**Content-Type:** `application/x-www-form-urlencoded`
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| eids | string | yes | JSON array of entity IDs to get properties for |
+| pids | string | no | JSON array of property IDs to retrieve (optional, omit for all properties) |
+| include_attributes | string | no | Include property attributes in response (true/false) |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Property values retrieved successfully (`GetPropertyValuesResponse`) |
+| 400 | Bad request - invalid parameters or malformed expression (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+POST /elemental/entities/properties
+Content-Type: application/x-www-form-urlencoded
+
+eids=["00416400910670863867"]&pids=[8]
+```
+
+**Response:**
+
+```json
+{"op_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "follow_up": false, "values": [{"eid": "00416400910670863867", "pid": 8, "value": "Apple", "recorded_at": "2026-01-15T10:30:00Z"}]}
+```
+
+---
+
+### Get complete schema information
+
+`GET /elemental/metadata/schema`
+
+Returns comprehensive schema information including all entity types (flavors), properties, and their attributes. This endpoint provides the complete data model available in the system.
+
+#### Guidance
+
+Response is wrapped in a 'schema' container object. Access flavors and properties via response.schema.flavors and response.schema.properties. Flavors contain: fid (unique identifier), name (e.g., 'ship', 'aircraft'). Properties contain: pid (unique identifier), name (e.g., 'latitude', 'name'), type (e.g., 'data_float', 'data_int', 'data_cat', 'data_nindex').
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Schema information retrieved successfully (`GetSchemaResponse`) |
+| 500 | Internal server error (`Error`) |
+| 501 | Elemental API capability not enabled (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /elemental/metadata/schema
+```
+
+**Response:**
+
+```json
+{"op_id": "40dc4cd9-f1b2-4b5c-85d0-c7c61256e5d9", "follow_up": false, "schema": {"flavors": [{"fid": 1, "name": "ship"}, {"fid": 2, "name": "handset"}, {"fid": 10, "name": "organization"}], "properties": [{"pid": 1, "name": "mmsi", "type": "data_cat"}, {"pid": 8, "name": "name", "type": "data_cat"}]}}
+```
+
+---
+
+### Get property value summary
+
+`GET /elemental/metadata/properties/{pid}/summary`
+
+Returns summary statistics for a specific property including value distribution, ranges for numeric properties, and unique values for categorical properties.
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| pid | integer | yes | Property ID to summarize |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Property summary retrieved successfully (`SummarizePropertyResponse`) |
+| 400 | Bad request - invalid parameters or malformed expression (`Error`) |
+| 401 | Authentication required or authentication failed (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /elemental/metadata/properties/8/summary
+```
+
+**Response:**
+
+```json
+{"op_id": "a337cd9c-6483-4472-a30b-e875ba7f2b21", "follow_up": false, "pid": 8, "value_type": "categorical"}
+```
+
+## Types
+
+### SchemaFlavor
+
+Entity type (flavor) with human-readable display names
+
+| Field | Type | Description |
+|-------|------|-------------|
+| findex | integer | Unique flavor identifier (same as fid in other endpoints) |
+| name | string | Flavor name (internal identifier) |
+| plural_display_name | string | Human-readable plural name (e.g., "Ships") |
+| singular_display_name | string | Human-readable singular name (e.g., "Ship") |
+
+### SchemaProperty
+
+Property with display name, unit, and domain information
+
+| Field | Type | Description |
+|-------|------|-------------|
+| display_name | string | Human-readable property name |
+| domain_findexes | integer[] | Flavor IDs (findexes) that can have this property |
+| name | string | Property name (internal identifier) |
+| pid | integer | Unique property identifier |
+| target_findexes | integer[] | For relationship properties, the flavor IDs of valid targets |
+| unit | string | Unit of measurement (e.g., "m", "kg", "knots") |
+| value_type | string | Property data type. Possible values: "data_float", "data_int", "data_bool", "data_cat", "data_nindex" |
+
+### SchemaResponse
+
+Detailed schema response with entity types (flavors) and properties including display names, units, and domains
+
+| Field | Type | Description |
+|-------|------|-------------|
+| flavors | `SchemaFlavor`[] | Array of entity types (flavors) with display names |
+| properties | `SchemaProperty`[] | Array of properties with display names, units, and domain information |
+
+### FindResponse
+
+| Field | Type | Description |
+|-------|------|-------------|
+| find | `FindData` |  |
+
+### FindData
+
+| Field | Type | Description |
+|-------|------|-------------|
+| **eids** | string[] | Array of 20-character entity IDs matching the search expression |
+
+### GetPropertyValuesResponse
+
+| Field | Type | Description |
+|-------|------|-------------|
+| **values** | `PropertyValue`[] | Array of property values for the requested entities |
+
+### PropertyValue
+
+| Field | Type | Description |
+|-------|------|-------------|
+| **eid** | string | Entity ID this property value belongs to |
+| **pid** | integer | Property ID |
+| **value** | any | Property value (type varies by property: string, number, boolean, or entity ID) |
+| recorded_at | string (date-time) | Timestamp when this value was recorded |
+| imputed | boolean | Whether this value was imputed (inferred) rather than directly observed |
+| attributes | object | Additional metadata about this property value (when include_attributes=true) |
+
+### GetSchemaResponse
+
+| Field | Type | Description |
+|-------|------|-------------|
+| **flavors** | `Flavor`[] | Array of entity types (flavors) available in the system |
+| **properties** | `Property`[] | Array of properties available in the system |
+
+### Flavor
+
+| Field | Type | Description |
+|-------|------|-------------|
+| **fid** | integer | Unique flavor identifier |
+| **name** | string | Flavor name |
+
+### Property
+
+| Field | Type | Description |
+|-------|------|-------------|
+| **pid** | integer | Unique property identifier |
+| **name** | string | Property name |
+| **type** | string | Property data type. Values: `data_float`, `data_int`, `data_bool`, `data_cat`, `data_nindex` |
+
+### SummarizePropertyResponse
+
+| Field | Type | Description |
+|-------|------|-------------|
+| **pid** | integer | The property ID that was summarized |
+| **value_type** | string | Type of property values. Values: `numeric`, `categorical` |
+| unique_count | integer | Number of unique values |
+| values | string[] | Array of unique values for categorical properties |
+| numeric_min | number | Minimum value for numeric properties |
+| numeric_max | number | Maximum value for numeric properties |
+| numeric_mean | number | Mean value for numeric properties |
+
+<!-- END GENERATED CONTENT -->