> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Detect Sentiment > Detect the sentiment of a (reasonably short) text. Sentiment analysis may cause a translation to be made, since sentiment analysis only supports a limited set of languages NsApiSlow threshold: 2000 ms. ## Experimental: ## The AI agent is experimental, subject to change, and not intended for partners. ## OpenAPI ````yaml /openapi/agent/openapi-v3-AIAgent.json post /api/v1/Agents/AI/DetectSentiment openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - AIAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/AI/DetectSentiment: post: tags: - AI_Agent summary: Detect Sentiment description: "Detect the sentiment of a (reasonably short) text.\n\nSentiment analysis may cause a translation to be made, since sentiment analysis only supports a limited set of languages\r\nNsApiSlow threshold: 2000 ms.\r\n## Experimental: ## The AI agent is experimental, subject to change, and not intended for partners." operationId: v1AIAgent_DetectSentiment parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.DetectSentimentRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.DetectSentimentRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.DetectSentimentRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.DetectSentimentRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.DetectSentimentRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.DetectSentimentRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.DetectSentimentRequest description: Text required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.Sentiment' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.Sentiment' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.Sentiment' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.Sentiment' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.Sentiment' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.Sentiment' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.AICarriers.DetectSentimentRequest: description: >- DetectSentiment: Detect the sentiment of a (reasonably short) text. Sentiment analysis may cause a translation to be made, since sentiment analysis only supports a limited set of languages type: object properties: Text: type: string SuperOffice.CRM.Services.Sentiment: description: "Sentiment information: Score (-100 to 100) and Confidence (0 to 100)\r\n\r\nCarrier object for Sentiment.\r\nServices for the Sentiment Carrier is available from the AI Agent." type: object properties: Score: format: int32 description: >- Sentiment score, -100 = very unhappy, 100 = very happy, 0 = no idea (not recognized) type: integer Confidence: format: int32 description: >- Sentiment analysis confidence, where available. 0 = no idea, 100 = perfectly confident, -1 = no confidence score available type: integer TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [SuperOffice.WebApi.Data.AI DetectSentimentRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.AI_DetectSentimentRequest.md) - [NSAIAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSAIAgent.md) - [SuperOffice.WebApi.Agents.AIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AIAgent.md) - [SuperOffice.WebApi.Agents.IAIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAIAgent.md) - [sentiment](/en/api/mdo-providers/reference/sentiment.md) - [Summaries](/integrations/supernotes/summaries.md)