Aller au contenu principal

Connections

Choisissez votre langage :

A connection describes how Mankinds calls a system endpoint.

client.connections.create(systemId, ...)

Create a callable target connection for a system.

SDKclient.connections.create(system_id, config, name="Default", is_default=True, idempotency_key=None)
RetourneSystemConnection

Parameters:

EmplacementParamètreTypeRequisDescription
Pathsystem_idstringRequisSystem UUID.
BodynamestringRequisConnection name, 1 to 120 characters.
BodyconfigSystemEndpointConfigRequisEndpoint call configuration.
Bodyis_defaultbooleanOptionnelWhether this connection becomes the default connection. JavaScript leaves it false when omitted; Python sends true by default.
SDK optionidempotency_keystringOptionnelSent as the Idempotency-Key header.

Endpoint config fields:

FieldTypeDescription
connector_typestringConnector implementation, for example custom_api.
urlstringTarget endpoint URL.
methodstringHTTP method. Default is POST.
headersobjectRequest headers. Sensitive values are redacted when read back.
bodyobjectRequest body template.
input_pathstringField used to inject the test input.
output_pathstringField used to read the model response.
response_bodyobjectOptional response body configuration.
streamingobjectStreaming configuration.
multiturnobjectMulti-turn/session configuration.
sessionobjectSession handling configuration.
configobjectConnector-specific configuration.
provider_configobjectProvider-specific configuration.

In JavaScript, passing a raw endpoint config instead of { name, config } creates a connection named Default and sets it as default.

client.connections.list(systemId)

List all connections for a system.

SDKclient.connections.list(system_id)
RetourneSystemConnection[]

Parameters:

EmplacementParamètreTypeRequisDescription
Pathsystem_idstringRequisSystem UUID.

client.connections.test(connectionId)

Test whether a connection can be called by Mankinds.

SDKclient.connections.test(connection_id)
RetourneConnectionTestResult

Parameters:

EmplacementParamètreTypeRequisDescription
Pathconnection_idstringRequisConnection UUID.

client.connections.setDefault(connectionId)

Set one connection as the system default.

SDKclient.connections.set_default(connection_id)
RetourneSystemConnection

Parameters:

EmplacementParamètreTypeRequisDescription
Pathconnection_idstringRequisConnection UUID.