Jina (1.1.5)

Download OpenAPI specification:Download

REST interface for Jina

jina

Get the status of Jina

Responses

Request samples

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

Response samples

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

Api Deprecated

Request mode service and return results in JSON, a deprecated interface.

:param mode: INDEX, SEARCH, DELETE, UPDATE, CONTROL, TRAIN. :param body: Request body. :return: Results in JSONresponse.

path Parameters
mode
required
string (Mode)
Request Body schema: application/json
any (Body)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
null

Reload the executor of certain Peas/Pods in the Flow

Reload the executor of certain peas/pods in the Flow

:param body: reload request. :return: Response of the results.

Request Body schema: application/json
required
string or Array of strings (Targets)

Responses

Request samples

Content type
application/json
{
  • "targets": "string"
}

Response samples

Content type
application/json
null

CRUD

Index documents into Jina

Index API to index documents.

:param body: index request. :return: Response of the results.

Request Body schema: application/json
required
Array of DocumentProto (objects) or Array of objects or Array of strings or Array of strings (Data)
request_size
integer (Request Size)
Default: 100
mime_type
string (Mime Type)
Default: ""
Array of objects (Queryset)
data_type
integer
Default: 0
Enum: 0 1 2

Data input type in the request generator.

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "request_size": 100,
  • "mime_type": "",
  • "queryset": [
    ],
  • "data_type": 0
}

Response samples

Content type
application/json
null

Search documents from Jina

Search API to search documents.

:param body: search request. :return: Response of the results.

Request Body schema: application/json
required
Array of DocumentProto (objects) or Array of objects or Array of strings or Array of strings (Data)
request_size
integer (Request Size)
Default: 100
mime_type
string (Mime Type)
Default: ""
Array of objects (Queryset)
data_type
integer
Default: 0
Enum: 0 1 2

Data input type in the request generator.

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "request_size": 100,
  • "mime_type": "",
  • "queryset": [
    ],
  • "data_type": 0
}

Response samples

Content type
application/json
null

Update documents in Jina

Update API to update documents.

:param body: update request. :return: Response of the results.

Request Body schema: application/json
required
Array of DocumentProto (objects) or Array of objects or Array of strings or Array of strings (Data)
request_size
integer (Request Size)
Default: 100
mime_type
string (Mime Type)
Default: ""
Array of objects (Queryset)
data_type
integer
Default: 0
Enum: 0 1 2

Data input type in the request generator.

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "request_size": 100,
  • "mime_type": "",
  • "queryset": [
    ],
  • "data_type": 0
}

Response samples

Content type
application/json
null

Delete documents in Jina

Delete API to delete documents.

:param body: delete request. :return: Response of the results.

Request Body schema: application/json
data
required
Array of strings (Data)
request_size
integer (Request Size)
Default: 100
mime_type
string (Mime Type)
Default: ""
Array of objects (Queryset)
data_type
integer
Default: 0
Enum: 0 1 2

Data input type in the request generator.

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "request_size": 100,
  • "mime_type": "",
  • "queryset": [
    ],
  • "data_type": 0
}

Response samples

Content type
application/json
null