GoodMem
ReferenceClient SDKsPython SDKRequests

RerankerCreationRequest

RerankerCreationRequest documentation for Python SDK

Request body for creating a new Reranker. A Reranker represents a configuration for reranking search results.

Properties

NameTypeDescriptionNotes
validateobject[optional]
display_namestrUser-facing name of the reranker
descriptionstrDescription of the reranker[optional]
provider_typeProviderType
endpoint_urlstrAPI endpoint URL
api_pathstrAPI path for reranking request (defaults to /rerank if not provided)[optional]
model_identifierstrModel identifier
supported_modalitiesList[Modality]Supported content modalities (defaults to TEXT if not provided)[optional]
credentialsEndpointAuthentication[optional]
labelsDict[str, str]User-defined labels for categorization[optional]
versionstrVersion information[optional]
monitoring_endpointstrMonitoring endpoint URL[optional]
owner_idstrOptional owner ID. If not provided, derived from the authentication context. Requires CREATE_RERANKER_ANY permission if specified.[optional]

Example

from goodmem_client.models.reranker_creation_request import RerankerCreationRequest

# TODO update the JSON string below
json = "{}"
# create an instance of RerankerCreationRequest from a JSON string
reranker_creation_request_instance = RerankerCreationRequest.from_json(json)
# print the JSON string representation of the object
print(RerankerCreationRequest.to_json())

# convert the object into a dict
reranker_creation_request_dict = reranker_creation_request_instance.to_dict()
# create an instance of RerankerCreationRequest from a dict
reranker_creation_request_from_dict = RerankerCreationRequest.from_dict(reranker_creation_request_dict)

↑ Back to Python SDK ↑ Back to Python SDK ↑ Back to Python SDK

On this page