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.
Debugging interface. In production, you should hide them by setting --no-debug-endpoints
in Flow
/Gateway
.
Get the status of this Jina service.
This is equivalent to running jina -vf
from command line.
.. # noqa: DAR201
curl --request GET \ --url 'http://localhost/:[62488]/status'
{- "jina": { },
- "envs": { }
}
CRUD interface. If your service does not implement those interfaces, you can should hide them by setting --no-crud-endpoints
in Flow
/Gateway
.
Post data requests to the Flow. Executors with @requests(on="/index")
will respond.
Array of PydanticDocument (objects) or object (Data) Data to send, a list of dict/string/bytes that can be converted into a list of | |
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. |
{- "targetExecutor": "",
- "parameters": { }
}
{- "header": {
- "requestId": "",
- "status": {
- "code": 0,
- "description": "",
- "exception": {
- "name": "",
- "args": [ ],
- "stacks": [ ],
- "executor": ""
}
}, - "execEndpoint": "",
- "targetExecutor": "",
- "timeout": 0
}, - "parameters": { },
- "routes": [
- {
- "executor": "",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "status": {
- "code": 0,
- "description": "",
- "exception": {
- "name": "",
- "args": [ ],
- "stacks": [ ],
- "executor": ""
}
}
}
], - "data": [
- {
- "id": "string",
- "parent_id": "string",
- "granularity": 0,
- "adjacency": 0,
- "blob": "string",
- "tensor": null,
- "mime_type": "string",
- "text": "string",
- "weight": 0,
- "uri": "string",
- "tags": {
- "property1": true,
- "property2": true
}, - "offset": 0,
- "location": [
- 0
], - "embedding": null,
- "modality": "string",
- "evaluations": {
- "property1": {
- "value": 0,
- "op_name": "string",
- "description": "string",
- "ref_id": "string"
}, - "property2": {
- "value": 0,
- "op_name": "string",
- "description": "string",
- "ref_id": "string"
}
}, - "scores": {
- "property1": {
- "value": 0,
- "op_name": "string",
- "description": "string",
- "ref_id": "string"
}, - "property2": {
- "value": 0,
- "op_name": "string",
- "description": "string",
- "ref_id": "string"
}
}, - "chunks": [
- { }
], - "matches": [
- { }
]
}
]
}
Post data requests to the Flow. Executors with @requests(on="/search")
will respond.
Array of PydanticDocument (objects) or object (Data) Data to send, a list of dict/string/bytes that can be converted into a list of | |
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. |
{- "targetExecutor": "",
- "parameters": { }
}
{- "header": {
- "requestId": "",
- "status": {
- "code": 0,
- "description": "",
- "exception": {
- "name": "",
- "args": [ ],
- "stacks": [ ],
- "executor": ""
}
}, - "execEndpoint": "",
- "targetExecutor": "",
- "timeout": 0
}, - "parameters": { },
- "routes": [
- {
- "executor": "",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "status": {
- "code": 0,
- "description": "",
- "exception": {
- "name": "",
- "args": [ ],
- "stacks": [ ],
- "executor": ""
}
}
}
], - "data": [
- {
- "id": "string",
- "parent_id": "string",
- "granularity": 0,
- "adjacency": 0,
- "blob": "string",
- "tensor": null,
- "mime_type": "string",
- "text": "string",
- "weight": 0,
- "uri": "string",
- "tags": {
- "property1": true,
- "property2": true
}, - "offset": 0,
- "location": [
- 0
], - "embedding": null,
- "modality": "string",
- "evaluations": {
- "property1": {
- "value": 0,
- "op_name": "string",
- "description": "string",
- "ref_id": "string"
}, - "property2": {
- "value": 0,
- "op_name": "string",
- "description": "string",
- "ref_id": "string"
}
}, - "scores": {
- "property1": {
- "value": 0,
- "op_name": "string",
- "description": "string",
- "ref_id": "string"
}, - "property2": {
- "value": 0,
- "op_name": "string",
- "description": "string",
- "ref_id": "string"
}
}, - "chunks": [
- { }
], - "matches": [
- { }
]
}
]
}