docs: updated format and content for client SDK.

Signed-off-by: Jeff Napper <[email protected]>

Author: jnapper7

Diff for: docs/index.rst

@@ -52,8 +52,6 @@ Internet of Agents Components
 
    pages/syntactic_sdk/connect
    pages/syntactic_sdk/agntcy_acp_sdk
-   pages/syntactic_sdk/agntcy_acp_reference
-   pages/syntactic_sdk/agntcy_acp_models
    pages/syntactic_sdk/api_bridge_agent
    pages/syntactic_sdk/hil
 

Diff for: docs/pages/syntactic_sdk/agntcy_acp_models.rst

@@ -1,213 +1,126 @@
-API Models
-===============
 
-
-``Agent``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.Agent
    :members:
 
-``AgentACPDescriptor``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.AgentACPDescriptor
    :members:
 
-``AgentACPSpec``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.AgentACPSpec
    :members:
 
-``AgentACPSpecInterruptsInner``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.AgentACPSpecInterruptsInner
    :members:
 
-``AgentCapabilities``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.AgentCapabilities
    :members:
 
-``AgentMetadata``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.AgentMetadata
    :members:
 
-``AgentRef``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.AgentRef
    :members:
 
-``AgentSearchRequest``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.AgentSearchRequest
    :members:
 
-``Config``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.Config
    :members:
 
-``Content``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.Content
    :members:
 
-``ContentOneOfInner``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.ContentOneOfInner
    :members:
 
-``CustomRunResultUpdate``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.CustomRunResultUpdate
    :members:
 
-``Message``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.Message
    :members:
 
-``MessageAnyBlock``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.MessageAnyBlock
    :members:
 
-``MessageTextBlock``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.MessageTextBlock
    :members:
 
-``Run``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.Run
    :members:
 
-``RunCreate``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunCreate
    :members:
 
-``RunCreateStateful``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunCreateStateful
    :members:
 
-``RunCreateStateless``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunCreateStateless
    :members:
 
-``RunError``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunError
    :members:
 
-``RunInterrupt``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunInterrupt
    :members:
 
-``RunOutput``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunOutput
    :members:
 
-``RunOutputStream``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunOutputStream
    :members:
 
-``RunResult``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunResult
    :members:
 
-``RunSearchRequest``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunSearchRequest
    :members:
 
-``RunStateful``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunStateful
    :members:
 
-``RunStateless``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunStateless
    :members:
 
-``RunStatus``
-***************************************
 .. autoclass:: agntcy_acp.models.RunStatus
    :members:
 
-``RunWaitResponseStateful``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunWaitResponseStateful
    :members:
 
-``RunWaitResponseStateless``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.RunWaitResponseStateless
    :members:
 
-``StreamEventPayload``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.StreamEventPayload
    :members:
 
-``StreamMode``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.StreamMode
    :members:
 
-``StreamingMode``
-***************************************
 .. autoclass:: agntcy_acp.models.StreamingMode
    :members:
 
-``StreamingModes``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.StreamingModes
    :members:
 
-``Thread``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.Thread
    :members:
 
-``ThreadCheckpoint``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.ThreadCheckpoint
    :members:
 
-``ThreadCreate``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.ThreadCreate
    :members:
 
-``ThreadPatch``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.ThreadPatch
    :members:
 
-``ThreadSearchRequest``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.ThreadSearchRequest
    :members:
 
-``ThreadState``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.ThreadState
    :members:
 
-``ThreadStatus``
-***************************************
 .. autoclass:: agntcy_acp.models.ThreadStatus
    :members:
 
-``ValueRunResultUpdate``
-***************************************
 .. autopydantic_model:: agntcy_acp.models.ValueRunResultUpdate
    :members:

Diff for: docs/pages/syntactic_sdk/agntcy_acp_reference.rst

@@ -1,165 +1,111 @@
-Client Reference API
-=============================
-
+^^^^^^^^^^^
 ACP Objects
---------------
+^^^^^^^^^^^
 
-``ApiClientConfiguration``
-***************************************
 .. autoclass:: agntcy_acp.ApiClientConfiguration
    :members:
    :inherited-members:
 
