Python API#
This section includes the API documentation from the jina codebase. These are automatically extracted from the docstrings in the code.
- jina package
- Subpackages
- jina.clients package
- Subpackages
- Submodules
- Module contents
- jina.helloworld package
- jina.hubble package
- Submodules
- jina.hubble.helper module
get_hub_packages_dir()get_cache_db()get_download_cache_dir()get_hubble_url_v1()get_hubble_url_v2()parse_hub_uri()is_valid_huburi()md5file()unpack_package()archive_package()download_with_resume()upload_file()disk_cache_offline()is_requirements_installed()install_requirements()HubbleReturnStatusHubbleReturnStatus.UNKNOWN_ERRORHubbleReturnStatus.OKHubbleReturnStatus.PARAM_VALIDATION_ERRORHubbleReturnStatus.SQL_CREATION_ERRORHubbleReturnStatus.DATA_STREAM_BROKEN_ERRORHubbleReturnStatus.UNEXPECTED_MIME_TYPE_ERRORHubbleReturnStatus.SSO_LOGIN_REQUIREDHubbleReturnStatus.AUTHENTICATION_FAILEDHubbleReturnStatus.AUTHENTICATION_REQUIREDHubbleReturnStatus.OPERATION_NOT_ALLOWEDHubbleReturnStatus.INTERNAL_RESOURCE_NOT_FOUNDHubbleReturnStatus.RPC_METHOD_NOT_FOUNDHubbleReturnStatus.REQUESTED_ENTITY_NOT_FOUNDHubbleReturnStatus.INTERNAL_RESOURCE_METHOD_NOT_ALLOWEDHubbleReturnStatus.INCOMPATIBLE_METHOD_ERRORHubbleReturnStatus.INTERNAL_RESOURCE_ID_CONFLICTHubbleReturnStatus.RESOURCE_POLICY_DENYHubbleReturnStatus.TOO_LARGE_FILEHubbleReturnStatus.INTERNAL_DATA_CORRUPTIONHubbleReturnStatus.IDENTIFIER_NAMESPACE_OCCUPIEDHubbleReturnStatus.SUBMITTED_DATA_MALFORMEDHubbleReturnStatus.EXTERNAL_SERVICE_FAILUREHubbleReturnStatus.DOWNSTREAM_SERVICE_FAILUREHubbleReturnStatus.SERVER_INTERNAL_ERRORHubbleReturnStatus.DOWNSTREAM_SERVICE_ERRORHubbleReturnStatus.SERVER_SUBPROCESS_ERRORHubbleReturnStatus.SANDBOX_BUILD_NOT_FOUNDHubbleReturnStatus.NOT_IMPLEMENTED_ERRORHubbleReturnStatus.RESPONSE_STREAM_CLOSED
NormalizerErrorCodeget_hubble_error_message()
- jina.hubble.hubapi module
- jina.hubble.hubio module
- jina.hubble.requirements module
- jina.hubble.helper module
- Module contents
- Submodules
- jina.jaml package
- jina.logging package
- jina.orchestrate package
- Subpackages
- jina.orchestrate.deployments package
- Subpackages
- Module contents
BaseDeploymentDeploymentDeployment.needsDeployment.update_pod_args()Deployment.update_worker_pod_args()Deployment.is_sandboxDeployment.tls_enabledDeployment.externalDeployment.protocolDeployment.first_pod_argsDeployment.hostDeployment.portDeployment.portsDeployment.dockerized_usesDeployment.head_argsDeployment.uses_before_argsDeployment.uses_after_argsDeployment.all_argsDeployment.num_podsDeployment.activate()Deployment.get_worker_host()Deployment.start()Deployment.wait_start_success()Deployment.join()Deployment.is_ready
- jina.orchestrate.flow package
- Submodules
- jina.orchestrate.flow.asyncio module
- jina.orchestrate.flow.base module
FlowFlow.last_deploymentFlow.needs()Flow.needs_all()Flow.add()Flow.inspect()Flow.gather_inspect()Flow.build()Flow.start()Flow.num_deploymentsFlow.num_podsFlow.clientFlow.plot()Flow.portFlow.hostFlow.monitoringFlow.port_monitoringFlow.address_privateFlow.address_publicFlow.block()Flow.protocolFlow.workspaceFlow.workspace_idFlow.envFlow.expose_endpoint()Flow.join()Flow.to_k8s_yaml()Flow.to_docker_compose_yaml()Flow.client_argsFlow.gateway_argsFlow.update_network_interface()
- jina.orchestrate.flow.builder module
- Module contents
- Submodules
- jina.orchestrate.pods package
- jina.orchestrate.deployments package
- Submodules
- Module contents
- Subpackages
- jina.parsers package
- Subpackages
- jina.parsers.hubble package
- jina.parsers.orchestrate package
- Subpackages
- jina.parsers.orchestrate.runtimes package
- Submodules
- Module contents
- Subpackages
- Submodules
- Module contents
- Subpackages
- jina.proto package
- Submodules
- jina.proto.jina_pb2 module
- jina.proto.jina_pb2_grpc module
JinaControlRequestRPCStubJinaControlRequestRPCServiceradd_JinaControlRequestRPCServicer_to_server()JinaControlRequestRPCJinaDataRequestRPCStubJinaDataRequestRPCServiceradd_JinaDataRequestRPCServicer_to_server()JinaDataRequestRPCJinaSingleDataRequestRPCStubJinaSingleDataRequestRPCServiceradd_JinaSingleDataRequestRPCServicer_to_server()JinaSingleDataRequestRPCJinaRPCStubJinaRPCServiceradd_JinaRPCServicer_to_server()JinaRPCJinaDiscoverEndpointsRPCStubJinaDiscoverEndpointsRPCServiceradd_JinaDiscoverEndpointsRPCServicer_to_server()JinaDiscoverEndpointsRPC
- jina.proto.serializer module
- Module contents
- Submodules
- jina.schemas package
- jina.serve package
- Subpackages
- jina.serve.executors package
- jina.serve.runtimes package
- Subpackages
- jina.serve.runtimes.gateway package
- jina.serve.runtimes.head package
- jina.serve.runtimes.request_handlers package
- Submodules
- jina.serve.runtimes.request_handlers.data_request_handler module
DataRequestHandlerDataRequestHandler.handle()DataRequestHandler.replace_docs()DataRequestHandler.replace_parameters()DataRequestHandler.merge_routes()DataRequestHandler.close()DataRequestHandler.get_docs_matrix_from_request()DataRequestHandler.get_parameters_dict_from_request()DataRequestHandler.get_docs_from_request()DataRequestHandler.reduce()DataRequestHandler.reduce_requests()
- jina.serve.runtimes.request_handlers.data_request_handler module
- Module contents
- Submodules
- jina.serve.runtimes.worker package
- Submodules
- jina.serve.runtimes.asyncio module
AsyncNewLoopRuntimeAsyncNewLoopRuntime.run_forever()AsyncNewLoopRuntime.teardown()AsyncNewLoopRuntime.async_setup()AsyncNewLoopRuntime.async_teardown()AsyncNewLoopRuntime.async_cancel()AsyncNewLoopRuntime.async_run_forever()AsyncNewLoopRuntime.activate()AsyncNewLoopRuntime.is_ready()AsyncNewLoopRuntime.wait_for_ready_or_shutdown()
- jina.serve.runtimes.base module
- jina.serve.runtimes.monitoring module
- jina.serve.runtimes.asyncio module
- Module contents
- Subpackages
- jina.serve.stream package
- Submodules
- jina.serve.networking module
ReplicaListGrpcConnectionPoolGrpcConnectionPool.K8S_PORT_USES_AFTERGrpcConnectionPool.K8S_PORT_USES_BEFOREGrpcConnectionPool.K8S_PORTGrpcConnectionPool.ConnectionStubsGrpcConnectionPool.send_request()GrpcConnectionPool.send_requests()GrpcConnectionPool.send_discover_endpoint()GrpcConnectionPool.send_request_once()GrpcConnectionPool.send_requests_once()GrpcConnectionPool.add_connection()GrpcConnectionPool.remove_connection()GrpcConnectionPool.start()GrpcConnectionPool.close()GrpcConnectionPool.get_grpc_channel()GrpcConnectionPool.activate_worker_sync()GrpcConnectionPool.activate_worker()GrpcConnectionPool.deactivate_worker()GrpcConnectionPool.send_request_sync()GrpcConnectionPool.send_requests_sync()GrpcConnectionPool.get_default_grpc_options()GrpcConnectionPool.send_request_async()GrpcConnectionPool.create_async_channel_stub()GrpcConnectionPool.get_available_services()
in_docker()host_is_local()
- jina.serve.networking module
- Module contents
- Subpackages
- jina.types package
- jina.clients package
- Submodules
- jina.checker module
- jina.enums module
- jina.excepts module
BaseJinaExceptionRuntimeFailToStartRuntimeTerminatedFlowTopologyErrorFlowMissingDeploymentErrorFlowBuildLevelErrorBadConfigSourceBadClientBadClientCallbackBadClientInputBadRequestTypeBadImageNameErrorBadYAMLVersionNotSupportedErrorRuntimeRunForeverEarlyErrorDockerVersionErrorNoContainerizedErrorPortAlreadyUsed
- jina.helper module
batch_iterator()parse_arg()random_port()random_identity()random_uuid()expand_env_var()colored()ArgNamespaceis_valid_local_config_source()cached_propertytypename()get_public_ip()get_internal_ip()convert_tuple_to_list()run_async()deprecated_alias()retry()countdown()CatchAllCleanupContextManagerdownload_mermaid_url()get_readable_size()get_or_reuse_loop()get_rich_console()
- jina.importer module
- Module contents
AsyncFlowClient()DocumentDocumentArrayExecutorFlowFlow.last_deploymentFlow.needs()Flow.needs_all()Flow.add()Flow.inspect()Flow.gather_inspect()Flow.build()Flow.start()Flow.num_deploymentsFlow.num_podsFlow.clientFlow.plot()Flow.portFlow.hostFlow.monitoringFlow.port_monitoringFlow.address_privateFlow.address_publicFlow.block()Flow.protocolFlow.workspaceFlow.workspace_idFlow.envFlow.expose_endpoint()Flow.join()Flow.to_k8s_yaml()Flow.to_docker_compose_yaml()Flow.client_argsFlow.gateway_argsFlow.update_network_interface()
monitor()requests()
- Subpackages
- cli package
