brk-code

agent-protocol の API リファレンス

agent-protocol (langchain-ai/agent-protocol) の公開 API 112 件 —— クラス 35、関数 27、メソッド 50。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: langchain-ai/agent-protocol

種別件数
クラス35
関数27
メソッド50

API 一覧

classclient-python.ap_client.api_client.ApiClient
Generic API client for OpenAPI client library builds.
classclient-python.ap_client.api_response.ApiResponse
API response object
methodclient-python.ap_client.configuration.Configuration.auth_settings() -> AuthSettings
Gets Auth Settings dict for api client.
methodclient-python.ap_client.configuration.Configuration.get_api_key_with_prefix(identifier:str, alias:Optional[str]=None) -> Optional[str]
Gets API key (with prefix if set).
methodclient-python.ap_client.configuration.Configuration.get_default() -> Self
Return the default configuration.
methodclient-python.ap_client.configuration.Configuration.get_default_copy() -> Self
Deprecated.
methodclient-python.ap_client.configuration.Configuration.host() -> str
Return generated host.
methodclient-python.ap_client.configuration.Configuration.logger_file() -> Optional[str]
The logger file.
methodclient-python.ap_client.configuration.Configuration.logger_format() -> str
The logger format.
methodclient-python.ap_client.configuration.Configuration.set_default(default:Optional[Self]) -> None
Set default instance of configuration.
classclient-python.ap_client.exceptions.ConflictException
Exception for HTTP 409 Conflict.
classclient-python.ap_client.exceptions.OpenApiException
The base exception class for all OpenAPIExceptions
classclient-python.ap_client.exceptions.UnprocessableEntityException
Exception for HTTP 422 Unprocessable Entity.
classclient-python.ap_client.models.agent.Agent
Agent
methodclient-python.ap_client.models.agent.Agent.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of Agent from a dict
methodclient-python.ap_client.models.agent.Agent.from_json(json_str:str) -> Optional[Self]
Create an instance of Agent from a JSON string
methodclient-python.ap_client.models.agent.Agent.to_dict() -> Dict[str, Any]
Return the dictionary representation of the model using alias.
classclient-python.ap_client.models.agent_schema.AgentSchema
Defines the structure and properties of an agent.
methodclient-python.ap_client.models.agent_schema.AgentSchema.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of AgentSchema from a dict
methodclient-python.ap_client.models.agent_schema.AgentSchema.from_json(json_str:str) -> Optional[Self]
Create an instance of AgentSchema from a JSON string
classclient-python.ap_client.models.agent_schemas.AgentSchemas
Defines the structure and properties of an agent.
methodclient-python.ap_client.models.agent_schemas.AgentSchemas.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of AgentSchemas from a dict
classclient-python.ap_client.models.config.Config
The configuration for the agent.
methodclient-python.ap_client.models.config.Config.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of Config from a dict
methodclient-python.ap_client.models.config.Config.from_json(json_str:str) -> Optional[Self]
Create an instance of Config from a JSON string
classclient-python.ap_client.models.content.Content
The content of the message.
methodclient-python.ap_client.models.content.Content.from_json(json_str:str) -> Self
Returns the object represented by the json string
classclient-python.ap_client.models.content_one_of_inner.ContentOneOfInner
ContentOneOfInner
methodclient-python.ap_client.models.content_one_of_inner.ContentOneOfInner.from_json(json_str:str) -> Self
Returns the object represented by the json string
classclient-python.ap_client.models.error_response.ErrorResponse
ErrorResponse
methodclient-python.ap_client.models.error_response.ErrorResponse.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of ErrorResponse from a dict
classclient-python.ap_client.models.input.Input
The input to the agent.
methodclient-python.ap_client.models.input.Input.from_json(json_str:str) -> Self
Returns the object represented by the json string
methodclient-python.ap_client.models.item.Item.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of Item from a dict
methodclient-python.ap_client.models.item.Item.from_json(json_str:str) -> Optional[Self]
Create an instance of Item from a JSON string
classclient-python.ap_client.models.message.Message
Message
methodclient-python.ap_client.models.message.Message.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of Message from a dict
methodclient-python.ap_client.models.message.Message.from_json(json_str:str) -> Optional[Self]
Create an instance of Message from a JSON string
classclient-python.ap_client.models.message_any_block.MessageAnyBlock
MessageAnyBlock
classclient-python.ap_client.models.message_text_block.MessageTextBlock
MessageTextBlock
classclient-python.ap_client.models.run.Run
Run
methodclient-python.ap_client.models.run.Run.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of Run from a dict
methodclient-python.ap_client.models.run.Run.from_json(json_str:str) -> Optional[Self]
Create an instance of Run from a JSON string
methodclient-python.ap_client.models.run.Run.if_not_exists_validate_enum(value)
Validates the enum
methodclient-python.ap_client.models.run.Run.on_completion_validate_enum(value)
Validates the enum
methodclient-python.ap_client.models.run.Run.on_disconnect_validate_enum(value)
Validates the enum
classclient-python.ap_client.models.run_create.RunCreate
Payload for creating a run.
methodclient-python.ap_client.models.run_create.RunCreate.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of RunCreate from a dict
methodclient-python.ap_client.models.run_create.RunCreate.from_json(json_str:str) -> Optional[Self]
Create an instance of RunCreate from a JSON string
methodclient-python.ap_client.models.run_create.RunCreate.if_not_exists_validate_enum(value)
Validates the enum
methodclient-python.ap_client.models.run_create.RunCreate.on_completion_validate_enum(value)
Validates the enum
methodclient-python.ap_client.models.run_create.RunCreate.on_disconnect_validate_enum(value)
Validates the enum
classclient-python.ap_client.models.run_search_request.RunSearchRequest
Payload for listing runs.
classclient-python.ap_client.models.run_status.RunStatus
The status of the run.
methodclient-python.ap_client.models.run_status.RunStatus.from_json(json_str:str) -> Self
Create an instance of RunStatus from a JSON string
classclient-python.ap_client.models.run_stream.RunStream
RunStream
methodclient-python.ap_client.models.run_stream.RunStream.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of RunStream from a dict
methodclient-python.ap_client.models.run_stream.RunStream.from_json(json_str:str) -> Optional[Self]
Create an instance of RunStream from a JSON string
methodclient-python.ap_client.models.run_stream.RunStream.if_not_exists_validate_enum(value)
Validates the enum
methodclient-python.ap_client.models.run_stream.RunStream.on_completion_validate_enum(value)
Validates the enum
methodclient-python.ap_client.models.run_stream.RunStream.on_disconnect_validate_enum(value)
Validates the enum
classclient-python.ap_client.models.run_wait_response.RunWaitResponse
RunWaitResponse
classclient-python.ap_client.models.search_agents_request.SearchAgentsRequest
SearchAgentsRequest
classclient-python.ap_client.models.search_items_response.SearchItemsResponse
SearchItemsResponse
classclient-python.ap_client.models.store_delete_request.StoreDeleteRequest
Request to delete an item.
classclient-python.ap_client.models.store_list_namespaces_request.StoreListNamespacesRequest
StoreListNamespacesRequest
classclient-python.ap_client.models.store_put_request.StorePutRequest
Request to store or update an item.
classclient-python.ap_client.models.store_search_request.StoreSearchRequest
Request to search for items
classclient-python.ap_client.models.stream_mode.StreamMode
The stream mode(s) to use.
methodclient-python.ap_client.models.stream_mode.StreamMode.from_json(json_str:str) -> Self
Returns the object represented by the json string
classclient-python.ap_client.models.thread.Thread
Thread
methodclient-python.ap_client.models.thread.Thread.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of Thread from a dict
methodclient-python.ap_client.models.thread.Thread.from_json(json_str:str) -> Optional[Self]
Create an instance of Thread from a JSON string
classclient-python.ap_client.models.thread_create.ThreadCreate
Payload for creating a thread.
methodclient-python.ap_client.models.thread_create.ThreadCreate.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of ThreadCreate from a dict
methodclient-python.ap_client.models.thread_create.ThreadCreate.if_exists_validate_enum(value)
Validates the enum
classclient-python.ap_client.models.thread_patch.ThreadPatch
Payload for updating a thread.
methodclient-python.ap_client.models.thread_patch.ThreadPatch.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of ThreadPatch from a dict
methodclient-python.ap_client.models.thread_patch.ThreadPatch.from_json(json_str:str) -> Optional[Self]
Create an instance of ThreadPatch from a JSON string
classclient-python.ap_client.models.thread_search_request.ThreadSearchRequest
Payload for listing threads.
classclient-python.ap_client.models.thread_state.ThreadState
ThreadState
methodclient-python.ap_client.models.thread_state.ThreadState.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of ThreadState from a dict
methodclient-python.ap_client.models.thread_state.ThreadState.from_json(json_str:str) -> Optional[Self]
Create an instance of ThreadState from a JSON string
classclient-python.ap_client.models.thread_status.ThreadStatus
The status of the thread.
methodclient-python.ap_client.models.thread_status.ThreadStatus.from_json(json_str:str) -> Self
Create an instance of ThreadStatus from a JSON string
funcserver.ap_server.routers.agents.get_agent(agent_id:str) -> Union[Agent, ErrorResponse]
Get Agent
funcserver.ap_server.routers.agents.get_agent_schemas(agent_id:str) -> Union[AgentSchema, ErrorResponse]
Get Agent Schemas
funcserver.ap_server.routers.agents.search_agents(body:AgentsSearchPostRequest) -> Union[AgentsSearchPostResponse, ErrorResponse]
Search Agents
funcserver.ap_server.routers.background_runs.cancel_run(run_id:UUID, wait:Optional[bool]=False, action:Optional[Action]='interrupt') -> Optional[ErrorResponse]
Cancel Run
funcserver.ap_server.routers.background_runs.create_run(body:RunStream) -> Union[Run, ErrorResponse]
Create Background Run
funcserver.ap_server.routers.background_runs.delete_run(run_id:UUID) -> Optional[ErrorResponse]
Delete Run
funcserver.ap_server.routers.background_runs.get_run(run_id:UUID) -> Union[Run, ErrorResponse]
Get Run
funcserver.ap_server.routers.background_runs.search_runs(body:RunSearchRequest) -> Union[RunsSearchPostResponse, ErrorResponse]
Search Runs
funcserver.ap_server.routers.background_runs.stream_run(run_id:UUID) -> Union[Any, ErrorResponse]
Stream output from Run
funcserver.ap_server.routers.background_runs.wait_run(run_id:UUID) -> Union[RunWaitResponse, ErrorResponse]
Wait for Run output
funcserver.ap_server.routers.runs.create_and_stream_run(body:RunStream) -> Union[str, ErrorResponse]
Create Run, Stream Output
funcserver.ap_server.routers.runs.create_and_wait_run(body:RunCreate) -> Union[RunWaitResponse, ErrorResponse]
Create Run, Wait for Output
funcserver.ap_server.routers.stateless_runs.run_stateless_runs_post(body:RunCreate) -> Union[Any, ErrorResponse]
Create Background Run
funcserver.ap_server.routers.stateless_runs.stream_run_stateless_runs_stream_post(body:RunCreate) -> Union[str, ErrorResponse]
Create Run, Stream Output
funcserver.ap_server.routers.stateless_runs.wait_run_stateless_runs_wait_post(body:RunCreate) -> Union[RunWaitResponse, ErrorResponse]
Create Run, Wait for Output
funcserver.ap_server.routers.store.delete_item(body:StoreDeleteRequest) -> Optional[ErrorResponse]
Delete Store Item
funcserver.ap_server.routers.store.get_item(key:str, namespace:Annotated[list[str] | None, Query()]=None) -> Union[Item, ErrorResponse]
Get Store Item
funcserver.ap_server.routers.store.list_namespaces(body:StoreListNamespacesRequest) -> Union[ListNamespaceResponse, ErrorResponse]
List namespaces
funcserver.ap_server.routers.store.put_item(body:StorePutRequest) -> Optional[ErrorResponse]
Insert or Update Item
funcserver.ap_server.routers.store.search_items(body:StoreSearchRequest) -> Union[SearchItemsResponse, ErrorResponse]
Search Store Items
funcserver.ap_server.routers.threads.copy_thread(thread_id:UUID) -> Union[Thread, ErrorResponse]
Copy Thread
funcserver.ap_server.routers.threads.create_thread(body:ThreadCreate) -> Union[Thread, ErrorResponse]
Create Thread
funcserver.ap_server.routers.threads.delete_thread(thread_id:UUID) -> Optional[ErrorResponse]
Delete Thread
funcserver.ap_server.routers.threads.get_thread(thread_id:UUID) -> Union[Thread, ErrorResponse]
Get Thread
funcserver.ap_server.routers.threads.get_thread_history(thread_id:UUID, limit:Optional[int]=10, before:Optional[str]=None) -> Union[ThreadsThreadIdHistoryGetResponse, ErrorResponse]
Get Thread History
funcserver.ap_server.routers.threads.patch_thread(thread_id:UUID, body:ThreadPatch=...) -> Union[Thread, ErrorResponse]
Patch Thread
funcserver.ap_server.routers.threads.search_threads(body:ThreadSearchRequest) -> Union[ThreadsSearchPostResponse, ErrorResponse]
Search Threads

この情報について

掲載しているシグネチャは langchain-ai/agent-protocol の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・ 型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。 詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧(全 805 件)へ戻る