azure.ai.textanalytics.AnalyzeSentimentAction.yml

### YamlMime:PythonClass
uid: azure.ai.textanalytics.AnalyzeSentimentAction
name: AnalyzeSentimentAction
fullName: azure.ai.textanalytics.AnalyzeSentimentAction
module: azure.ai.textanalytics
inheritances:
- azure.ai.textanalytics._dict_mixin.DictMixin
summary: 'AnalyzeSentimentAction encapsulates the parameters for starting a long-running

  Sentiment Analysis operation.


  If you just want to analyze sentiment in a list of documents, and not perform multiple

  long running actions on the input of documents, call method *analyze_sentiment*
  instead

  of interfacing with this model.'
constructor:
  syntax: 'AnalyzeSentimentAction(*, show_opinion_mining: bool | None = None, model_version:
    str | None = None, string_index_type: str | None = None, disable_service_logs:
    bool | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: model_version
    description: 'The model version to use for the analysis, e.g. "latest".

      If a model version is not specified, the API will default to the latest, non-preview
      version.

      See here for more info: [https://aka.ms/text-analytics-model-versioning](https://aka.ms/text-analytics-model-versioning)'
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: show_opinion_mining
    description: 'Whether to mine the opinions of a sentence and conduct more

      granular analysis around the aspects of a product or service (also known as

      aspect-based sentiment analysis). If set to true, the returned

      <xref:azure.ai.textanalytics.SentenceSentiment> objects

      will have property *mined_opinions* containing the result of this analysis.'
    types:
    - <xref:typing.Optional>[<xref:bool>]
  - name: string_index_type
    description: 'Specifies the method used to interpret string offsets.

      *UnicodeCodePoint*, the Python encoding, is the default. To override the Python
      default,

      you can also pass in *Utf16CodeUnit* or *TextElement_v8*. For additional information

      see [https://aka.ms/text-analytics-offsets](https://aka.ms/text-analytics-offsets)'
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: disable_service_logs
    description: 'If set to true, you opt-out of having your text input

      logged on the service side for troubleshooting. By default, the Language service
      logs your

      input text for 48 hours, solely to allow for troubleshooting issues in providing
      you with

      the service''s natural language processing functions. Setting this parameter
      to true,

      disables input logging and may limit our ability to remediate issues that occur.
      Please see

      Cognitive Services Compliance and Privacy notes at [https://aka.ms/cs-compliance](https://aka.ms/cs-compliance)
      for

      additional details, and Microsoft Responsible AI principles at

      [https://www.microsoft.com/ai/responsible-ai](https://www.microsoft.com/ai/responsible-ai).'
    types:
    - <xref:typing.Optional>[<xref:bool>]
methods:
- uid: azure.ai.textanalytics.AnalyzeSentimentAction.get
  name: get
  signature: 'get(key: str, default: Any | None = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.ai.textanalytics.AnalyzeSentimentAction.has_key
  name: has_key
  signature: 'has_key(k: str) -> bool'
  parameters:
  - name: k
    isRequired: true
- uid: azure.ai.textanalytics.AnalyzeSentimentAction.items
  name: items
  signature: items() -> Iterable[Tuple[str, Any]]
- uid: azure.ai.textanalytics.AnalyzeSentimentAction.keys
  name: keys
  signature: keys() -> Iterable[str]
- uid: azure.ai.textanalytics.AnalyzeSentimentAction.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.ai.textanalytics.AnalyzeSentimentAction.values
  name: values
  signature: values() -> Iterable[Any]
attributes:
- uid: azure.ai.textanalytics.AnalyzeSentimentAction.disable_service_logs
  name: disable_service_logs
  summary: 'If set to true, you opt-out of having your text input

    logged on the service side for troubleshooting. By default, the Language service
    logs your

    input text for 48 hours, solely to allow for troubleshooting issues in providing
    you with

    the service''s natural language processing functions. Setting this parameter to
    true,

    disables input logging and may limit our ability to remediate issues that occur.
    Please see

    Cognitive Services Compliance and Privacy notes at [https://aka.ms/cs-compliance](https://aka.ms/cs-compliance)
    for

    additional details, and Microsoft Responsible AI principles at

    [https://www.microsoft.com/ai/responsible-ai](https://www.microsoft.com/ai/responsible-ai).'
  signature: 'disable_service_logs: bool | None = None'
- uid: azure.ai.textanalytics.AnalyzeSentimentAction.model_version
  name: model_version
  summary: 'The model version to use for the analysis, e.g. "latest".

    If a model version is not specified, the API will default to the latest, non-preview
    version.

    See here for more info: [https://aka.ms/text-analytics-model-versioning](https://aka.ms/text-analytics-model-versioning).'
  signature: 'model_version: str | None = None'
- uid: azure.ai.textanalytics.AnalyzeSentimentAction.show_opinion_mining
  name: show_opinion_mining
  summary: 'Whether to mine the opinions of a sentence and conduct more

    granular analysis around the aspects of a product or service (also known as

    aspect-based sentiment analysis). If set to true, the returned

    <xref:azure.ai.textanalytics.SentenceSentiment> objects

    will have property *mined_opinions* containing the result of this analysis.'
  signature: 'show_opinion_mining: bool | None = None'
- uid: azure.ai.textanalytics.AnalyzeSentimentAction.string_index_type
  name: string_index_type
  summary: 'Specifies the method used to interpret string offsets.

    *UnicodeCodePoint*, the Python encoding, is the default. To override the Python
    default,

    you can also pass in *Utf16CodeUnit* or *TextElement_v8*. For additional information

    see [https://aka.ms/text-analytics-offsets](https://aka.ms/text-analytics-offsets)'
  signature: 'string_index_type: str | None = None'