/deterministic

Identifies and extracts named entities from the text.

POST https://zero-shot-ner.p.rapidapi.com/ner/deterministic

The "Deterministic" endpoint of our NER API employs a rule-based approach for recognizing and classifying entities according to predefined labels set by the user. It excels in scenarios demanding high recall and deterministic outputs, ensuring consistent results and providing additional information such as the entity’s location in the text and a confidence score for each identified entity.

Headers

Name	Type	Description
X-RapidAPI-Key*	String	Your API key. Where can I get it?
X-RapidAPI-Host*	String	zero-shot-ner.p.rapidapi.com
content-type*	String	application/json

Request Body

Name	Type	Description
text*	String	Text for processing.
labels*	String array	Types of entities you wish to identify and classify in the provided text.
all	Boolean	This parameter controls the number of entities included in the response. In most cases, the best results are achieved by including only the target entities. However, if necessary, the parameter can be set to true and more entities will be included. The default value is set to false. Ignored if entities provided.
scorer	Boolean	If set to true, the response will contain probability scores for each entity. The default value is set to false.
demojize	Boolean	Converting emoji to string.
threshold	Float	Threshold of scores.
entities	Object array	Define what specific entities will be processed, and others will be skipped.

200: OK Request is successful.

The model has successfully analyzed the input text and labels. Explore further response details.

400: Bad Request Invalid or incomplete request.

This may be due to missing or improperly formatted parameters. Check for parameter type mismatches, Invalid characters or bad code formatting. Refer to this example request for guidance.

401: Unauthorized Invalid authorization.

Your request lacks proper authorization. Ensure your RapidAPI key is correct and included in the request headers. See authorization guidelines.

404: Not Found Invalid payload or header.

Check for parameter type mismatches, Invalid characters or bad code formatting. The required header might be wrong, such as X-RapidAPI-Host. Refer to this example request for guidance.

413: Payload Too Large Payload size exceeded.

You've gone over the 15 KB limit with your submitted data. Please see our limits page for proper API request sizes. If you need to increase your limit, our support team is here to help.

500: Internal Server Error Internal server error.

An unexpected issue occurred on our end. We are notified and investigating. If this issue persists or follows a pattern, please contact our support. Join our Discord for support.