Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Part of RoboSystems, the open-source knowledge graph for finance. The official P

- **Type-safe API client** with full type hints and typed models
- **Async client** for queries and operations
- **Parquet file uploads** for table ingestion
- **Parquet file uploads** for table ingestion into custom graphs
- **Row iteration** over query results with `stream_query`, which collects the full result before yielding rows
- **AI Operator** integration for natural language financial analysis
- **Typed errors** for GraphQL reads and queued work
Expand Down
48 changes: 24 additions & 24 deletions robosystems_client/api/operator/auto_select_operator.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,12 +130,12 @@ def sync_detailed(

Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions
over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`,
`standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of
Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET
/v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token
usage, not a fixed price per mode. The run executes on the background worker: the default answer is
202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers
200 with the result.
`standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (automatic Chart of
Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `author` makes writes, so it
is never chosen here: call it by name. `GET /v1/graphs/{graph_id}/operator` lists what is
registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes
on the background worker: the default answer is 202 with the operation's `_links` (stream, status,
cancel); `?mode=sync` waits up to 50s and answers 200 with the result.

Args:
graph_id (str):
Expand Down Expand Up @@ -177,12 +177,12 @@ def sync(

Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions
over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`,
`standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of
Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET
/v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token
usage, not a fixed price per mode. The run executes on the background worker: the default answer is
202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers
200 with the result.
`standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (automatic Chart of
Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `author` makes writes, so it
is never chosen here: call it by name. `GET /v1/graphs/{graph_id}/operator` lists what is
registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes
on the background worker: the default answer is 202 with the operation's `_links` (stream, status,
cancel); `?mode=sync` waits up to 50s and answers 200 with the result.

Args:
graph_id (str):
Expand Down Expand Up @@ -219,12 +219,12 @@ async def asyncio_detailed(

Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions
over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`,
`standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of
Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET
/v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token
usage, not a fixed price per mode. The run executes on the background worker: the default answer is
202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers
200 with the result.
`standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (automatic Chart of
Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `author` makes writes, so it
is never chosen here: call it by name. `GET /v1/graphs/{graph_id}/operator` lists what is
registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes
on the background worker: the default answer is 202 with the operation's `_links` (stream, status,
cancel); `?mode=sync` waits up to 50s and answers 200 with the result.

Args:
graph_id (str):
Expand Down Expand Up @@ -264,12 +264,12 @@ async def asyncio(

Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions
over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`,
`standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of
Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET
/v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token
usage, not a fixed price per mode. The run executes on the background worker: the default answer is
202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers
200 with the result.
`standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (automatic Chart of
Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `author` makes writes, so it
is never chosen here: call it by name. `GET /v1/graphs/{graph_id}/operator` lists what is
registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes
on the background worker: the default answer is 202 with the operation's `_links` (stream, status,
cancel); `?mode=sync` waits up to 50s and answers 200 with the result.

Args:
graph_id (str):
Expand Down
44 changes: 28 additions & 16 deletions robosystems_client/api/operator/execute_specific_operator.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,13 @@ def sync_detailed(

Available: `analyst` (natural-language questions over the graph — curated financial reads,
documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate
operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap
mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The
run executes on the background worker: the default answer is 202 with the operation's `_links`
(stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
operator; `cypher` is accepted as its former name), `mapping` (Chart of Accounts → rs-gaap mapping,
roboledger graphs only) and `author` (makes the change a request asks for, such as metric and
forecast blocks, counterparties, memories, draft reports and inbox classifications, through writes
that are reversible or wait on a person's step; needs write access to the graph). `GET
/v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker:
the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits
up to 50s and answers 200 with the result.

Args:
graph_id (str):
Expand Down Expand Up @@ -181,10 +184,13 @@ def sync(

Available: `analyst` (natural-language questions over the graph — curated financial reads,
documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate
operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap
mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The
run executes on the background worker: the default answer is 202 with the operation's `_links`
(stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
operator; `cypher` is accepted as its former name), `mapping` (Chart of Accounts → rs-gaap mapping,
roboledger graphs only) and `author` (makes the change a request asks for, such as metric and
forecast blocks, counterparties, memories, draft reports and inbox classifications, through writes
that are reversible or wait on a person's step; needs write access to the graph). `GET
/v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker:
the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits
up to 50s and answers 200 with the result.

Args:
graph_id (str):
Expand Down Expand Up @@ -224,10 +230,13 @@ async def asyncio_detailed(

Available: `analyst` (natural-language questions over the graph — curated financial reads,
documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate
operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap
mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The
run executes on the background worker: the default answer is 202 with the operation's `_links`
(stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
operator; `cypher` is accepted as its former name), `mapping` (Chart of Accounts → rs-gaap mapping,
roboledger graphs only) and `author` (makes the change a request asks for, such as metric and
forecast blocks, counterparties, memories, draft reports and inbox classifications, through writes
that are reversible or wait on a person's step; needs write access to the graph). `GET
/v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker:
the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits
up to 50s and answers 200 with the result.

Args:
graph_id (str):
Expand Down Expand Up @@ -270,10 +279,13 @@ async def asyncio(

Available: `analyst` (natural-language questions over the graph — curated financial reads,
documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate
operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap
mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The
run executes on the background worker: the default answer is 202 with the operation's `_links`
(stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
operator; `cypher` is accepted as its former name), `mapping` (Chart of Accounts → rs-gaap mapping,
roboledger graphs only) and `author` (makes the change a request asks for, such as metric and
forecast blocks, counterparties, memories, draft reports and inbox classifications, through writes
that are reversible or wait on a person's step; needs write access to the graph). `GET
/v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker:
the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits
up to 50s and answers 200 with the result.

Args:
graph_id (str):
Expand Down
8 changes: 4 additions & 4 deletions robosystems_client/api/operator/get_operator_metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ def sync_detailed(

Args:
graph_id (str):
operator_type (str): Operator type identifier (e.g., 'analyst', 'mapping')
operator_type (str): Operator type identifier: 'analyst', 'mapping' or 'author'

Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
Expand Down Expand Up @@ -130,7 +130,7 @@ def sync(

Args:
graph_id (str):
operator_type (str): Operator type identifier (e.g., 'analyst', 'mapping')
operator_type (str): Operator type identifier: 'analyst', 'mapping' or 'author'

Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
Expand All @@ -157,7 +157,7 @@ async def asyncio_detailed(

Args:
graph_id (str):
operator_type (str): Operator type identifier (e.g., 'analyst', 'mapping')
operator_type (str): Operator type identifier: 'analyst', 'mapping' or 'author'

Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
Expand Down Expand Up @@ -187,7 +187,7 @@ async def asyncio(

Args:
graph_id (str):
operator_type (str): Operator type identifier (e.g., 'analyst', 'mapping')
operator_type (str): Operator type identifier: 'analyst', 'mapping' or 'author'

Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
Expand Down
28 changes: 16 additions & 12 deletions robosystems_client/api/robo_investor/create_security.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,10 @@ def sync_detailed(
) -> Response[ErrorResponse | OperationEnvelopeSecurityResponse]:
"""Create Security

Register a security (common stock, preferred stock, warrant, convertible note, etc.) owned by this
graph's entity. Optionally cross-links to an issuing entity in another graph via `source_graph_id`
for mutual-handshake attribution.
Register a security (common stock, preferred stock, warrant, convertible note, etc.) in this graph's
registry. Its `entity_id` is the issuer, not the holder; a portfolio's `entity_id` is the owner.
Optionally cross-links to the issuer's own graph via `source_graph_id` for mutual-handshake
attribution.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down Expand Up @@ -160,9 +161,10 @@ def sync(
) -> ErrorResponse | OperationEnvelopeSecurityResponse | None:
"""Create Security

Register a security (common stock, preferred stock, warrant, convertible note, etc.) owned by this
graph's entity. Optionally cross-links to an issuing entity in another graph via `source_graph_id`
for mutual-handshake attribution.
Register a security (common stock, preferred stock, warrant, convertible note, etc.) in this graph's
registry. Its `entity_id` is the issuer, not the holder; a portfolio's `entity_id` is the owner.
Optionally cross-links to the issuer's own graph via `source_graph_id` for mutual-handshake
attribution.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down Expand Up @@ -202,9 +204,10 @@ async def asyncio_detailed(
) -> Response[ErrorResponse | OperationEnvelopeSecurityResponse]:
"""Create Security

Register a security (common stock, preferred stock, warrant, convertible note, etc.) owned by this
graph's entity. Optionally cross-links to an issuing entity in another graph via `source_graph_id`
for mutual-handshake attribution.
Register a security (common stock, preferred stock, warrant, convertible note, etc.) in this graph's
registry. Its `entity_id` is the issuer, not the holder; a portfolio's `entity_id` is the owner.
Optionally cross-links to the issuer's own graph via `source_graph_id` for mutual-handshake
attribution.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down Expand Up @@ -247,9 +250,10 @@ async def asyncio(
) -> ErrorResponse | OperationEnvelopeSecurityResponse | None:
"""Create Security

Register a security (common stock, preferred stock, warrant, convertible note, etc.) owned by this
graph's entity. Optionally cross-links to an issuing entity in another graph via `source_graph_id`
for mutual-handshake attribution.
Register a security (common stock, preferred stock, warrant, convertible note, etc.) in this graph's
registry. Its `entity_id` is the issuer, not the holder; a portfolio's `entity_id` is the owner.
Optionally cross-links to the issuer's own graph via `source_graph_id` for mutual-handshake
attribution.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ def sync_detailed(
should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names
any active schedule already posting the same accounts in the same months. With
`replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by
month, and the path the change takes: `rebuild` (rebuild-schedule with the new definition) while
nothing has posted, `terminate_and_succeed` after.
month, and the path the change takes: `rebuild` (the schedule regenerated in place from the new
definition) while nothing has posted, `terminate_and_succeed` after.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down Expand Up @@ -172,8 +172,8 @@ def sync(
should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names
any active schedule already posting the same accounts in the same months. With
`replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by
month, and the path the change takes: `rebuild` (rebuild-schedule with the new definition) while
nothing has posted, `terminate_and_succeed` after.
month, and the path the change takes: `rebuild` (the schedule regenerated in place from the new
definition) while nothing has posted, `terminate_and_succeed` after.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down Expand Up @@ -217,8 +217,8 @@ async def asyncio_detailed(
should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names
any active schedule already posting the same accounts in the same months. With
`replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by
month, and the path the change takes: `rebuild` (rebuild-schedule with the new definition) while
nothing has posted, `terminate_and_succeed` after.
month, and the path the change takes: `rebuild` (the schedule regenerated in place from the new
definition) while nothing has posted, `terminate_and_succeed` after.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down Expand Up @@ -265,8 +265,8 @@ async def asyncio(
should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names
any active schedule already posting the same accounts in the same months. With
`replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by
month, and the path the change takes: `rebuild` (rebuild-schedule with the new definition) while
nothing has posted, `terminate_and_succeed` after.
month, and the path the change takes: `rebuild` (the schedule regenerated in place from the new
definition) while nothing has posted, `terminate_and_succeed` after.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down
Loading
Loading