{"items":[{"type":"link","label":"Overview","link":"/apis/tisane-api-short","routeSlug":"/apis/tisane-api-short","content":{"contentType":"overview","meta":{"name":"Overview"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"tisane-api-short.json","url":"/_bundle/apis/tisane-api-short.json?download"},{"kind":"download","label":"tisane-api-short.yaml","url":"/_bundle/apis/tisane-api-short.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Overview (4.8.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This reference describes RESTful web methods for interacting with Tisane API using standard HTTP and JSON-based communication."}],"sectionId":"/apis/tisane-api-short"}],"sectionId":"/apis/tisane-api-short"}]}]}},{"type":"group","label":"NLU / NLP Methods","link":"/apis/tisane-api-short/nlu-nlp-methods","routeSlug":"/apis/tisane-api-short/nlu-nlp-methods","items":[{"label":"Analyze text","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/tisane-api-short/nlu-nlp-methods/parse","routeSlug":"/apis/tisane-api-short/nlu-nlp-methods/parse","metadata":{"seo":{"title":"Analyze text","description":"The method analyzes the input and detects problematic content, sentiment snippets, entities, topics, phrase structure, parts of speech, stopwords, and more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"parse","name":"Analyze text","isWebhook":false,"pointer":"/paths/~1parse/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Analyze text","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method analyzes the input and detects problematic content, sentiment snippets, entities, topics, phrase structure, parts of speech, stopwords, and more."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Tisane-API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"Ocp-Apim-Subscription-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API subscription key (primary or secondary) from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.tisane.ai/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane Developer Portal"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_36","example":"application/json"}],"pointer":"/paths/~1parse/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_37","exampleIds":["paths/~1parse/post/requestBody/content/application~1json/examples/Hello Tisane","paths/~1parse/post/requestBody/content/application~1json/examples/Abuse detection","paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (native standard)","paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (IAB standard)","paths/~1parse/post/requestBody/content/application~1json/examples/Adverse media monitoring in fintech","paths/~1parse/post/requestBody/content/application~1json/examples/Parse alias w~1 sentence structure","paths/~1parse/post/requestBody/content/application~1json/examples/Parse hashtag and output words"]}},"schemaId":"schema_37","exampleIds":["paths/~1parse/post/requestBody/content/application~1json/examples/Hello Tisane","paths/~1parse/post/requestBody/content/application~1json/examples/Abuse detection","paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (native standard)","paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (IAB standard)","paths/~1parse/post/requestBody/content/application~1json/examples/Adverse media monitoring in fintech","paths/~1parse/post/requestBody/content/application~1json/examples/Parse alias w~1 sentence structure","paths/~1parse/post/requestBody/content/application~1json/examples/Parse hashtag and output words"],"pointer":"/paths/~1parse/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/parse","servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_36"}],"cookie":[]},"security":[{"schemes":[{"id":"Tisane-API-Key","type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_37","exampleIds":["paths/~1parse/post/requestBody/content/application~1json/examples/Hello Tisane","paths/~1parse/post/requestBody/content/application~1json/examples/Abuse detection","paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (native standard)","paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (IAB standard)","paths/~1parse/post/requestBody/content/application~1json/examples/Adverse media monitoring in fintech","paths/~1parse/post/requestBody/content/application~1json/examples/Parse alias w~1 sentence structure","paths/~1parse/post/requestBody/content/application~1json/examples/Parse hashtag and output words"]}},"responseCodes":["200","400","401","500"],"pointer":"/parse","href":"nlu-nlp-methods/parse","openApiOperationId":"parse","summary":"Analyze text"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"schemaId":"schema_37","exampleIds":["paths/~1parse/post/requestBody/content/application~1json/examples/Hello Tisane","paths/~1parse/post/requestBody/content/application~1json/examples/Abuse detection","paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (native standard)","paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (IAB standard)","paths/~1parse/post/requestBody/content/application~1json/examples/Adverse media monitoring in fintech","paths/~1parse/post/requestBody/content/application~1json/examples/Parse alias w~1 sentence structure","paths/~1parse/post/requestBody/content/application~1json/examples/Parse hashtag and output words"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_37","exampleIds":["paths/~1parse/post/requestBody/content/application~1json/examples/Hello Tisane","paths/~1parse/post/requestBody/content/application~1json/examples/Abuse detection","paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (native standard)","paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (IAB standard)","paths/~1parse/post/requestBody/content/application~1json/examples/Adverse media monitoring in fintech","paths/~1parse/post/requestBody/content/application~1json/examples/Parse alias w~1 sentence structure","paths/~1parse/post/requestBody/content/application~1json/examples/Parse hashtag and output words"]}},"examples":[{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1parse/post/responses/200/content/application~1json/examples/Hello Tisane","paths/~1parse/post/responses/200/content/application~1json/examples/Abuse detection","paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (native standard)","paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (IAB standard)","paths/~1parse/post/responses/200/content/application~1json/examples/Adverse media monitoring in fintech","paths/~1parse/post/responses/200/content/application~1json/examples/Parse alias w~1 sentence structure","paths/~1parse/post/responses/200/content/application~1json/examples/Parse hashtag and output words"]}},"schemaId":"schema_38","exampleIds":["paths/~1parse/post/responses/200/content/application~1json/examples/Hello Tisane","paths/~1parse/post/responses/200/content/application~1json/examples/Abuse detection","paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (native standard)","paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (IAB standard)","paths/~1parse/post/responses/200/content/application~1json/examples/Adverse media monitoring in fintech","paths/~1parse/post/responses/200/content/application~1json/examples/Parse alias w~1 sentence structure","paths/~1parse/post/responses/200/content/application~1json/examples/Parse hashtag and output words"]},{"code":"400","description":"Bad request - invalid JSON or language code."},{"code":"401","description":"Unauthorized - invalid API key or quota exceeded."},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1parse/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_38","exampleIds":["paths/~1parse/post/responses/200/content/application~1json/examples/Hello Tisane","paths/~1parse/post/responses/200/content/application~1json/examples/Abuse detection","paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (native standard)","paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (IAB standard)","paths/~1parse/post/responses/200/content/application~1json/examples/Adverse media monitoring in fintech","paths/~1parse/post/responses/200/content/application~1json/examples/Parse alias w~1 sentence structure","paths/~1parse/post/responses/200/content/application~1json/examples/Parse hashtag and output words"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1parse/post/responses/200/content/application~1json/examples/Hello Tisane","paths/~1parse/post/responses/200/content/application~1json/examples/Abuse detection","paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (native standard)","paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (IAB standard)","paths/~1parse/post/responses/200/content/application~1json/examples/Adverse media monitoring in fintech","paths/~1parse/post/responses/200/content/application~1json/examples/Parse alias w~1 sentence structure","paths/~1parse/post/responses/200/content/application~1json/examples/Parse hashtag and output words"]}}},{"code":"400"},{"code":"401"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nlu-nlp-methods/parse"}],"panels":[]}]},"httpPath":"/parse"},{"label":"List available languages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/tisane-api-short/nlu-nlp-methods/languages","routeSlug":"/apis/tisane-api-short/nlu-nlp-methods/languages","metadata":{"seo":{"title":"List available languages","description":"Retrieve a list of supported languages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"languages","name":"List available languages","isWebhook":false,"pointer":"/paths/~1languages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available languages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a list of supported languages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes the following attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Language ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Native name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"englishName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - English name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nativeEncoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Encoding of the language."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preferredFont"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Recommended font for display."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Whether the language uses Latin script."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rightToLeft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Whether the language uses right-to-left script (e.g., Arabic, Hebrew, Persian)."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Tisane-API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"Ocp-Apim-Subscription-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API subscription key (primary or secondary) from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.tisane.ai/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane Developer Portal"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_36","example":"application/json"}],"pointer":"/paths/~1languages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/languages","servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_36"}],"cookie":[]},"security":[{"schemes":[{"id":"Tisane-API-Key","type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/languages","href":"nlu-nlp-methods/languages","openApiOperationId":"languages","summary":"List available languages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/~1languages/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_39","exampleIds":["paths/~1languages/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1languages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_39","exampleIds":["paths/~1languages/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/~1languages/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nlu-nlp-methods/languages"}],"panels":[]}]},"httpPath":"/languages"},{"label":"Text clean-up","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/tisane-api-short/nlu-nlp-methods/extract_text","routeSlug":"/apis/tisane-api-short/nlu-nlp-methods/extract_text","metadata":{"seo":{"title":"Text clean-up","description":"A service method to remove JavaScript, CSS tags, JSON, and other markup, returning pure decoded text.The request body includes the markup content from which text will be extracted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"extract_text","name":"Text clean-up","isWebhook":false,"pointer":"/paths/~1helper~1extract_text/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Text clean-up","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A service method to remove JavaScript, CSS tags, JSON, and other markup, returning pure decoded text."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body includes the markup content from which text will be extracted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This method does not process binary content."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Tisane-API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"Ocp-Apim-Subscription-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API subscription key (primary or secondary) from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.tisane.ai/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane Developer Portal"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_36"}],"pointer":"/paths/~1helper~1extract_text/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"schema_36","exampleIds":["paths/~1helper~1extract_text/post/requestBody/content/text~1plain/example"]}},"schemaId":"schema_36","exampleIds":["paths/~1helper~1extract_text/post/requestBody/content/text~1plain/example"],"pointer":"/paths/~1helper~1extract_text/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/helper/extract_text","servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","schemaId":"schema_36"}],"cookie":[]},"security":[{"schemes":[{"id":"Tisane-API-Key","type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"}],"scopes":[]}],"requestBody":{"text/plain":{"schemaId":"schema_36","exampleIds":["paths/~1helper~1extract_text/post/requestBody/content/text~1plain/example"]}},"responseCodes":["200"],"pointer":"/helper/extract_text","href":"nlu-nlp-methods/extract_text","openApiOperationId":"extract_text","summary":"Text clean-up"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"schemaId":"schema_36","exampleIds":["paths/~1helper~1extract_text/post/requestBody/content/text~1plain/example"],"mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"schema_36","exampleIds":["paths/~1helper~1extract_text/post/requestBody/content/text~1plain/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_36","exampleIds":["paths/~1helper~1extract_text/post/responses/200/content/text~1plain/example"]}},"schemaId":"schema_36","exampleIds":["paths/~1helper~1extract_text/post/responses/200/content/text~1plain/example"]}],"pointer":"/paths/~1helper~1extract_text/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_36","exampleIds":["paths/~1helper~1extract_text/post/responses/200/content/text~1plain/example"],"mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_36","exampleIds":["paths/~1helper~1extract_text/post/responses/200/content/text~1plain/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nlu-nlp-methods/extract_text"}],"panels":[]}]},"httpPath":"/helper/extract_text"},{"label":"Named entity comparison","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/tisane-api-short/nlu-nlp-methods/compareentities","routeSlug":"/apis/tisane-api-short/nlu-nlp-methods/compareentities","metadata":{"seo":{"title":"Named entity comparison","description":"Compares two compound named entities and identifies differences.The request body should include:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compareEntities","name":"Named entity comparison","isWebhook":false,"pointer":"/paths/~1compare~1entities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Named entity comparison","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compares two compound named entities and identifies differences."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body should include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - IETF tag for the first entity's language."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - The first entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - IETF tag for the second entity's language."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - The second entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - The entity type (currently only "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"person"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More information: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/tisane-api-response-guide#named-entities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Named Entities in the Tisane API Response Guide"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - Comparison result:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_single_entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - One or both entities are invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"same"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Entities are identical (name order might differ)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"different"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Entities differ, with details in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"differences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"differences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (array of strings) - Lists detected differences:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"given_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., Mr., Mrs.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"social_role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., academic degrees)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suffix"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"variation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., spelling or style differences)"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Tisane-API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"Ocp-Apim-Subscription-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API subscription key (primary or secondary) from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.tisane.ai/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane Developer Portal"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_36","example":"application/json"}],"pointer":"/paths/~1compare~1entities/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1compare~1entities/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_40","exampleIds":["paths/~1compare~1entities/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1compare~1entities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compare/entities","servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_36"}],"cookie":[]},"security":[{"schemes":[{"id":"Tisane-API-Key","type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1compare~1entities/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/compare/entities","href":"nlu-nlp-methods/compareentities","openApiOperationId":"compareEntities","summary":"Named entity comparison"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"schemaId":"schema_40","exampleIds":["paths/~1compare~1entities/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1compare~1entities/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1compare~1entities/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_40","exampleIds":["paths/~1compare~1entities/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1compare~1entities/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","exampleIds":["paths/~1compare~1entities/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1compare~1entities/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nlu-nlp-methods/compareentities"}],"panels":[]}]},"httpPath":"/compare/entities"},{"label":"Semantic similarity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/tisane-api-short/nlu-nlp-methods/similarity","routeSlug":"/apis/tisane-api-short/nlu-nlp-methods/similarity","metadata":{"seo":{"title":"Semantic similarity","description":"Calculate the semantic similarity between two text fragments, either in the same language or in different languages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"similarity","name":"Semantic similarity","isWebhook":false,"pointer":"/paths/~1similarity/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Semantic similarity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculate the semantic similarity between two text fragments, either in the same language or in different languages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body should contain:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - The first text fragment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - The IETF language code for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - The second text fragment to compare."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - The IETF language code for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (object) - Additional settings as per specifications. More information: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/tisane-api-configuration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane API Configuration And Customization Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response is a number between 0 and 1, representing the similarity of the submitted text fragments."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Tisane-API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"Ocp-Apim-Subscription-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API subscription key (primary or secondary) from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.tisane.ai/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane Developer Portal"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_36","example":"application/json"}],"pointer":"/paths/~1similarity/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1similarity/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_40","exampleIds":["paths/~1similarity/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1similarity/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/similarity","servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_36"}],"cookie":[]},"security":[{"schemes":[{"id":"Tisane-API-Key","type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1similarity/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/similarity","href":"nlu-nlp-methods/similarity","openApiOperationId":"similarity","summary":"Semantic similarity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"schemaId":"schema_40","exampleIds":["paths/~1similarity/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1similarity/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41","exampleIds":["paths/~1similarity/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_41","exampleIds":["paths/~1similarity/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1similarity/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_41","exampleIds":["paths/~1similarity/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41","exampleIds":["paths/~1similarity/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nlu-nlp-methods/similarity"}],"panels":[]}]},"httpPath":"/similarity"},{"label":"Detect language","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/tisane-api-short/nlu-nlp-methods/detectlanguage","routeSlug":"/apis/tisane-api-short/nlu-nlp-methods/detectlanguage","metadata":{"seo":{"title":"Detect language","description":"Detects the languages used in the provided text fragment and returns the breakdown by offsets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detectLanguage","name":"Detect language","isWebhook":false,"pointer":"/paths/~1detectLanguage/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detect language","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detects the languages used in the provided text fragment and returns the breakdown by offsets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body should include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - the text fragment to analyze."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"languages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string, optional) - a vertical bar-delimited list of language codes to use as cues."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delimiter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string, optional) - a regular expression for segmenting the fragment; by default, the fragment is not segmented."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response is a JSON structure containing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"languages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which provides a breakdown of language codes."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Tisane-API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"Ocp-Apim-Subscription-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API subscription key (primary or secondary) from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.tisane.ai/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane Developer Portal"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_36","example":"application/json"}],"pointer":"/paths/~1detectLanguage/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_42","exampleIds":["paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Basic","paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Hints for ambiguous cases","paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Breakdown of languages segmenting by line"]}},"schemaId":"schema_42","exampleIds":["paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Basic","paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Hints for ambiguous cases","paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Breakdown of languages segmenting by line"],"pointer":"/paths/~1detectLanguage/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/detectLanguage","servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_36"}],"cookie":[]},"security":[{"schemes":[{"id":"Tisane-API-Key","type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_42","exampleIds":["paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Basic","paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Hints for ambiguous cases","paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Breakdown of languages segmenting by line"]}},"responseCodes":["200"],"pointer":"/detectLanguage","href":"nlu-nlp-methods/detectlanguage","openApiOperationId":"detectLanguage","summary":"Detect language"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"schemaId":"schema_42","exampleIds":["paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Basic","paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Hints for ambiguous cases","paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Breakdown of languages segmenting by line"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_42","exampleIds":["paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Basic","paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Hints for ambiguous cases","paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Breakdown of languages segmenting by line"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Basic","paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Hints for ambiguous cases","paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Breakdown of languages segmenting by line"]}},"schemaId":"schema_40","exampleIds":["paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Basic","paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Hints for ambiguous cases","paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Breakdown of languages segmenting by line"]}],"pointer":"/paths/~1detectLanguage/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","exampleIds":["paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Basic","paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Hints for ambiguous cases","paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Breakdown of languages segmenting by line"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Basic","paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Hints for ambiguous cases","paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Breakdown of languages segmenting by line"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nlu-nlp-methods/detectlanguage"}],"panels":[]}]},"httpPath":"/detectLanguage"},{"label":"Translate text","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/tisane-api-short/nlu-nlp-methods/transform","routeSlug":"/apis/tisane-api-short/nlu-nlp-methods/transform","metadata":{"seo":{"title":"Translate text","description":"This method translates the input text.The request body should include the following elements:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transform","name":"Translate text","isWebhook":false,"pointer":"/paths/~1transform/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Translate text","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method translates the input text."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body should include the following elements:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - A standard IETF tag for the source language. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a vertical bar-delimited set of language codes to invoke autodetect."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - A standard IETF tag for the target language. If the source and target languages are the same, paraphrasing will be applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - The text content to translate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (object) - Additional translation settings."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More information: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/tisane-api-configuration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane API Configuration And Customization Guide"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response is the transformed text."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Tisane-API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"Ocp-Apim-Subscription-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API subscription key (primary or secondary) from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.tisane.ai/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane Developer Portal"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_36","example":"application/json"}],"pointer":"/paths/~1transform/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43","exampleIds":["paths/~1transform/post/requestBody/content/application~1json/examples/Translate a Japanese sentence","paths/~1transform/post/requestBody/content/application~1json/examples/Auto-detect language and translate Chinese name to English","paths/~1transform/post/requestBody/content/application~1json/examples/Translate from English to Russian","paths/~1transform/post/requestBody/content/application~1json/examples/Translate Russian drug addict jargon to English","paths/~1transform/post/requestBody/content/application~1json/examples/Translate from Hebrew to Russian preserving gender"]}},"schemaId":"schema_43","exampleIds":["paths/~1transform/post/requestBody/content/application~1json/examples/Translate a Japanese sentence","paths/~1transform/post/requestBody/content/application~1json/examples/Auto-detect language and translate Chinese name to English","paths/~1transform/post/requestBody/content/application~1json/examples/Translate from English to Russian","paths/~1transform/post/requestBody/content/application~1json/examples/Translate Russian drug addict jargon to English","paths/~1transform/post/requestBody/content/application~1json/examples/Translate from Hebrew to Russian preserving gender"],"pointer":"/paths/~1transform/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transform","servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_36"}],"cookie":[]},"security":[{"schemes":[{"id":"Tisane-API-Key","type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_43","exampleIds":["paths/~1transform/post/requestBody/content/application~1json/examples/Translate a Japanese sentence","paths/~1transform/post/requestBody/content/application~1json/examples/Auto-detect language and translate Chinese name to English","paths/~1transform/post/requestBody/content/application~1json/examples/Translate from English to Russian","paths/~1transform/post/requestBody/content/application~1json/examples/Translate Russian drug addict jargon to English","paths/~1transform/post/requestBody/content/application~1json/examples/Translate from Hebrew to Russian preserving gender"]}},"responseCodes":["200","400","401","500"],"pointer":"/transform","href":"nlu-nlp-methods/transform","openApiOperationId":"transform","summary":"Translate text"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"schemaId":"schema_43","exampleIds":["paths/~1transform/post/requestBody/content/application~1json/examples/Translate a Japanese sentence","paths/~1transform/post/requestBody/content/application~1json/examples/Auto-detect language and translate Chinese name to English","paths/~1transform/post/requestBody/content/application~1json/examples/Translate from English to Russian","paths/~1transform/post/requestBody/content/application~1json/examples/Translate Russian drug addict jargon to English","paths/~1transform/post/requestBody/content/application~1json/examples/Translate from Hebrew to Russian preserving gender"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43","exampleIds":["paths/~1transform/post/requestBody/content/application~1json/examples/Translate a Japanese sentence","paths/~1transform/post/requestBody/content/application~1json/examples/Auto-detect language and translate Chinese name to English","paths/~1transform/post/requestBody/content/application~1json/examples/Translate from English to Russian","paths/~1transform/post/requestBody/content/application~1json/examples/Translate Russian drug addict jargon to English","paths/~1transform/post/requestBody/content/application~1json/examples/Translate from Hebrew to Russian preserving gender"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful translation response","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_36","exampleIds":["paths/~1transform/post/responses/200/content/text~1plain/examples/Translate a Japanese sentence","paths/~1transform/post/responses/200/content/text~1plain/examples/Auto-detect language and translate Chinese name to English","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from English to Russian","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate Russian drug addict jargon to English","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from Hebrew to Russian preserving gender"]}},"schemaId":"schema_36","exampleIds":["paths/~1transform/post/responses/200/content/text~1plain/examples/Translate a Japanese sentence","paths/~1transform/post/responses/200/content/text~1plain/examples/Auto-detect language and translate Chinese name to English","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from English to Russian","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate Russian drug addict jargon to English","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from Hebrew to Russian preserving gender"]},{"code":"400","description":"Bad request - invalid JSON or language code."},{"code":"401","description":"Unauthorized - invalid API key or quota exceeded."},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1transform/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_36","exampleIds":["paths/~1transform/post/responses/200/content/text~1plain/examples/Translate a Japanese sentence","paths/~1transform/post/responses/200/content/text~1plain/examples/Auto-detect language and translate Chinese name to English","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from English to Russian","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate Russian drug addict jargon to English","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from Hebrew to Russian preserving gender"],"mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_36","exampleIds":["paths/~1transform/post/responses/200/content/text~1plain/examples/Translate a Japanese sentence","paths/~1transform/post/responses/200/content/text~1plain/examples/Auto-detect language and translate Chinese name to English","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from English to Russian","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate Russian drug addict jargon to English","paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from Hebrew to Russian preserving gender"]}}},{"code":"400"},{"code":"401"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nlu-nlp-methods/transform"}],"panels":[]}]},"httpPath":"/transform"}],"content":{"contentType":"group","meta":{"name":"NLU / NLP Methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NLU / NLP Methods","showPageActions":true},{"nodeType":"markdoc","content":"These are the methods that actually perform analysis and transformation of input text."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/parse","summary":"Analyze text","prefix":{"name":"post","color":"post"},"badges":[],"link":"/nlu-nlp-methods/parse","deprecated":false},{"title":"/languages","summary":"List available languages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/nlu-nlp-methods/languages","deprecated":false},{"title":"/helper/extract_text","summary":"Text clean-up","prefix":{"name":"post","color":"post"},"badges":[],"link":"/nlu-nlp-methods/extract_text","deprecated":false},{"title":"/compare/entities","summary":"Named entity comparison","prefix":{"name":"post","color":"post"},"badges":[],"link":"/nlu-nlp-methods/compareentities","deprecated":false},{"title":"/similarity","summary":"Semantic similarity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/nlu-nlp-methods/similarity","deprecated":false},{"title":"/detectLanguage","summary":"Detect language","prefix":{"name":"post","color":"post"},"badges":[],"link":"/nlu-nlp-methods/detectlanguage","deprecated":false},{"title":"/transform","summary":"Translate text","prefix":{"name":"post","color":"post"},"badges":[],"link":"/nlu-nlp-methods/transform","deprecated":false}]}]}]}]}},{"type":"group","label":"Language Model Direct Access","link":"/apis/tisane-api-short/language-model-direct-access","routeSlug":"/apis/tisane-api-short/language-model-direct-access","items":[{"label":"List inflected forms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/tisane-api-short/language-model-direct-access/inflections","routeSlug":"/apis/tisane-api-short/language-model-direct-access/inflections","metadata":{"seo":{"title":"List inflected forms","description":"Retrieves inflected forms of a specified lexeme within a given language family."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"inflections","name":"List inflected forms","isWebhook":false,"pointer":"/paths/~1lm~1inflections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List inflected forms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves inflected forms of a specified lexeme within a given language family."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Tisane-API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"Ocp-Apim-Subscription-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API subscription key (primary or secondary) from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.tisane.ai/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane Developer Portal"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_36","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code of a language in Tisane. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"en"},{"name":"lexeme","in":"query","schemaId":"schema_36","description":"The ID of a lexeme to inspect. ","required":true,"example":3130180},{"name":"family","in":"query","schemaId":"schema_36","description":"The ID of a family to inspect. ","required":true,"example":58443}],"pointer":"/paths/~1lm~1inflections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lm/inflections","servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"parameters":{"path":[],"query":[{"name":"language","in":"query","required":true,"example":"en","schemaId":"schema_36"},{"name":"lexeme","in":"query","required":true,"example":3130180,"schemaId":"schema_36"},{"name":"family","in":"query","required":true,"example":58443,"schemaId":"schema_36"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Tisane-API-Key","type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/lm/inflections","href":"language-model-direct-access/inflections","openApiOperationId":"inflections","summary":"List inflected forms"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44","exampleIds":["paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"buy\" in English","paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"United States\" in Russian"]}},"schemaId":"schema_44","exampleIds":["paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"buy\" in English","paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"United States\" in Russian"]}],"pointer":"/paths/~1lm~1inflections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_44","exampleIds":["paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"buy\" in English","paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"United States\" in Russian"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44","exampleIds":["paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"buy\" in English","paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"United States\" in Russian"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/language-model-direct-access/inflections"}],"panels":[]}]},"httpPath":"/lm/inflections"}],"content":{"contentType":"group","meta":{"name":"Language Model Direct Access"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Language Model Direct Access","showPageActions":true},{"nodeType":"markdoc","content":"Methods to retrieve and inspect entries from the language models."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/lm/inflections","summary":"List inflected forms","prefix":{"name":"get","color":"get"},"badges":[],"link":"/language-model-direct-access/inflections","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Feature":{"id":"components/schemas/Feature","kind":"json-schema","title":"Feature","data":{"type":"object","required":["index","value"],"properties":{"type":{"type":"string","description":"Feature type. If unspecified: Grammar","enum":["Grammar","Semantics","Style"]},"index":{"type":"integer","description":"Feature index (within its type)"},"value":{"type":"string","description":"Feature value ID"}}}},"components/schemas/FeatureArray":{"id":"components/schemas/FeatureArray","kind":"json-schema","title":"FeatureArray","data":{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/Feature"}]}}},"components/schemas/Memory":{"id":"components/schemas/Memory","kind":"json-schema","title":"Memory","data":{"type":"object","properties":{"flags":{"$ref":"#/components/schemas/FeatureArray","description":"Flags and semantic features set."},"antecedents":{"type":"array","description":"Previously mentioned elements to be used for coreference resolution.","items":{"type":"object","properties":{"family":{"type":"integer","description":"The family ID of the antecedent."},"features":{"$ref":"#/components/schemas/FeatureArray"}}}},"assign":{"type":"array","description":"Conditional assignments to be executed when parsing.","items":{"type":"object","required":["if","then"],"properties":{"if":{"type":"object","description":"Conditions to match (all conditions must match).","properties":{"family":{"type":"integer","description":"A family ID of the target lexeme."},"hypernym":{"type":"integer","description":"A family ID of a hypernym of the target lexeme."},"features":{"description":"Features to match.","$ref":"#/components/schemas/FeatureArray"},"regex":{"type":"string","description":"A regular expression to match."}}},"then":{"type":"object","description":"Attribute values to assign.","properties":{"family":{"type":"integer","description":"A family ID to assign."},"hypernym":{"type":"integer","description":"A family ID of a hypernym to assign."},"features":{"description":"Features to assign.","$ref":"#/components/schemas/FeatureArray"},"attribution":{"type":"boolean","description":"Marks the target as attribution."}}}}}}}}},"components/schemas/Phrase":{"id":"components/schemas/Phrase","kind":"json-schema","title":"Phrase","data":{"type":"object","required":["type","family","offset","length","text"],"properties":{"type":{"type":"string","description":"The type of the phrase (NP/VP/ADJP/ADVP/S)."},"family":{"type":"integer","description":"The family ID of the phrase."},"offset":{"type":"integer","description":"The offset where the phrase starts."},"length":{"type":"integer","description":"The length of the phrase string."},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text of the phrase in which members delimited with vertical bars and inner phrases are encapsulated in brackets. For example, "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"I|(love|Lucy)\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"role":{"type":"string","description":"Semantic role of the phrase in the sentence."},"children":{"type":"array","items":{"$ref":"#/components/schemas/Phrase"}}}}},"schema_36":{"kind":"json-schema","data":{"type":"string"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"object","required":["language","content"],"properties":{"language":{"type":"string"},"content":{"type":"string"},"settings":{"type":"object"}}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Input text."},"language":{"type":"string","description":"Language code, when the language identification is used."},"memory":{"$ref":"#/components/schemas/Memory","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state after the analysis. Can be used to set the state of the future analyses. (Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to show.)"},"children":[]}]}]}]},"topics":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["topic","coverage"],"properties":{"topic":{"type":"string"},"coverage":{"type":"number"}}}]}},"abuse":{"type":"array","items":{"type":"object","required":["offset","length","sentence_index","type","severity"],"properties":{"offset":{"type":"integer","description":"0-based location in the sentence"},"length":{"type":"integer","description":"Length of the fragment"},"sentence_index":{"type":"integer","description":"Index of the sentence where the fragment is located"},"type":{"type":"string","description":"Type of the problematic content","enum":["personal_attack","bigotry","external_contact","profanity","sexual_advances","criminal_activity","adult_only","mental_issues","contentious","spam","social_hierarchy","no_meaningful_content","generic"]},"severity":{"type":"string","description":"How severe the issue is","enum":["low","medium","high","extreme"]},"tags":{"type":"array","items":{"type":"string"}},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fragment itself ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"explanation":{"type":"string","description":"Human-readable explanation of the rationale for flagging"}}}},"sentence_list":{"type":"array","items":{"type":"object","required":["offset","text","words","parse_tree"],"properties":{"offset":{"type":"integer","description":"An offset where the sentence starts."},"text":{"type":"string","description":"The sentence itself."},"words":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokenized array of lexical units/lexical chunks (not necessarily by white space or punctuation). Must have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"words"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to appear."},"children":[]}]}]}],"items":{"type":"object","required":["offset","length","type","text"],"properties":{"offset":{"type":"integer","description":"The offset at which the lexical chunk starts."},"length":{"type":"integer","description":"The length of the lexical chunk."},"type":{"type":"string","description":"The type of the lexical chunk.","enum":["word","numeral","punctuation"]},"text":{"type":"string","description":"The lexical chunk string."},"stopword":{"type":"boolean","description":"Whether it's a stopword."},"role":{"type":"string","description":"A semantic role of the word, if assigned.","enum":["agent","patient","complement","circumstance","beneficiary","verb","surname","list_item","given_name","social_role","title","street_name","street_type","nickname","country","settlement","state","zipcode"]},"description":{"type":"string","description":"Description of the disambiguated sense in the current context (always in English)."},"definition":{"type":"string","description":"Dictionary definition of the disambiguated sense in the current context (always in English)."},"wikidata":{"type":"string","description":"A Wikidata ID of the current word-sense, if exists."},"lexeme":{"type":"integer","description":"A unique lexeme identifier."},"family":{"type":"integer","description":"A family identifier."},"grammar":{"$ref":"#/components/schemas/FeatureArray"}}}},"parse_tree":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchically arranged graph of phrases detected in the sentence. Must have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to appear."},"children":[]}]}]}],"required":["id","phrases"],"properties":{"id":{"type":"integer","description":"Internal runtime identifier of the sentence parse interpretation."},"phrases":{"type":"array","description":"The graph of phrases, with the root phrases at the top level.","items":{"$ref":"#/components/schemas/Phrase"}}}},"corrected_text":{"type":"string","description":"Sentence text if corrected by the built-in spellchecker."}}}},"entities_summary":{"type":"array","items":{"type":"object","required":["type","name","mentions"],"properties":{"type":{"description":"Type or types of the entity.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"name":{"type":"string","description":"Standard name of the entity."},"subtypes":{"type":"array","description":"Sub-types of the entity.","items":{"type":"string"}},"subtype":{"type":"string","description":"Main sub-type of the entity."},"wikidata":{"type":"string","description":"Wikidata ID, when exists."},"relations":{"type":"array","description":"Entity relations with other detected entities.","items":{"type":"object","required":["to"],"properties":{"to":{"type":"string","description":"The entity connected to."},"links":{"type":"array","description":"How the entities are connected.","items":{"type":"string"}}}}},"mentions":{"type":"array","description":"Mentions of the entity found in the input text.","items":{"type":"object","required":["offset","length","sentence_index"],"properties":{"offset":{"type":"integer","description":"0-based location in the sentence"},"length":{"type":"integer","description":"Length of the fragment"},"sentence_index":{"type":"integer","description":"Index of the sentence where the fragment is located"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fragment itself ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}}}}}}},"sentiment_expressions":{"type":"array","items":{"type":"object","required":["offset","length","sentence_index","polarity"],"properties":{"polarity":{"type":"string","description":"The sentiment polarity","enum":["positive","negative","mixed","neutral"]},"offset":{"type":"integer","description":"0-based location in the sentence"},"length":{"type":"integer","description":"Length of the fragment"},"sentence_index":{"type":"integer","description":"Index of the sentence where the fragment is located"},"targets":{"type":"array","description":"Targets of aspects (for aspect-based sentiment analysis).","items":{"type":"string"}},"reasons":{"type":"array","description":"Reason tags (for aspect-based sentiment analysis).","items":{"type":"string"}},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fragment itself ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"explanation":{"type":"string","description":"Human-readable explanation of the rationale for flagging"}}}}}},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"isoCode":{"type":"string"},"name":{"type":"string"},"englishName":{"type":"string"},"nativeEncoding":{"type":"string"},"fontFace":{"type":"string"},"latin":{"type":"boolean"},"rightToLeft":{"type":"boolean"}}}},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"object"},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"number"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"string","description":"The text fragment to analyze."},"languages":{"type":"string","description":"A vertical bar-delimited list of language codes to use as cues."},"delimiter":{"type":"string","description":"A regular expression for segmenting the fragment; by default, the fragment is not segmented"}}},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"content":{"type":"string"},"settings":{"type":"object","properties":{"snippets":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", relevant fragments are included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abuse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentiment_expressions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entities_summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sections."},"children":[]}]}]}]},"abuse":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to output "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abuse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]}]},"sentiment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to output sentiment. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]}]},"topics":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to output topics. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]}]},"entities":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to output entity information. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]}]},"relations":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", relations between the entities are provided."},"children":[]}]}]}]},"disable_spellcheck":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", spellchecking is not used. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the spellchecking is on by default)"},"children":[]}]}]}]},"words":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", individual lexical chunks are provided."},"children":[]}]}]}]},"state":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the long-term memory contents are returned."},"children":[]}]}]}]},"memory":{"$ref":"#/components/schemas/Memory","description":"Initializes the long-term memory content."}},"additionalProperties":true}}},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"isLemma":{"type":"boolean"},"features":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer"},"value":{"type":"string"}}}}}}},"id":"schema_44"}},"exampleStore":{"paths/~1parse/post/requestBody/content/application~1json/examples/Hello Tisane":{"value":{"language":"en","content":"Hello Tisane API!!"},"key":"Hello Tisane","summary":"Hello Tisane","id":"paths/~1parse/post/requestBody/content/application~1json/examples/Hello Tisane"},"paths/~1parse/post/requestBody/content/application~1json/examples/Abuse detection":{"value":{"language":"en","content":"Babylonians should stay away from our country. We are full.","settings":{"snippets":true}},"key":"Abuse detection","summary":"Abuse detection","id":"paths/~1parse/post/requestBody/content/application~1json/examples/Abuse detection"},"paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (native standard)":{"value":{"language":"en","content":"An inertial force is a force that resists a change in velocity of an object."},"key":"Extract topics (native standard)","summary":"Extract topics (native standard)","id":"paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (native standard)"},"paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (IAB standard)":{"value":{"language":"en","content":"moon, Jupiter and Mars","settings":{"topic_standard":"iab_description","entities":false}},"key":"Extract topics (IAB standard)","summary":"Extract topics (IAB standard)","id":"paths/~1parse/post/requestBody/content/application~1json/examples/Extract topics (IAB standard)"},"paths/~1parse/post/requestBody/content/application~1json/examples/Adverse media monitoring in fintech":{"value":{"language":"en","content":"HSBC has been accused of money laundering recently","settings":{"snippets":true,"sentiment_analysis_type":"entity"}},"key":"Adverse media monitoring in fintech","summary":"Adverse media monitoring in fintech","id":"paths/~1parse/post/requestBody/content/application~1json/examples/Adverse media monitoring in fintech"},"paths/~1parse/post/requestBody/content/application~1json/examples/Parse alias w~1 sentence structure":{"value":{"language":"en","content":"anxiousgayhorseonketamine","settings":{"parses":true,"subscope":true,"sentiment":false,"format":"alias"}},"key":"Parse alias w/ sentence structure","summary":"Parse alias w/ sentence structure","id":"paths/~1parse/post/requestBody/content/application~1json/examples/Parse alias w~1 sentence structure"},"paths/~1parse/post/requestBody/content/application~1json/examples/Parse hashtag and output words":{"value":{"language":"en","content":"deathtodishonestpeople","settings":{"words":true,"subscope":true,"sentiment":false,"fetch_definitions":true}},"key":"Parse hashtag and output words","summary":"Parse hashtag and output words","id":"paths/~1parse/post/requestBody/content/application~1json/examples/Parse hashtag and output words"},"paths/~1parse/post/responses/200/content/application~1json/examples/Hello Tisane":{"value":{"text":"Hello Tisane API!","entities_summary":[{"type":"software","name":"Tisane API","mentions":[{"sentence_index":0,"offset":6,"length":10}]}]},"key":"Hello Tisane","summary":"Hello Tisane","id":"paths/~1parse/post/responses/200/content/application~1json/examples/Hello Tisane"},"paths/~1parse/post/responses/200/content/application~1json/examples/Abuse detection":{"value":{"text":"Babylonians should stay away from our country. We are full.","abuse":[{"sentence_index":0,"offset":0,"length":45,"text":"Babylonians should stay away from our country","type":"bigotry","severity":"low"}],"sentiment_expressions":[{"sentence_index":0,"offset":0,"length":45,"text":"Babylonians should stay away from our country","polarity":"negative"}]},"key":"Abuse detection","summary":"Abuse detection","id":"paths/~1parse/post/responses/200/content/application~1json/examples/Abuse detection"},"paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (native standard)":{"value":{"text":"An inertial force is a force that resists a change in velocity of an object.","topics":["physics"]},"key":"Extract topics (native standard)","summary":"Extract topics (native standard)","id":"paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (native standard)"},"paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (IAB standard)":{"value":{"text":"moon, Jupiter and Mars","topics":["Space and Astronomy"]},"key":"Extract topics (IAB standard)","summary":"Extract topics (IAB standard)","id":"paths/~1parse/post/responses/200/content/application~1json/examples/Extract topics (IAB standard)"},"paths/~1parse/post/responses/200/content/application~1json/examples/Adverse media monitoring in fintech":{"value":{"text":"HSBC has been accused of money laundering recently","topics":["laws"],"sentiment_expressions":[{"sentence_index":0,"offset":0,"length":41,"text":"HSBC has been accused of money laundering","polarity":"negative","reasons":["compliance","misconduct"]}],"entities_summary":[{"type":"organization","name":"HSBC","mentions":[{"sentence_index":0,"offset":0,"length":4,"text":"HSBC"}]}]},"key":"Adverse media monitoring in fintech","summary":"Adverse media monitoring in fintech","id":"paths/~1parse/post/responses/200/content/application~1json/examples/Adverse media monitoring in fintech"},"paths/~1parse/post/responses/200/content/application~1json/examples/Parse alias w~1 sentence structure":{"value":{"text":"anxiousgayhorseonketamine","topics":[],"abuse":[{"sentence_index":0,"offset":17,"length":8,"type":"adult_only","severity":"high","tags":["hallucinogen"]}]},"key":"Parse alias w/ sentence structure","summary":"Parse alias w/ sentence structure","id":"paths/~1parse/post/responses/200/content/application~1json/examples/Parse alias w~1 sentence structure"},"paths/~1parse/post/responses/200/content/application~1json/examples/Parse hashtag and output words":{"value":{"text":"#deathtodishonestpeople","topics":["crime"],"abuse":[{"sentence_index":0,"offset":1,"length":22,"type":"criminal_activity","severity":"extreme","tags":["call_for_violence","death"]}]},"key":"Parse hashtag and output words","summary":"Parse hashtag and output words","id":"paths/~1parse/post/responses/200/content/application~1json/examples/Parse hashtag and output words"},"paths/~1languages/get/responses/200/content/application~1json/example":{"value":[{"isoCode":"ar","name":"العربية","englishName":"Arabic","nativeEncoding":"iso-8859-6","fontFace":"Arial","latin":false,"rightToLeft":true},{"isoCode":"en","name":"English","englishName":"English","nativeEncoding":"iso-8859-1","fontFace":"Arial","latin":true},{"isoCode":"zh-CN","name":"简体中文","englishName":"Chinese, Simplified","nativeEncoding":"gb18030","fontFace":"NSimSun","latin":false},{"isoCode":"zh-TW","name":"繁體中文","englishName":"Chinese, Traditional","nativeEncoding":"iso-8859-1","fontFace":"Arial Unicode MS","latin":false},{"isoCode":"ja","name":"日本語","englishName":"Japanese","nativeEncoding":"ISO-2022","fontFace":"MS Mincho","latin":false},{"isoCode":"ru","name":"русский","englishName":"Russian","nativeEncoding":"iso-8859-1","fontFace":"Arial","latin":false}],"id":"paths/~1languages/get/responses/200/content/application~1json/example"},"paths/~1helper~1extract_text/post/requestBody/content/text~1plain/example":{"value":"<p>Clean me up</p> <style>/* Styles are unnecessary for text analysis */</style>","id":"paths/~1helper~1extract_text/post/requestBody/content/text~1plain/example"},"paths/~1helper~1extract_text/post/responses/200/content/text~1plain/example":{"value":"Clean me up","id":"paths/~1helper~1extract_text/post/responses/200/content/text~1plain/example"},"paths/~1compare~1entities/post/requestBody/content/application~1json/example":{"value":{"language1":"en","entity1":"Gary Youngman MD","language2":"en","entity2":"Gary Oldman","type":"person"},"id":"paths/~1compare~1entities/post/requestBody/content/application~1json/example"},"paths/~1compare~1entities/post/responses/200/content/application~1json/example":{"value":{"result":"different","differences":["surname","social_role"]},"id":"paths/~1compare~1entities/post/responses/200/content/application~1json/example"},"paths/~1similarity/post/requestBody/content/application~1json/example":{"value":{"language1":"en","content1":"Franz Ferdinand was assassinated by a Serbian revolutionary","language2":"en","content2":"A Yugoslav radical assassinated Franz Ferdinand","settings":{}},"id":"paths/~1similarity/post/requestBody/content/application~1json/example"},"paths/~1similarity/post/responses/200/content/application~1json/example":{"value":0.6190476190476191,"id":"paths/~1similarity/post/responses/200/content/application~1json/example"},"paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Basic":{"value":{"content":"c'est la vie"},"key":"Basic","summary":"Basic","id":"paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Basic"},"paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Hints for ambiguous cases":{"value":{"content":"singular","languages":"es|ar"},"key":"Hints for ambiguous cases","summary":"Hints for ambiguous cases","id":"paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Hints for ambiguous cases"},"paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Breakdown of languages segmenting by line":{"value":{"content":"скушай\r\nmuffin\r\nכפארה","languages":"en|ru|th|he","delimiter":"[\\r\\n]"},"key":"Breakdown of languages segmenting by line","summary":"Breakdown of languages segmenting by line","id":"paths/~1detectLanguage/post/requestBody/content/application~1json/examples/Breakdown of languages segmenting by line"},"paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Basic":{"value":{"languages":[{"offset":0,"length":12,"language":"fr","score":1181}]},"key":"Basic","summary":"Basic","id":"paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Basic"},"paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Hints for ambiguous cases":{"value":{"languages":[{"offset":0,"length":8,"language":"es","score":1137}]},"key":"Hints for ambiguous cases","summary":"Hints for ambiguous cases","id":"paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Hints for ambiguous cases"},"paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Breakdown of languages segmenting by line":{"value":{"languages":[{"offset":0,"length":7,"language":"ru","score":866},{"offset":8,"length":6,"language":"en","score":731},{"offset":16,"length":6,"language":"he","score":1024}]},"key":"Breakdown of languages segmenting by line","summary":"Breakdown of languages segmenting by line","id":"paths/~1detectLanguage/post/responses/200/content/application~1json/examples/Breakdown of languages segmenting by line"},"paths/~1transform/post/requestBody/content/application~1json/examples/Translate a Japanese sentence":{"value":{"from":"ja","to":"en","content":"彼女はりんごを食べます","settings":{}},"key":"Translate a Japanese sentence","summary":"Translate a Japanese sentence","id":"paths/~1transform/post/requestBody/content/application~1json/examples/Translate a Japanese sentence"},"paths/~1transform/post/requestBody/content/application~1json/examples/Auto-detect language and translate Chinese name to English":{"value":{"from":"*","to":"en","content":"汪杰世","settings":{"entity":"person"}},"key":"Auto-detect language and translate Chinese name to English","summary":"Auto-detect language and translate Chinese name to English","id":"paths/~1transform/post/requestBody/content/application~1json/examples/Auto-detect language and translate Chinese name to English"},"paths/~1transform/post/requestBody/content/application~1json/examples/Translate from English to Russian":{"value":{"from":"en","to":"ru","content":"The movie is available on amazon prime","settings":{}},"key":"Translate from English to Russian","summary":"Translate from English to Russian","id":"paths/~1transform/post/requestBody/content/application~1json/examples/Translate from English to Russian"},"paths/~1transform/post/requestBody/content/application~1json/examples/Translate Russian drug addict jargon to English":{"value":{"from":"ru","to":"en","content":"юзаю амф умеренно","settings":{}},"key":"Translate Russian drug addict jargon to English","summary":"Translate Russian drug addict jargon to English","id":"paths/~1transform/post/requestBody/content/application~1json/examples/Translate Russian drug addict jargon to English"},"paths/~1transform/post/requestBody/content/application~1json/examples/Translate from Hebrew to Russian preserving gender":{"value":{"from":"he","to":"ru","content":"אני אוהב סיניות","settings":{}},"key":"Translate from Hebrew to Russian preserving gender","summary":"Translate from Hebrew to Russian preserving gender","id":"paths/~1transform/post/requestBody/content/application~1json/examples/Translate from Hebrew to Russian preserving gender"},"paths/~1transform/post/responses/200/content/text~1plain/examples/Translate a Japanese sentence":{"value":"She is eating an apple","key":"Translate a Japanese sentence","summary":"Translate a Japanese sentence","id":"paths/~1transform/post/responses/200/content/text~1plain/examples/Translate a Japanese sentence"},"paths/~1transform/post/responses/200/content/text~1plain/examples/Auto-detect language and translate Chinese name to English":{"value":"Wang Jie Shi","key":"Auto-detect language and translate Chinese name to English","summary":"Auto-detect language and translate Chinese name to English","id":"paths/~1transform/post/responses/200/content/text~1plain/examples/Auto-detect language and translate Chinese name to English"},"paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from English to Russian":{"value":"Фильм доступен на amazon prime","key":"Translate from English to Russian","summary":"Translate from English to Russian","id":"paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from English to Russian"},"paths/~1transform/post/responses/200/content/text~1plain/examples/Translate Russian drug addict jargon to English":{"value":"I moderately take amphetamine","key":"Translate Russian drug addict jargon to English","summary":"Translate Russian drug addict jargon to English","id":"paths/~1transform/post/responses/200/content/text~1plain/examples/Translate Russian drug addict jargon to English"},"paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from Hebrew to Russian preserving gender":{"value":"Я люблю китаянок","key":"Translate from Hebrew to Russian preserving gender","summary":"Translate from Hebrew to Russian preserving gender","id":"paths/~1transform/post/responses/200/content/text~1plain/examples/Translate from Hebrew to Russian preserving gender"},"paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"buy\" in English":{"value":[{"text":"bought","features":[{"index":2,"value":"ALL"},{"index":9,"value":"ALL"},{"index":10,"value":"PAP"},{"index":11,"value":"ALL"},{"index":21,"value":"IND"},{"index":15,"value":"NO"},{"index":27,"value":"ALL"},{"index":5,"value":"ALL"}]},{"text":"bought","features":[{"index":2,"value":"ALL"},{"index":9,"value":"ALL"},{"index":10,"value":"PAST"},{"index":5,"value":"ALL"},{"index":11,"value":"ACT"},{"index":21,"value":"IND"},{"index":15,"value":"NO"},{"index":27,"value":"ALL"}]},{"text":"buy","isLemma":true,"features":[{"index":10,"value":"BASE"},{"index":11,"value":"ACT"},{"index":21,"value":"IND"},{"index":2,"value":"ALL"},{"index":9,"value":"ALL"},{"index":15,"value":"NO"},{"index":27,"value":"ALL"},{"index":5,"value":"ALL"}]},{"text":"buys","features":[{"index":5,"value":"ALL"},{"index":2,"value":"1"},{"index":9,"value":"3"},{"index":10,"value":"PRES"},{"index":15,"value":"NO"},{"index":11,"value":"ACT"},{"index":21,"value":"IND"},{"index":27,"value":"ALL"}]},{"text":"buying","features":[{"index":2,"value":"ALL"},{"index":9,"value":"ALL"},{"index":10,"value":"PRP"},{"index":5,"value":"ALL"},{"index":15,"value":"NO"},{"index":11,"value":"ACT"},{"index":21,"value":"IND"},{"index":27,"value":"ALL"}]},{"text":"buy","features":[{"index":10,"value":"PRES"},{"index":11,"value":"ACT"},{"index":21,"value":"IND"},{"index":23,"value":"BODY"},{"index":2,"value":"ALL"},{"index":9,"value":"1"},{"index":15,"value":"NO"},{"index":27,"value":"ALL"},{"index":3,"value":"ALL"},{"index":29,"value":"00"},{"index":5,"value":"ALL"},{"index":22,"value":"ALL"}]},{"text":"buy","features":[{"index":10,"value":"PRES"},{"index":11,"value":"ACT"},{"index":21,"value":"IND"},{"index":23,"value":"BODY"},{"index":2,"value":"ALL"},{"index":9,"value":"2"},{"index":15,"value":"NO"},{"index":27,"value":"ALL"},{"index":3,"value":"ALL"},{"index":29,"value":"00"},{"index":5,"value":"ALL"},{"index":22,"value":"ALL"}]},{"text":"buy","features":[{"index":10,"value":"PRES"},{"index":11,"value":"ACT"},{"index":21,"value":"IND"},{"index":2,"value":"MANY"},{"index":9,"value":"3"},{"index":15,"value":"NO"},{"index":27,"value":"ALL"},{"index":3,"value":"ALL"},{"index":29,"value":"00"},{"index":5,"value":"ALL"},{"index":22,"value":"ALL"}]}],"key":"Inflected forms of \"buy\" in English","summary":"Inflected forms of \"buy\" in English","id":"paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"buy\" in English"},"paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"United States\" in Russian":{"value":[{"features":[{"index":9,"value":"3"},{"index":15,"value":"NOM"}],"isLemma":true,"text":"Соединённые Штаты Америки"},{"features":[{"index":15,"value":"GEN"},{"index":9,"value":"3"}],"text":"Соединенных Штатов Америки"},{"features":[{"index":15,"value":"INST"},{"index":9,"value":"3"}],"text":"Соединенными Штатами Америки"},{"features":[{"index":15,"value":"DAT"},{"index":9,"value":"3"}],"text":"Соединенным Штатам Америки"},{"features":[{"index":15,"value":"PREP"},{"index":9,"value":"3"}],"text":"Соединенных Штатах Америки"},{"features":[{"index":24,"value":"THNG"},{"index":2,"value":"1"},{"index":9,"value":"3"},{"index":7,"value":"NA"},{"index":15,"value":"ACC"}],"text":"Соединённые Штаты Америки"}],"key":"Inflected forms of \"United States\" in Russian","summary":"Inflected forms of \"United States\" in Russian","id":"paths/~1lm~1inflections/get/responses/200/content/application~1json/examples/Inflected forms of \"United States\" in Russian"}},"securitySchemeStore":{"Tisane-API-Key":{"id":"Tisane-API-Key","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API subscription key (primary or secondary) from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.tisane.ai/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tisane Developer Portal"},"children":[]}]}]}]}],"in":"header","paramName":"Ocp-Apim-Subscription-Key"}},"servers":[{"url":"https://api.tisane.ai","description":"Tisane public cloud"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/tisane-api-short.json?download"},{"url":"/_bundle/apis/tisane-api-short.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Overview","description":"This reference describes RESTful web methods for interacting with Tisane API using standard HTTP and JSON-based communication. "}},"baseSlug":"/apis/tisane-api-short","routesMapping":{}}