Python API#
This section includes the API documentation from the jina codebase, as extracted from the docstrings in the code.
For further details, please refer to the full user guide.
jina.orchestrate.deployments
- Deployment#
|
A Deployment is an immutable set of pods, which run in replicas. |
jina.orchestrate.flow
- Flow#
Flow is how Jina streamlines and distributes Executors. |
|
Asynchronous version of |
jina.serve.executors
- Executor#
The base class of all Executors, can be used to build encoder, indexer, etc. |
|
@requests defines the endpoints of an Executor. |
|
Decorator and context manager that allows monitoring of an Executor. |
jina.clients
- Clients#
Convenience function that returns client instance for given protocol. |
|
A client connecting to a Gateway using gRPC protocol. |
|
Asynchronous client connecting to a Gateway using gRPC protocol. |
|
A client connecting to a Gateway using gRPC protocol. |
|
Asynchronous client connecting to a Gateway using HTTP protocol. |
|
A client connecting to a Gateway using WebSocket protocol. |
|
Asynchronous client connecting to a Gateway using WebSocket protocol. |
jina.types.request
- Networking messages#
|
|
Represents a DataRequest used for exchanging |
|
Response is the |
|
Represents a Status message used for health check of the Flow |
jina.serve.runtimes
- Flow internals#
Runtime to make sure that a server can asynchronously run inside a new asynchronous loop. |