Skip to content

Commit 426f41d

Browse files
committed
docs: added models and api to new structure.
1 parent 8a79017 commit 426f41d

File tree

6 files changed

+100
-221
lines changed

6 files changed

+100
-221
lines changed

Diff for: docs/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ Internet of Agents Components
5252

5353
pages/syntactic_sdk/connect
5454
pages/syntactic_sdk/agntcy_acp_sdk
55+
pages/syntactic_sdk/agntcy_acp_reference
56+
pages/syntactic_sdk/agntcy_acp_models
5557
pages/syntactic_sdk/api_bridge_agent
5658
pages/syntactic_sdk/hil
5759

Diff for: docs/pages/client_sdk/acp_sdk.md

-134
This file was deleted.

Diff for: docs/pages/client_sdk/models.rst renamed to docs/pages/syntactic_sdk/agntcy_acp_models.rst

+17-7
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,6 @@ API Models
9797
.. autopydantic_model:: agntcy_acp.models.RunCreateStateless
9898
:members:
9999

100-
``RunCreation``
101-
***************************************
102-
.. autopydantic_model:: agntcy_acp.models.RunCreation
103-
:members:
104-
105100
``RunError``
106101
***************************************
107102
.. autopydantic_model:: agntcy_acp.models.RunError
@@ -132,14 +127,29 @@ API Models
132127
.. autopydantic_model:: agntcy_acp.models.RunSearchRequest
133128
:members:
134129

130+
``RunStateful``
131+
***************************************
132+
.. autopydantic_model:: agntcy_acp.models.RunStateful
133+
:members:
134+
135+
``RunStateless``
136+
***************************************
137+
.. autopydantic_model:: agntcy_acp.models.RunStateless
138+
:members:
139+
135140
``RunStatus``
136141
***************************************
137142
.. autoclass:: agntcy_acp.models.RunStatus
138143
:members:
139144

140-
``RunWaitResponse``
145+
``RunWaitResponseStateful``
146+
***************************************
147+
.. autopydantic_model:: agntcy_acp.models.RunWaitResponseStateful
148+
:members:
149+
150+
``RunWaitResponseStateless``
141151
***************************************
142-
.. autopydantic_model:: agntcy_acp.models.RunWaitResponse
152+
.. autopydantic_model:: agntcy_acp.models.RunWaitResponseStateless
143153
:members:
144154

145155
``StreamEventPayload``

Diff for: docs/pages/client_sdk/reference.rst renamed to docs/pages/syntactic_sdk/agntcy_acp_reference.rst

+56-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Client Reference API
22
=============================
33

4+
ACP Objects
5+
--------------
6+
47
``ApiClientConfiguration``
58
***************************************
69
.. autoclass:: agntcy_acp.ApiClientConfiguration
@@ -19,16 +22,60 @@ Client Reference API
1922
:members:
2023
:inherited-members:
2124

25+
``ApiClient``
26+
*****************************
27+
.. autoclass:: agntcy_acp.ApiClient
28+
:members:
29+
:inherited-members:
30+
31+
``AsyncApiClient``
32+
*****************************
33+
.. autoclass:: agntcy_acp.AsyncApiClient
34+
:members:
35+
:inherited-members:
36+
2237
``ApiResponse``
2338
*****************************
2439
.. autopydantic_model:: agntcy_acp.ApiResponse
2540
:members:
2641

42+
LangGraph Bindings
43+
-----------------------
44+
45+
``ACPNode``
46+
*****************************
47+
.. autoclass:: agntcy_acp.langgraph.ACPNode
48+
:members:
49+
50+
``APIBridgeAgentNode``
51+
*****************************
52+
.. autoclass:: agntcy_acp.langgraph.APIBridgeAgentNode
53+
:members:
54+
:inherited-members:
55+
56+
``APIBridgeInput``
57+
*****************************
58+
.. autopydantic_model:: agntcy_acp.langgraph.APIBridgeInput
59+
:members:
60+
61+
``APIBridgeOutput``
62+
*****************************
63+
.. autopydantic_model:: agntcy_acp.langgraph.APIBridgeOutput
64+
:members:
65+
66+
``add_io_mapped_edge``
67+
*****************************
68+
.. autofunction:: agntcy_acp.langgraph.add_io_mapped_edge
69+
70+
``add_io_mapped_conditional_edge``
71+
****************************************
72+
.. autofunction:: agntcy_acp.langgraph.add_io_mapped_conditional_edge
73+
2774
Exceptions
2875
------------
2976

3077
``ACPDescriptorValidationException``
31-
**************************************
78+
********************************************
3279
.. autoclass:: agntcy_acp.ACPDescriptorValidationException
3380
:members:
3481
:inherited-members:
@@ -71,43 +118,43 @@ Exceptions
71118

72119
``BadRequestException``
73120
*****************************
74-
.. autoclass:: agntcy_acp.ApiException
121+
.. autoclass:: agntcy_acp.BadRequestException
75122
:members:
76123
:inherited-members:
77124

78125
``NotFoundException``
79126
*****************************
80-
.. autoclass:: agntcy_acp.ApiException
127+
.. autoclass:: agntcy_acp.NotFoundException
81128
:members:
82129
:inherited-members:
83130

84131
``UnauthorizedException``
85132
*****************************
86-
.. autoclass:: agntcy_acp.ApiException
133+
.. autoclass:: agntcy_acp.UnauthorizedException
87134
:members:
88135
:inherited-members:
89136

90137
``ForbiddenException``
91138
*****************************
92-
.. autoclass:: agntcy_acp.ApiException
139+
.. autoclass:: agntcy_acp.ForbiddenException
93140
:members:
94141
:inherited-members:
95142

96143
``ServiceException``
97144
*****************************
98-
.. autoclass:: agntcy_acp.ApiException
145+
.. autoclass:: agntcy_acp.ServiceException
99146
:members:
100147
:inherited-members:
101148

102-
``ConflictException(ApiException``
149+
``ConflictException``
103150
************************************
104-
.. autoclass:: agntcy_acp.ApiException
151+
.. autoclass:: agntcy_acp.ConflictException
105152
:members:
106153
:inherited-members:
107154

108155
``UnprocessableEntityException``
109156
************************************
110-
.. autoclass:: agntcy_acp.ApiException
157+
.. autoclass:: agntcy_acp.UnprocessableEntityException
111158
:members:
112159
:inherited-members:
113160

0 commit comments

Comments
 (0)