-``ACPClient``
-*****************************
 .. autoclass:: agntcy_acp.ACPClient
    :members:
    :inherited-members:
 
-``AsyncACPClient``
-*****************************
 .. autoclass:: agntcy_acp.AsyncACPClient
    :members:
    :inherited-members:
 
-``ApiClient``
-*****************************
 .. autoclass:: agntcy_acp.ApiClient
    :members:
    :inherited-members:
 
-``AsyncApiClient``
-*****************************
 .. autoclass:: agntcy_acp.AsyncApiClient
    :members:
    :inherited-members:
 
-``ApiResponse``
-*****************************
 .. autopydantic_model:: agntcy_acp.ApiResponse
    :members:
 
+^^^^^^^^^^^^^^^^^^
 LangGraph Bindings
------------------------
+^^^^^^^^^^^^^^^^^^
 
-``ACPNode``
-*****************************
 .. autoclass:: agntcy_acp.langgraph.ACPNode
    :members:
 
-``APIBridgeAgentNode``
-*****************************
 .. autoclass:: agntcy_acp.langgraph.APIBridgeAgentNode
    :members:
    :inherited-members:
 
-``APIBridgeInput``
-*****************************
 .. autopydantic_model:: agntcy_acp.langgraph.APIBridgeInput
    :members:
 
-``APIBridgeOutput``
-*****************************
 .. autopydantic_model:: agntcy_acp.langgraph.APIBridgeOutput
    :members:
 
-``add_io_mapped_edge``
-*****************************
 .. autofunction:: agntcy_acp.langgraph.add_io_mapped_edge
 
-``add_io_mapped_conditional_edge``
-****************************************
 .. autofunction:: agntcy_acp.langgraph.add_io_mapped_conditional_edge
 
+^^^^^^^^^^
 Exceptions
-------------
+^^^^^^^^^^
 
-``ACPDescriptorValidationException``
-********************************************
 .. autoclass:: agntcy_acp.ACPDescriptorValidationException
    :members:
    :inherited-members:
 
-``ACPRunException``
-*****************************
 .. autoclass:: agntcy_acp.ACPRunException
    :members:
    :inherited-members:
 
-``ApiTypeError``
-*****************************
 .. autoclass:: agntcy_acp.ApiTypeError
    :members:
    :inherited-members:
 
-``ApiValueError``
-*****************************
 .. autoclass:: agntcy_acp.ApiValueError
    :members:
    :inherited-members:
 
-``ApiKeyError``
-*****************************
 .. autoclass:: agntcy_acp.ApiKeyError
    :members:
    :inherited-members:
 
-``ApiAttributeError``
-*****************************
 .. autoclass:: agntcy_acp.ApiAttributeError
    :members:
    :inherited-members:
 
-``ApiException``
-*****************************
 .. autoclass:: agntcy_acp.ApiException
    :members:
    :inherited-members:
 
-``BadRequestException``
-*****************************
 .. autoclass:: agntcy_acp.BadRequestException
    :members:
    :inherited-members:
 
-``NotFoundException``
-*****************************
 .. autoclass:: agntcy_acp.NotFoundException
    :members:
    :inherited-members:
 
-``UnauthorizedException``
-*****************************
 .. autoclass:: agntcy_acp.UnauthorizedException
    :members:
    :inherited-members:
 
-``ForbiddenException``
-*****************************
 .. autoclass:: agntcy_acp.ForbiddenException
    :members:
    :inherited-members:
 
-``ServiceException``
-*****************************
 .. autoclass:: agntcy_acp.ServiceException
    :members:
    :inherited-members:
 
-``ConflictException``
-************************************
 .. autoclass:: agntcy_acp.ConflictException
    :members:
    :inherited-members:
 
-``UnprocessableEntityException``
-************************************
 .. autoclass:: agntcy_acp.UnprocessableEntityException
    :members:
    :inherited-members:
 
-``OpenApiException``
-*****************************
 .. autoclass:: agntcy_acp.OpenApiException
    :members:
    :inherited-members: