@yottagraph-app/elemental-api-skill 1.0.0

package/skill/entities.md

@@ -0,0 +1,360 @@
+# Entities
+
+Entities are the core objects in the Knowledge Graph: companies, people, organizations, products, and other named things that appear in the news. Each entity has a unique **Named Entity ID (NEID)**.
+
+## When to Use
+
+- You have an entity name and need to find its NEID
+- You have a NEID and need the entity's display name or details
+- You're starting a new query and need to identify the subject
+- You need entity metadata (industry, location, ticker, etc.)
+
+## Key Concepts
+
+- **NEID**: A unique identifier for each entity. Required for most other API calls.
+  - Format: 20-character numeric string with zero-padding
+  - Example: `00416400910670863867`
+  - Always pad with leading zeros to exactly 20 characters when normalizing
+- **EID**: The term EID is sometimes used interchangeably with NEID.
+- **Entity Resolution**: The same real-world entity may have multiple names (e.g., "Apple", "Apple Inc.", "AAPL"). The API resolves these to a single NEID.
+- **Entity Types (Flavors)**: Each entity has a type identified by a Flavor ID (FID) (ex. type "ship" is FID 1).
+
+## Tips
+
+- Always start by searching for the entity to get the correct NEID
+- After resolving an entity to an NEID, it's best to display the canonical entity name to the user to help them identify if something went wrong with the resolution.
+- It's typically safe to resolve an entity to the top matching NEID. However, sometimes a useful pattern is to let the user give input that the resolution was incorrect, show them a longer list of matches, and let them choose a different resolution.
+- Entity names are case-insensitive
+- You can batch multiple entity lookups into a single `/entities/search` request using the `queries` array
+
+## Key Endpoints
+
+| What you need | Endpoint | Returns |
+|---------------|----------|---------|
+| Find entity by name | `POST /entities/search` | Ranked matches with NEIDs and scores |
+| Basic info (name, aliases, type) | `GET /entities/{neid}` | Quick summary for display |
+| Full property values | `POST /elemental/entities/properties` | All properties with PIDs, values, timestamps |
+
+**Important**: When a user asks for "entity properties," clarify which they mean:
+- Basic info/metadata → use `/entities/{neid}`
+- Detailed property data (like relationships, addresses, financial data) → use `/elemental/entities/properties`
+
+## Searching for Entities
+
+`POST /entities/search`
+
+Search for entities by name with scored ranking and optional disambiguation. Supports batch queries (multiple entities in one request). Content-Type must be `application/json`.
+
+### Request Body
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| queries | SearchQuery[] | yes | Array of search queries |
+| minScore | number | no | Minimum match score, 0.0-1.0 (default: 0.8) |
+| maxResults | integer | no | Maximum results per query (default: 10) |
+| includeNames | boolean | no | Include entity names in response (default: true) |
+| includeAliases | boolean | no | Include entity aliases in response (default: false) |
+| includeFlavors | boolean | no | Include entity type/flavor in response (default: true) |
+| includeScores | boolean | no | Include match scores in response (default: true) |
+
+### SearchQuery
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| queryId | integer | yes | User-provided ID for matching queries to results |
+| query | string | yes | Entity name or strong ID to search for |
+| snippet | string | no | Free-text snippet for disambiguating entities with similar names |
+| flavors | string[] | no | Limit results to these entity types (e.g., `["organization"]`) |
+| contextType | string | no | Resolution context: `namedEntity` (default), `event`, or `strongId` |
+| strongIdProperty | string | no | Property name to use as strong ID (when contextType is `strongId`) |
+
+### Response
+
+The response contains a `results` array with one entry per query:
+
+| Field | Type | Description |
+|-------|------|-------------|
+| results[].queryId | integer | Matches the queryId from the request |
+| results[].matches[] | Match[] | Matches sorted by decreasing score |
+
+Each Match contains:
+
+| Field | Type | Description |
+|-------|------|-------------|
+| neid | string | 20-character entity ID |
+| name | string | Entity display name (when includeNames is true) |
+| aliases | string[] | Other names for this entity (when includeAliases is true) |
+| flavor | string | Entity type name (when includeFlavors is true) |
+| score | number | Match confidence 0.0-1.0 (when includeScores is true) |
+
+### Example
+
+**Request:**
+
+```json
+{
+  "queries": [
+    {"queryId": 1, "query": "Apple"},
+    {"queryId": 2, "query": "MSFT", "flavors": ["financial_instrument"]}
+  ],
+  "maxResults": 3
+}
+```
+
+**Response:**
+
+```json
+{
+  "results": [
+    {
+      "queryId": 1,
+      "matches": [
+        {"neid": "00416400910670863867", "name": "Apple", "flavor": "organization", "score": 0.95},
+        {"neid": "07437212020357111309", "name": "AAPL", "flavor": "financial_instrument", "score": 0.82}
+      ]
+    },
+    {
+      "queryId": 2,
+      "matches": [
+        {"neid": "03016672914748108965", "name": "MSFT", "flavor": "financial_instrument", "score": 0.98}
+      ]
+    }
+  ]
+}
+```
+
+## Schema and Property Lookup
+
+For understanding entity types (flavors), properties, and the data model, see **schema.md**. You'll need the schema because many API responses return only FIDs and PIDs — use it to translate these to human-readable names.
+
+
+<!-- BEGIN GENERATED CONTENT -->
+
+## Endpoints
+
+### Get entity details
+
+`GET /entities/{neid}`
+
+Get details about a named entity including name, aliases, and type. This is an alias for /reports/{neid}. Response is cached for 5 minutes.
+
+#### Guidance
+
+Response is wrapped in a 'report' container object. Access entity data via response.report.
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| neid | string | yes | Named Entity ID |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Entity details (`GetNamedEntityReportResponse`) |
+| 400 | Invalid NEID (`Error`) |
+| 404 | Entity not found (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /entities/00416400910670863867
+```
+
+**Response:**
+
+```json
+{"report": {"neid": "00416400910670863867", "name": "Apple", "aliases": ["AAPL", "APPLE", "APPLE INC", "Apple Inc"], "type": "organization"}}
+```
+
+---
+
+### Get entity report
+
+`GET /reports/{neid}`
+
+Get a report about a named entity including name, aliases, and type. Response is cached for 5 minutes.
+
+#### Guidance
+
+Response is wrapped in a 'report' container object. Access entity data via response.report.
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| neid | string | yes | Named Entity ID |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Entity report (`GetNamedEntityReportResponse`) |
+| 400 | Invalid NEID (`Error`) |
+| 404 | Entity not found (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /reports/00416400910670863867
+```
+
+**Response:**
+
+```json
+{"report": {"neid": "00416400910670863867", "name": "Apple", "aliases": ["AAPL", "APPLE", "APPLE INC", "Apple Inc"], "type": "organization"}}
+```
+
+---
+
+### 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"}]}
+```
+
+## Types
+
+### GetNamedEntityReportResponse
+
+Response containing a report about a named entity
+
+| Field | Type | Description |
+|-------|------|-------------|
+| report | `NamedEntityReport` |  |
+
+### NamedEntityReport
+
+The named entity report
+
+| Field | Type | Description |
+|-------|------|-------------|
+| aliases | string[] | Aliases of the Named Entity from the forwarding map (i.e., from ER) |
+| name | string | Name of the Named Entity |
+| neid | string | Named Entity ID |
+| type | string | Entity type (flavor) |
+
+### 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) |
+
+<!-- END GENERATED CONTENT -->

package/skill/events.md

@@ -0,0 +1,145 @@
+# Events
+
+Events are significant occurrences involving entities: mergers, acquisitions, lawsuits, executive changes, product launches, and other newsworthy happenings. Events are extracted from article content and link multiple entities and articles together.
+
+## When to Use
+
+- You want to know what happened to/with an entity (not just mentions)
+- You want to see how different articles reference the same event(s), and understand that many articles may duplicate information about the same event(s).
+- You want to see what entities participated in an event, and what their roles were.
+
+## Key Concepts
+
+- **Event ID (EVEID)**: Unique identifier for each event.
+  - Format: 20-character numeric string (same format as NEIDs)
+  - Example: `08640179941787350436`
+- **Event Roles**: Entities participate in events with roles (e.g., acquirer, target, plaintiff)
+- **Event Summary**: Brief description of what occurred
+- **Event Date**: When the event happened (may differ from article publication date)
+
+## Tips
+
+- Multiple articles may reference the same event
+- Check entity roles to understand the nature of involvement
+
+<!-- BEGIN GENERATED CONTENT -->
+
+## Endpoints
+
+### Get events for an entity
+
+`GET /events/lookup`
+
+Get list of event IDs (EVEIDs) where an entity participates within a time interval. Response is cached for 5 minutes.
+
+#### Guidance
+
+Event IDs returned may not all be immediately retrievable via /events/{eveid}. Some events may return 404 due to event processing timing or data availability. Handle 404 responses gracefully.
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| interval_start | string | yes | Start time of interval (RFC3339) |
+| interval_end | string | yes | End time of interval (RFC3339) |
+| neid | string | yes | Named Entity ID |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | List of event IDs (`GetEventsForEntityResponse`) |
+| 400 | Invalid parameters (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /events/lookup?interval_start=2026-01-28T00:00:00Z&interval_end=2026-01-29T00:00:00Z&neid=00416400910670863867
+```
+
+**Response:**
+
+```json
+{"event_ids": ["07880710486873721498", "07189853443333370710", "01188063638449369172"]}
+```
+
+---
+
+### Get event detail
+
+`GET /events/{eveid}`
+
+Get detailed information about an event by its ID. Response is cached for 15 minutes.
+
+#### Guidance
+
+Response is wrapped in a 'detail' container object. Access event data via response.detail.
+
+#### Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| eveid | string | yes | Event ID |
+
+#### Responses
+
+| Status | Description |
+|--------|-------------|
+| 200 | Event detail (`GetEventResponse`) |
+| 400 | Invalid EVEID (`Error`) |
+| 404 | Event not found (`Error`) |
+| 500 | Internal server error (`Error`) |
+
+#### Example
+
+**Request:**
+
+```
+GET /events/08640179941787350436
+```
+
+**Response:**
+
+```json
+{"detail": {"eveid": "08640179941787350436", "name": "event|Apple plans to release a foldable device...|2026", "date": "2026", "description": "The new design and engineering changes in the iPhone Air could pave the way...", "category": "Product Development", "likelihood": "Medium", "severity": 0, "speculative": false, "participants": [{"neid": "00416400910670863867", "sentiment": 0.5, "explanation": "The launch of new products...", "role": "company", "snippet": "Apple is gearing up for the most extensive refresh...", "artid": "07521758285625650094"}]}}
+```
+
+## Types
+
+### EventDetail
+
+The event detail
+
+| Field | Type | Description |
+|-------|------|-------------|
+| artids | string[] | Article IDs where this event was found |
+| category | string | Category of the event |
+| date | string | Date of the event |
+| description | string | Description of the event |
+| eveid | string | Event ID |
+| likelihood | string | Likelihood assessment of the event |
+| name | string | Name of the event |
+| participants | `EventParticipant`[] | Participants in the event |
+| severity | integer | Severity level of the event |
+| speculative | boolean | Whether the event is speculative |
+
+### GetEventResponse
+
+Response containing detailed information about an event
+
+| Field | Type | Description |
+|-------|------|-------------|
+| detail | `EventDetail` |  |
+
+### GetEventsForEntityResponse
+
+Response containing event IDs for an entity
+
+| Field | Type | Description |
+|-------|------|-------------|
+| event_ids | string[] | List of event IDs |
+
+<!-- END GENERATED CONTENT -->