My Jina Service (2.1.8)

Download OpenAPI specification:Download

This is my awesome service. You can set title and description in your Flow or Gateway to customize this text.

Debug

Debugging interface. In production, you should hide them by setting --no-debug-endpoints in Flow/Gateway.

Get the status of Jina service

Get the status of this Jina service.

This is equivalent to running jina -vf from command line.

.. # noqa: DAR201

Responses

Request samples

curl --request GET \
  --url http://localhost:35967/status

Response samples

Content type
application/json
{
  • "jina": { },
  • "envs": { },
  • "usedMemory": "string"
}

Post a data request to some endpoint

Post a data request to some endpoint.

This is equivalent to the following:

from jina import Flow

f = Flow().add(...)

with f:
    f.post(endpoint, ...)

.. # noqa: DAR201 .. # noqa: DAR101

Request Body schema: application/json
Array of DocumentProto (objects) or Array of objects or Array of strings or Array of strings (Data)

Data to send, a list of dict/string/bytes that can be converted into a list of Document objects

targetPeapod
string (Targetpeapod)

A regex string represent the certain peas/pods request targeted.

parameters
object (Parameters)

A dictionary of parameters to be sent to the executor.

execEndpoint
required
string (Execendpoint)

The endpoint string, by convention starts with /. All executors bind with @requests(on="/foo") will receive this request.

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "targetPeapod": "executor0/*",
  • "parameters": {
    },
  • "execEndpoint": "/foo"
}

Response samples

Content type
application/json
{
  • "requestId": "",
  • "control": {
    },
  • "data": {
    },
  • "header": {
    },
  • "parameters": { },
  • "routes": [ ],
  • "status": {
    }
}

CRUD

CRUD interface. If your service does not implement those interfaces, you can should hide them by setting --no-crud-endpoints in Flow/Gateway.

/Index

Post data requests to the Flow. Executors with @requests(on="/index") will respond.

Request Body schema: application/json
Array of DocumentProto (objects) or Array of objects or Array of strings or Array of strings (Data)

Data to send, a list of dict/string/bytes that can be converted into a list of Document objects

targetPeapod
string (Targetpeapod)

A regex string represent the certain peas/pods request targeted.

parameters
object (Parameters)

A dictionary of parameters to be sent to the executor.

Responses

Request samples

Content type
application/json
{
  • "data": [
    • <