Post API¶
post_instance(client, instance_type, instance, system_time=jm.SystemTime()) ¶
Low-level API for sending instance to JijZept.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
client | JijZeptClient | JijZept client object | required |
instance_type | str | instance type | required |
instance | Dict[str, Any] | serialized instance object. | required |
system_time | SystemTime | Object to store upload time. | SystemTime() |
Returns:
| Name | Type | Description |
|---|---|---|
str | str | The ID of the uploaded instance. |
post_instance_and_query(ResponseType, client, instance_type, instance, queue_name, solver, parameters, timeout=None, sync=True) ¶
Low-level API for sending instance and solve request to JijZept.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
client | JijZeptClient | JijZept client object | required |
instance_type | str | instance type | required |
instance | Dict[str, Any] | serialized instance object. | required |
queue_name | str | queue_name that specifies which solver the request to be sent to. | required |
solver | str | solver string that is used in JijZept solvers. | required |
parameters | dict | additional parameters to be sent to JijZept solvers. | required |
timeout | int | float | None | solver timeout [second] | None |
ResponseType | Type[TypeVar | Response Type. Defaults to "BaseResponse")]. | required |
sync | bool | set sync model. if True, this function does polling until the solution status is | True |
Returns:
| Name | Type | Description |
|---|---|---|
ResponseType | response object |
post_query(ResponseType, client, instance_id, queue_name, solver, parameters, timeout=None, sync=True, system_time=jm.SystemTime()) ¶
Low-level API for sending solve request to JijZept.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
client | JijZeptClient | JijZept client object | required |
instance_id | str | The ID of the uploaded instance. | required |
queue_name | str | queue_name that specifies which solver the request to be sent to. | required |
solver | str | solver string that is used in JijZept solvers. | required |
parameters | dict | additional parameters to be sent to JijZept solvers. | required |
timeout | int | float | None | solver timeout [second] | None |
ResponseType | Type[TypeVar | Response Type. Defaults to "BaseResponse")]. | required |
sync | bool | set sync model. if True, this function does polling until the solution status is changed from | True |
system_time | SystemTime | Object to store system times other than upload time. | SystemTime() |
Returns:
| Name | Type | Description |
|---|---|---|
ResponseType | response object |