logo
Documentation Powered by ReDoc

My Jina Service (3.18.0)

Download OpenAPI specification:Download

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

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/:[62488]/status'

Response samples

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

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 PydanticDocument (objects) or object (Data)

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

targetExecutor
string (Targetexecutor)

A regex string representing the specific pods/deployments targeted by the request.

parameters
object (Parameters)

A dictionary of parameters to be sent to the executor.

Responses

Request samples

Content type
application/json
{}

Response samples

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

/Search

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

Request Body schema: application/json
Array of PydanticDocument (objects) or object (Data)

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

targetExecutor
string (Targetexecutor)

A regex string representing the specific pods/deployments targeted by the request.

parameters
object (Parameters)

A dictionary of parameters to be sent to the executor.

Responses

Request samples

Content type
application/json
{}

Response samples

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

/Delete

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

Request Body schema: application/json
Array of PydanticDocument (objects) or object (Data)

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

targetExecutor
string (Targetexecutor)

A regex string representing the specific pods/deployments targeted by the request.

parameters
object (Parameters)

A dictionary of parameters to be sent to the executor.

Responses

Request samples

Content type
application/json
{}

Response samples

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

/Update

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

Request Body schema: application/json
Array of PydanticDocument (objects) or object (Data)

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

targetExecutor
string (Targetexecutor)

A regex string representing the specific pods/deployments targeted by the request.

parameters
object (Parameters)

A dictionary of parameters to be sent to the executor.

Responses

Request samples

Content type
application/json
{}

Response samples

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

Get the readiness of Jina Flow service, sends an empty DocumentArray to the complete Flow to validate connectivity

Get the health of the complete Flow service. .. # noqa: DAR201

Responses

Request samples 

curl --request GET \
  --url 'http://localhost/:[62488]/dry_run'

Response samples

Content type
application/json
{
  • "code": 0,
  • "description": "",
  • "exception": {
    }
}

Post

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 PydanticDocument (objects) or object (Data)

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

targetExecutor
string (Targetexecutor)

A regex string representing the specific pods/deployments targeted by the request.

parameters
object (Parameters)

A dictionary of parameters to be sent to the executor.

execEndpoint
string (Execendpoint)
Default: "/"

The endpoint string, by convention starts with /. If you specify it as /foo, then all executors bind with @requests(on="/foo") will receive the request.

Responses

Request samples

Content type
application/json
{}

Response samples

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