Skip to content

sentiment_drivers.md

Latest commit

 

History

History
37 lines (22 loc) · 1.16 KB

sentiment_drivers.md

File metadata and controls

37 lines (22 loc) · 1.16 KB
Raw

Sentiment drivers

This page documents the sentiment analysis plugin in fp_perception_driver_sentiment.

SentimentDriver

Class: fp_perception::SentimentDriver (REST-based sentiment inference)

What it does

  • Accepts sentiment_request via analyze().
  • Sends a JSON request to the configured endpoint (Hugging Face style: inputs: <text>).
  • Parses a Hugging Face-style response and returns (label, score) in sentiment_result.

Parameters

  • driver.sentiment.SentimentDriver.name (string)

REST base parameters:

  • driver.sentiment.SentimentDriver.rest.uri
  • driver.sentiment.SentimentDriver.rest.method
  • driver.sentiment.SentimentDriver.rest.ssl_verify
  • driver.sentiment.SentimentDriver.rest.auth_type

Environment:

  • Requires HUGGINGFACE_API_KEY to be set.

Usage with the server

  • The server offers fp_perception_msgs/srv/PerceptionSentiment.
  • If use_device_audio=true, the server transcribes device audio first and then runs sentiment on the transcription.
  • Otherwise, it runs sentiment directly on the request text.
  • If use_diagnostics=true, the driver publishes request health on /diagnostics via diagnostic_updater.