azure.ai.textanalytics.TextAnalyticsClient class

Analysieren der Stimmung für einen Batch von Dokumenten. Aktivieren Sie Opinion Mining mit show_opinion_mining.

Gibt eine Stimmungsvorhersage sowie Stimmungsbewertungen für jede Stimmungsklasse (Positiv, Negativ und Neutral) für das Dokument und jeden darin enthaltenen Satz zurück.

Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten.

Neu in Version 3.1: Die Argumente show_opinion_mining, disable_service_logs und string_index_type Schlüsselwort (keyword).

analyze_sentiment(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], *, disable_service_logs: bool | None = None, language: str | None = None, model_version: str | None = None, show_opinion_mining: bool | None = None, show_stats: bool | None = None, string_index_type: str | None = None, **kwargs: Any) -> List[AnalyzeSentimentResult | DocumentError]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

show_opinion_mining: bool

Ob Sie die Meinungen eines Satzes erfassen und präzisere Analysen zu den Aspekten eines Produkts oder einer Dienstleistung durchführen (auch als aspektbasierte Standpunktanalyse bezeichnet). Wenn dieser Wert auf TRUE festgelegt ist, verfügen die zurückgegebenen SentenceSentiment Objekte über eine Eigenschaft mined_opinions , die das Ergebnis dieser Analyse enthält. Nur verfügbar für API-Version v3.1 und höher.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

model_version: str

Die Modellversion, die für die Analyse verwendet werden soll, z. B. "latest". Wenn keine Modellversion angegeben ist, verwendet die API standardmäßig die neueste Version ohne Vorschauversion. Weitere Informationen finden Sie hier: https://aka.ms/text-analytics-model-versioning

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene im Statistikfeld der Antwort auf Dokumentebene.

string_index_type: str

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. UnicodeCodePoint, die Python-Codierung, ist die Standardeinstellung. Um die Python-Standardeinstellung zu überschreiben, können Sie auch utf16CodeUnit oder TextElement_v8 übergeben. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets

disable_service_logs: bool

Wenn true festgelegt ist, deaktivieren Sie die Anmeldung Ihrer Texteingabe auf der Dienstseite zur Problembehandlung. Standardmäßig protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, nur um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Wenn Sie diesen Parameter auf true festlegen, wird die Eingabeprotokollierung deaktiviert, und es kann sein, dass wir probleme beheben können, die auftreten. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

Gibt zurück

Die kombinierte Liste von AnalyzeSentimentResult und DocumentError in der Reihenfolge, in der die Originaldokumente übergeben wurden.

Rückgabetyp

list[AnalyzeSentimentResult,

DocumentError]

Ausnahmen

HttpResponseError

TypeError

ValueError

Beispiele

Analysieren der Stimmung in einem Batch von Dokumenten.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]

   text_analytics_client = TextAnalyticsClient(endpoint=endpoint, credential=AzureKeyCredential(key))

   documents = [
       """I had the best day of my life. I decided to go sky-diving and it made me appreciate my whole life so much more.
       I developed a deep-connection with my instructor as well, and I feel as if I've made a life-long friend in her.""",
       """This was a waste of my time. All of the views on this drop are extremely boring, all I saw was grass. 0/10 would
       not recommend to any divers, even first timers.""",
       """This was pretty good! The sights were ok, and I had fun with my instructors! Can't complain too much about my experience""",
       """I only have one word for my experience: WOW!!! I can't believe I have had such a wonderful skydiving company right
       in my backyard this whole time! I will definitely be a repeat customer, and I want to take my grandmother skydiving too,
       I know she'll love it!"""
   ]


   result = text_analytics_client.analyze_sentiment(documents, show_opinion_mining=True)
   docs = [doc for doc in result if not doc.is_error]

   print("Let's visualize the sentiment of each of these documents")
   for idx, doc in enumerate(docs):
       print(f"Document text: {documents[idx]}")
       print(f"Overall sentiment: {doc.sentiment}")

Starten Sie einen zeitintensiven abstraktiven Zusammenfassungsvorgang.

Eine konzeptionelle Erläuterung der abstrakten Zusammenfassung finden Sie in der Dienstdokumentation: https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/overview

Neu in Version 2023-04-01: Die begin_abstract_summary Clientmethode.

begin_abstract_summary(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], *, continuation_token: str | None = None, disable_service_logs: bool | None = None, display_name: str | None = None, language: str | None = None, polling_interval: int | None = None, show_stats: bool | None = None, model_version: str | None = None, string_index_type: str | None = None, sentence_count: int | None = None, **kwargs: Any) -> TextAnalysisLROPoller[ItemPaged[AbstractiveSummaryResult | DocumentError]]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene.

sentence_count: Optional[int]

Sie steuert die ungefähre Anzahl von Sätzen in den Ausgabezusammenfassungen.

model_version: Optional[str]

Die Modellversion, die für die Analyse verwendet werden soll, z. B. "latest". Wenn keine Modellversion angegeben ist, verwendet die API standardmäßig die neueste Version ohne Vorschauversion. Weitere Informationen finden Sie hier: https://aka.ms/text-analytics-model-versioning

string_index_type: Optional[str]

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird.

disable_service_logs: bool

Wenn true festgelegt ist, deaktivieren Sie die Anmeldung Ihrer Texteingabe auf der Dienstseite zur Problembehandlung. Standardmäßig protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, nur um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Wenn Sie diesen Parameter auf true festlegen, wird die Eingabeprotokollierung deaktiviert, und es kann sein, dass wir probleme beheben können, die auftreten. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

polling_interval: int

Wartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist. Der Standardwert ist 5 Sekunden.

continuation_token: str

Rufen Sie continuation_token() für das Poller-Objekt auf, um den LRO-Zustand (Long-Running Operation) in einem undurchsichtigen Token zu speichern. Übergeben Sie den Wert als continuation_token Schlüsselwort (keyword) Argument, um den LRO aus einem gespeicherten Zustand neu zu starten.

display_name: str

Ein optionaler Anzeigename, der für die angeforderte Analyse festgelegt werden soll.

Gibt zurück

Eine instance eines TextAnalysisLROPollers. Rufen Sie result() für dieses Objekt auf, um eine heterogene Auslagerung von AbstractiveSummaryResult und DocumentErrorzurückzugeben.

Rückgabetyp

TextAnalysisLROPoller[ItemPaged[ AbstractiveSummaryResult,

DocumentError]]

Ausnahmen

HttpResponseError

Beispiele

Führen Sie eine abstraktive Zusammenfassung für einen Batch von Dokumenten aus.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]

   text_analytics_client = TextAnalyticsClient(
       endpoint=endpoint,
       credential=AzureKeyCredential(key),
   )

   document = [
       "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, "
       "human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive "
       "Services, I have been working with a team of amazing scientists and engineers to turn this quest into a "
       "reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of "
       "human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the "
       "intersection of all three, there's magic-what we call XYZ-code as illustrated in Figure 1-a joint "
       "representation to create more powerful AI that can speak, hear, see, and understand humans better. "
       "We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, "
       "spanning modalities and languages. The goal is to have pretrained models that can jointly learn "
       "representations to support a broad range of downstream AI tasks, much in the way humans do today. "
       "Over the past five years, we have achieved human performance on benchmarks in conversational speech "
       "recognition, machine translation, conversational question answering, machine reading comprehension, "
       "and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious "
       "aspiration to produce a leap in AI capabilities, achieving multisensory and multilingual learning that "
       "is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational "
       "component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
   ]

   poller = text_analytics_client.begin_abstract_summary(document)
   abstract_summary_results = poller.result()
   for result in abstract_summary_results:
       if result.kind == "AbstractiveSummarization":
           print("Summaries abstracted:")
           [print(f"{summary.text}\n") for summary in result.summaries]
       elif result.is_error is True:
           print("...Is an error with code '{}' and message '{}'".format(
               result.error.code, result.error.message
           ))

Starten Sie einen zeitintensiven Vorgang, um eine Vielzahl von Textanalyseaktionen für einen Batch von Dokumenten auszuführen.

Es wird empfohlen, diese Funktion zu verwenden, wenn Sie größere Dokumente analysieren und/oder mehrere Textanalyseaktionen in einem Aufruf kombinieren möchten. Andernfalls wird empfohlen, die aktionsspezifischen Endpunkte zu verwenden, z. B analyze_sentiment. .

Hinweis

Informationen zur regionalen Unterstützung benutzerdefinierter Aktionsfeatures finden Sie in der Dienstdokumentation:

https://aka.ms/azsdk/textanalytics/customfunctionalities

Neu in Version 3.1: Die begin_analyze_actions Clientmethode.

Neu in Version 2022-05-01: Die Eingabeoptionen RecognizeCustomEntitiesAction, SingleLabelClassifyAction, MultiLabelClassifyAction und AnalyzeHealthcareEntitiesAction sowie die entsprechenden RecognizeCustomEntitiesResult,ClassifyDocumentResult und AnalyzeHealthcareEntitiesResult-Ergebnisobjekte

Neu in Version 2023-04-01: Die Eingabeoptionen ExtractiveSummaryAction und AbstractiveSummaryAction sowie die entsprechenden ExtractiveSummaryResult - und AbstractiveSummaryResult-Ergebnisobjekte .

begin_analyze_actions(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], actions: List[RecognizeEntitiesAction | RecognizeLinkedEntitiesAction | RecognizePiiEntitiesAction | ExtractKeyPhrasesAction | AnalyzeSentimentAction | RecognizeCustomEntitiesAction | SingleLabelClassifyAction | MultiLabelClassifyAction | AnalyzeHealthcareEntitiesAction | ExtractiveSummaryAction | AbstractiveSummaryAction], *, continuation_token: str | None = None, display_name: str | None = None, language: str | None = None, polling_interval: int | None = None, show_stats: bool | None = None, **kwargs: Any) -> TextAnalysisLROPoller[ItemPaged[List[RecognizeEntitiesResult | RecognizeLinkedEntitiesResult | RecognizePiiEntitiesResult | ExtractKeyPhrasesResult | AnalyzeSentimentResult | RecognizeCustomEntitiesResult | ClassifyDocumentResult | AnalyzeHealthcareEntitiesResult | ExtractiveSummaryResult | AbstractiveSummaryResult | DocumentError]]]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

actions: list[RecognizeEntitiesAction oder RecognizePiiEntitiesAction oder ExtractKeyPhrasesAction oder RecognizeLinkedEntitiesAction oder AnalyzeSentimentAction oder RecognizeCustomEntitiesAction oder SingleLabelClassifyAction oder MultiLabelClassifyAction oder AnalyzeHealthcareEntitiesAction oder ExtractiveSummaryAction oder AbstractiveSummaryAction]

Erforderlich

Eine heterogene Liste von Aktionen, die für die Eingabedokumente ausgeführt werden sollen. Jedes Aktionsobjekt kapselt die Parameter, die für den jeweiligen Aktionstyp verwendet werden. Die Aktionsergebnisse befinden sich in derselben Reihenfolge wie die Eingabeaktionen.

display_name: str

Ein optionaler Anzeigename, der für die angeforderte Analyse festgelegt werden soll.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene.

polling_interval: int

Wartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist. Der Standardwert ist 5 Sekunden.

continuation_token: str

Rufen Sie continuation_token() für das Poller-Objekt auf, um den LRO-Zustand (Long-Running Operation) in einem undurchsichtigen Token zu speichern. Übergeben Sie den Wert als continuation_token Schlüsselwort (keyword) Argument, um den LRO aus einem gespeicherten Zustand neu zu starten.

Gibt zurück

Eine instance eines TextAnalysisLROPollers. Rufen Sie result() für das Poller-Objekt auf, um eine auslagerungsfähige heterogene Liste von Listen zurückzugeben. Diese Liste der Listen wird zuerst nach den von Ihnen eingegebenen Dokumenten und dann nach den von Ihnen eingegebenen Aktionen sortiert. Wenn Sie z. B. dokumente eingaben ["Hello", "world"], und Aktionen RecognizeEntitiesAction und AnalyzeSentimentActionund haben, wenn Sie die Liste der Listen durchlaufen, durchlaufen Sie zuerst die Aktionsergebnisse für das Dokument "Hello" und erhalten dann die RecognizeEntitiesResult von "Hello", dann die AnalyzeSentimentResult von "Hello". Dann erhalten Sie das RecognizeEntitiesResult und AnalyzeSentimentResult von "Welt".

Rückgabetyp

TextAnalysisLROPoller[ItemPaged[ list[RecognizeEntitiesResult,

RecognizeLinkedEntitiesResult,

RecognizePiiEntitiesResult,

ExtractKeyPhrasesResult,

AnalyzeSentimentResult,

RecognizeCustomEntitiesResult,

ClassifyDocumentResult,

AnalyzeHealthcareEntitiesResult,

ExtractiveSummaryResult,

AbstractiveSummaryResult,

DocumentError]]]

Ausnahmen

HttpResponseError

TypeError

ValueError

Beispiele

Starten Sie einen zeitintensiven Vorgang, um eine Vielzahl von Textanalyseaktionen für einen Batch von Dokumenten auszuführen.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import (
       TextAnalyticsClient,
       RecognizeEntitiesAction,
       RecognizeLinkedEntitiesAction,
       RecognizePiiEntitiesAction,
       ExtractKeyPhrasesAction,
       AnalyzeSentimentAction,
   )

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]

   text_analytics_client = TextAnalyticsClient(
       endpoint=endpoint,
       credential=AzureKeyCredential(key),
   )

   documents = [
       'We went to Contoso Steakhouse located at midtown NYC last week for a dinner party, and we adore the spot! '
       'They provide marvelous food and they have a great menu. The chief cook happens to be the owner (I think his name is John Doe) '
       'and he is super nice, coming out of the kitchen and greeted us all.'
       ,

       'We enjoyed very much dining in the place! '
       'The Sirloin steak I ordered was tender and juicy, and the place was impeccably clean. You can even pre-order from their '
       'online menu at www.contososteakhouse.com, call 312-555-0176 or send email to order@contososteakhouse.com! '
       'The only complaint I have is the food didn\'t come fast enough. Overall I highly recommend it!'
   ]

   poller = text_analytics_client.begin_analyze_actions(
       documents,
       display_name="Sample Text Analysis",
       actions=[
           RecognizeEntitiesAction(),
           RecognizePiiEntitiesAction(),
           ExtractKeyPhrasesAction(),
           RecognizeLinkedEntitiesAction(),
           AnalyzeSentimentAction(),
       ],
   )

   document_results = poller.result()
   for doc, action_results in zip(documents, document_results):
       print(f"\nDocument text: {doc}")
       for result in action_results:
           if result.kind == "EntityRecognition":
               print("...Results of Recognize Entities Action:")
               for entity in result.entities:
                   print(f"......Entity: {entity.text}")
                   print(f".........Category: {entity.category}")
                   print(f".........Confidence Score: {entity.confidence_score}")
                   print(f".........Offset: {entity.offset}")

           elif result.kind == "PiiEntityRecognition":
               print("...Results of Recognize PII Entities action:")
               for pii_entity in result.entities:
                   print(f"......Entity: {pii_entity.text}")
                   print(f".........Category: {pii_entity.category}")
                   print(f".........Confidence Score: {pii_entity.confidence_score}")

           elif result.kind == "KeyPhraseExtraction":
               print("...Results of Extract Key Phrases action:")
               print(f"......Key Phrases: {result.key_phrases}")

           elif result.kind == "EntityLinking":
               print("...Results of Recognize Linked Entities action:")
               for linked_entity in result.entities:
                   print(f"......Entity name: {linked_entity.name}")
                   print(f".........Data source: {linked_entity.data_source}")
                   print(f".........Data source language: {linked_entity.language}")
                   print(
                       f".........Data source entity ID: {linked_entity.data_source_entity_id}"
                   )
                   print(f".........Data source URL: {linked_entity.url}")
                   print(".........Document matches:")
                   for match in linked_entity.matches:
                       print(f"............Match text: {match.text}")
                       print(f"............Confidence Score: {match.confidence_score}")
                       print(f"............Offset: {match.offset}")
                       print(f"............Length: {match.length}")

           elif result.kind == "SentimentAnalysis":
               print("...Results of Analyze Sentiment action:")
               print(f"......Overall sentiment: {result.sentiment}")
               print(
                   f"......Scores: positive={result.confidence_scores.positive}; \
                   neutral={result.confidence_scores.neutral}; \
                   negative={result.confidence_scores.negative} \n"
               )

           elif result.is_error is True:
               print(
                   f"...Is an error with code '{result.error.code}' and message '{result.error.message}'"
               )

       print("------------------------------------------")

Analysieren Sie Entitäten im Gesundheitswesen, und identifizieren Sie Beziehungen zwischen diesen Entitäten in einem Batch von Dokumenten.

Entitäten sind Verweisen zugeordnet, die in vorhandenen Wissensdatenbanken wie UMLS, CHV, MSH usw. gefunden werden können.

Wir extrahieren auch die Beziehungen zwischen Entitäten, z. B. in "Der Antragsteller nahm 100 mg Ibuprofen", wir würden die Beziehung zwischen der Dosierung "100 mg" und dem "Ibuprofen" Medikament extrahieren.

Neu in Version 3.1: Die begin_analyze_healthcare_entities Clientmethode.

Neu in Version 2022-05-01: Das argument display_name Schlüsselwort (keyword).

begin_analyze_healthcare_entities(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], *, continuation_token: str | None = None, disable_service_logs: bool | None = None, display_name: str | None = None, language: str | None = None, model_version: str | None = None, polling_interval: int | None = None, show_stats: bool | None = None, string_index_type: str | None = None, **kwargs: Any) -> AnalyzeHealthcareEntitiesLROPoller[ItemPaged[AnalyzeHealthcareEntitiesResult | DocumentError]]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

model_version: str

Die Modellversion, die für die Analyse verwendet werden soll, z. B. "latest". Wenn keine Modellversion angegeben ist, verwendet die API standardmäßig die neueste Version ohne Vorschauversion. Weitere Informationen finden Sie hier: https://aka.ms/text-analytics-model-versioning

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

display_name: str

Ein optionaler Anzeigename, der für die angeforderte Analyse festgelegt werden soll.

string_index_type: str

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. UnicodeCodePoint, die Python-Codierung, ist die Standardeinstellung. Um die Python-Standardeinstellung zu überschreiben, können Sie auch utf16CodeUnit oder TextElement_v8 übergeben. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets

polling_interval: int

Wartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist. Der Standardwert ist 5 Sekunden.

continuation_token: str

Rufen Sie continuation_token() für das Poller-Objekt auf, um den LRO-Zustand (Long-Running Operation) in einem undurchsichtigen Token zu speichern. Übergeben Sie den Wert als continuation_token Schlüsselwort (keyword) Argument, um den LRO aus einem gespeicherten Zustand neu zu starten.

disable_service_logs: bool

Der Standardwert ist true, d. h. der Sprachdienst protokolliert Ihren Eingabetext nicht auf der Dienstseite zur Problembehandlung. Wenn dieser Wert auf False festgelegt ist, protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

Gibt zurück

Eine instance eines AnalyzeHealthcareEntitiesLROPollers. Rufen Sie result() für dieses Objekt auf, um eine heterogene Auslagerung von AnalyzeHealthcareEntitiesResult und DocumentErrorzurückzugeben.

Rückgabetyp

AnalyzeHealthcareEntitiesLROPoller[ItemPaged[ AnalyzeHealthcareEntitiesResult,

DocumentError]]

Ausnahmen

HttpResponseError

TypeError

ValueError

Beispiele

Erkennen von Entitäten im Gesundheitswesen in einem Batch von Dokumenten.


   import os
   import typing
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient, HealthcareEntityRelation

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]

   text_analytics_client = TextAnalyticsClient(
       endpoint=endpoint,
       credential=AzureKeyCredential(key),
   )

   documents = [
       """
       Patient needs to take 100 mg of ibuprofen, and 3 mg of potassium. Also needs to take
       10 mg of Zocor.
       """,
       """
       Patient needs to take 50 mg of ibuprofen, and 2 mg of Coumadin.
       """
   ]

   poller = text_analytics_client.begin_analyze_healthcare_entities(documents)
   result = poller.result()

   docs = [doc for doc in result if not doc.is_error]

   print("Let's first visualize the outputted healthcare result:")
   for doc in docs:
       for entity in doc.entities:
           print(f"Entity: {entity.text}")
           print(f"...Normalized Text: {entity.normalized_text}")
           print(f"...Category: {entity.category}")
           print(f"...Subcategory: {entity.subcategory}")
           print(f"...Offset: {entity.offset}")
           print(f"...Confidence score: {entity.confidence_score}")
           if entity.data_sources is not None:
               print("...Data Sources:")
               for data_source in entity.data_sources:
                   print(f"......Entity ID: {data_source.entity_id}")
                   print(f"......Name: {data_source.name}")
           if entity.assertion is not None:
               print("...Assertion:")
               print(f"......Conditionality: {entity.assertion.conditionality}")
               print(f"......Certainty: {entity.assertion.certainty}")
               print(f"......Association: {entity.assertion.association}")
       for relation in doc.entity_relations:
           print(f"Relation of type: {relation.relation_type} has the following roles")
           for role in relation.roles:
               print(f"...Role '{role.name}' with entity '{role.entity.text}'")
       print("------------------------------------------")

   print("Now, let's get all of medication dosage relations from the documents")
   dosage_of_medication_relations = [
       entity_relation
       for doc in docs
       for entity_relation in doc.entity_relations if entity_relation.relation_type == HealthcareEntityRelation.DOSAGE_OF_MEDICATION
   ]

Starten Sie einen zeitintensiven extraktiven Zusammenfassungsvorgang.

Eine konzeptionelle Erläuterung der extraktiven Zusammenfassung finden Sie in der Dienstdokumentation: https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/overview

Neu in Version 2023-04-01: Die begin_extract_summary Clientmethode.

begin_extract_summary(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], *, continuation_token: str | None = None, disable_service_logs: bool | None = None, display_name: str | None = None, language: str | None = None, polling_interval: int | None = None, show_stats: bool | None = None, model_version: str | None = None, string_index_type: str | None = None, max_sentence_count: int | None = None, order_by: Literal['Rank', 'Offset'] | None = None, **kwargs: Any) -> TextAnalysisLROPoller[ItemPaged[ExtractiveSummaryResult | DocumentError]]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene.

max_sentence_count: Optional[int]

Maximale Anzahl von zurückzugebenden Sätzen. Der Standardwert ist 3.

order_by: Optional[str]

Mögliche Werte sind: "Offset", "Rank". Standardwert: "Offset".

model_version: Optional[str]

Die Modellversion, die für die Analyse verwendet werden soll, z. B. "latest". Wenn keine Modellversion angegeben ist, verwendet die API standardmäßig die neueste Version ohne Vorschauversion. Weitere Informationen finden Sie hier: https://aka.ms/text-analytics-model-versioning

string_index_type: Optional[str]

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird.

disable_service_logs: bool

Wenn true festgelegt ist, deaktivieren Sie die Anmeldung Ihrer Texteingabe auf der Dienstseite zur Problembehandlung. Standardmäßig protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, nur um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Wenn Sie diesen Parameter auf true festlegen, wird die Eingabeprotokollierung deaktiviert, und es kann sein, dass wir probleme beheben können, die auftreten. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

polling_interval: int

Wartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist. Der Standardwert ist 5 Sekunden.

continuation_token: str

Rufen Sie continuation_token() für das Poller-Objekt auf, um den LRO-Zustand (Long-Running Operation) in einem undurchsichtigen Token zu speichern. Übergeben Sie den Wert als continuation_token Schlüsselwort (keyword) Argument, um den LRO aus einem gespeicherten Zustand neu zu starten.

display_name: str

Ein optionaler Anzeigename, der für die angeforderte Analyse festgelegt werden soll.

Gibt zurück

Eine instance eines TextAnalysisLROPollers. Rufen Sie result() für dieses Objekt auf, um eine heterogene Auslagerung von ExtractiveSummaryResult und DocumentErrorzurückzugeben.

Rückgabetyp

TextAnalysisLROPoller[ItemPaged[ ExtractiveSummaryResult,

DocumentError]]

Ausnahmen

HttpResponseError

Beispiele

Führen Sie eine extrahierende Zusammenfassung für einen Batch von Dokumenten aus.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]

   text_analytics_client = TextAnalyticsClient(
       endpoint=endpoint,
       credential=AzureKeyCredential(key),
   )

   document = [
       "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, "
       "human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive "
       "Services, I have been working with a team of amazing scientists and engineers to turn this quest into a "
       "reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of "
       "human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the "
       "intersection of all three, there's magic-what we call XYZ-code as illustrated in Figure 1-a joint "
       "representation to create more powerful AI that can speak, hear, see, and understand humans better. "
       "We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, "
       "spanning modalities and languages. The goal is to have pretrained models that can jointly learn "
       "representations to support a broad range of downstream AI tasks, much in the way humans do today. "
       "Over the past five years, we have achieved human performance on benchmarks in conversational speech "
       "recognition, machine translation, conversational question answering, machine reading comprehension, "
       "and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious "
       "aspiration to produce a leap in AI capabilities, achieving multisensory and multilingual learning that "
       "is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational "
       "component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
   ]

   poller = text_analytics_client.begin_extract_summary(document)
   extract_summary_results = poller.result()
   for result in extract_summary_results:
       if result.kind == "ExtractiveSummarization":
           print("Summary extracted: \n{}".format(
               " ".join([sentence.text for sentence in result.sentences]))
           )
       elif result.is_error is True:
           print("...Is an error with code '{}' and message '{}'".format(
               result.error.code, result.error.message
           ))

Starten Sie einen lang andauernden benutzerdefinierten Klassifizierungsvorgang mit mehreren Bezeichnungen.

Informationen zur regionalen Unterstützung benutzerdefinierter Features und zum Trainieren eines Modells zum Klassifizieren Ihrer Dokumente finden Sie unter https://aka.ms/azsdk/textanalytics/customfunctionalities

Neu in Version 2022-05-01: Die begin_multi_label_classify Clientmethode.

begin_multi_label_classify(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], project_name: str, deployment_name: str, *, continuation_token: str | None = None, disable_service_logs: bool | None = None, display_name: str | None = None, language: str | None = None, polling_interval: int | None = None, show_stats: bool | None = None, **kwargs: Any) -> TextAnalysisLROPoller[ItemPaged[ClassifyDocumentResult | DocumentError]]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

project_name: str

Erforderlich

Erforderlich. Dieses Feld gibt den Projektnamen für das Modell an.

deployment_name: str

Erforderlich

Dieses Feld gibt den Bereitstellungsnamen für das Modell an.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene.

disable_service_logs: bool

Wenn true festgelegt ist, deaktivieren Sie die Anmeldung Ihrer Texteingabe auf der Dienstseite zur Problembehandlung. Standardmäßig protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, nur um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Wenn Sie diesen Parameter auf true festlegen, wird die Eingabeprotokollierung deaktiviert, und es kann sein, dass wir probleme beheben können, die auftreten. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

polling_interval: int

Wartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist. Der Standardwert ist 5 Sekunden.

continuation_token: str

Rufen Sie continuation_token() für das Poller-Objekt auf, um den LRO-Zustand (Long-Running Operation) in einem undurchsichtigen Token zu speichern. Übergeben Sie den Wert als continuation_token Schlüsselwort (keyword) Argument, um den LRO aus einem gespeicherten Zustand neu zu starten.

display_name: str

Ein optionaler Anzeigename, der für die angeforderte Analyse festgelegt werden soll.

Gibt zurück

Eine instance eines TextAnalysisLROPollers. Rufen Sie result() für dieses Objekt auf, um eine heterogene Auslagerung von ClassifyDocumentResult und DocumentErrorzurückzugeben.

Rückgabetyp

TextAnalysisLROPoller[ItemPaged[ ClassifyDocumentResult,

DocumentError]]

Ausnahmen

HttpResponseError

Beispiele

Führen Sie die Klassifizierung mit mehreren Bezeichnungen für einen Batch von Dokumenten aus.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]
   project_name = os.environ["MULTI_LABEL_CLASSIFY_PROJECT_NAME"]
   deployment_name = os.environ["MULTI_LABEL_CLASSIFY_DEPLOYMENT_NAME"]
   path_to_sample_document = os.path.abspath(
       os.path.join(
           os.path.abspath(__file__),
           "..",
           "./text_samples/custom_classify_sample.txt",
       )
   )

   text_analytics_client = TextAnalyticsClient(
       endpoint=endpoint,
       credential=AzureKeyCredential(key),
   )

   with open(path_to_sample_document) as fd:
       document = [fd.read()]

   poller = text_analytics_client.begin_multi_label_classify(
       document,
       project_name=project_name,
       deployment_name=deployment_name
   )

   document_results = poller.result()
   for doc, classification_result in zip(document, document_results):
       if classification_result.kind == "CustomDocumentClassification":
           classifications = classification_result.classifications
           print(f"\nThe movie plot '{doc}' was classified as the following genres:\n")
           for classification in classifications:
               print("'{}' with confidence score {}.".format(
                   classification.category, classification.confidence_score
               ))
       elif classification_result.is_error is True:
           print("Movie plot '{}' has an error with code '{}' and message '{}'".format(
               doc, classification_result.error.code, classification_result.error.message
           ))

Starten Sie einen zeitintensiven benutzerdefinierten Vorgang zur Erkennung benannter Entitäten.

Informationen zur regionalen Unterstützung benutzerdefinierter Features und zum Trainieren eines Modells zum Erkennen benutzerdefinierter Entitäten finden Sie unter https://aka.ms/azsdk/textanalytics/customentityrecognition

Neu in Version 2022-05-01: Die begin_recognize_custom_entities Clientmethode.

begin_recognize_custom_entities(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], project_name: str, deployment_name: str, *, continuation_token: str | None = None, disable_service_logs: bool | None = None, display_name: str | None = None, language: str | None = None, polling_interval: int | None = None, show_stats: bool | None = None, string_index_type: str | None = None, **kwargs: Any) -> TextAnalysisLROPoller[ItemPaged[RecognizeCustomEntitiesResult | DocumentError]]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

project_name: str

Erforderlich

Erforderlich. Dieses Feld gibt den Projektnamen für das Modell an.

deployment_name: str

Erforderlich

Dieses Feld gibt den Bereitstellungsnamen für das Modell an.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene.

disable_service_logs: bool

Wenn true festgelegt ist, deaktivieren Sie die Anmeldung Ihrer Texteingabe auf der Dienstseite zur Problembehandlung. Standardmäßig protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, nur um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Wenn Sie diesen Parameter auf true festlegen, wird die Eingabeprotokollierung deaktiviert, und es kann sein, dass wir probleme beheben können, die auftreten. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

string_index_type: str

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. UnicodeCodePoint, die Python-Codierung, ist die Standardeinstellung. Um die Python-Standardeinstellung zu überschreiben, können Sie auch utf16CodeUnit oder TextElement_v8 übergeben. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets

polling_interval: int

Wartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist. Der Standardwert ist 5 Sekunden.

continuation_token: str

Rufen Sie continuation_token() für das Poller-Objekt auf, um den LRO-Zustand (Long-Running Operation) in einem undurchsichtigen Token zu speichern. Übergeben Sie den Wert als continuation_token Schlüsselwort (keyword) Argument, um den LRO aus einem gespeicherten Zustand neu zu starten.

display_name: str

Ein optionaler Anzeigename, der für die angeforderte Analyse festgelegt werden soll.

Gibt zurück

Eine instance eines TextAnalysisLROPollers. Rufen Sie result() für dieses Objekt auf, um eine heterogene Auslagerung von RecognizeCustomEntitiesResult und DocumentErrorzurückzugeben.

Rückgabetyp

TextAnalysisLROPoller[ItemPaged[ RecognizeCustomEntitiesResult,

DocumentError]]

Ausnahmen

HttpResponseError

Beispiele

Erkennen benutzerdefinierter Entitäten in einem Batch von Dokumenten.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]
   project_name = os.environ["CUSTOM_ENTITIES_PROJECT_NAME"]
   deployment_name = os.environ["CUSTOM_ENTITIES_DEPLOYMENT_NAME"]
   path_to_sample_document = os.path.abspath(
       os.path.join(
           os.path.abspath(__file__),
           "..",
           "./text_samples/custom_entities_sample.txt",
       )
   )

   text_analytics_client = TextAnalyticsClient(
       endpoint=endpoint,
       credential=AzureKeyCredential(key),
   )

   with open(path_to_sample_document) as fd:
       document = [fd.read()]

   poller = text_analytics_client.begin_recognize_custom_entities(
       document,
       project_name=project_name,
       deployment_name=deployment_name
   )

   document_results = poller.result()
   for custom_entities_result in document_results:
       if custom_entities_result.kind == "CustomEntityRecognition":
           for entity in custom_entities_result.entities:
               print(
                   "Entity '{}' has category '{}' with confidence score of '{}'".format(
                       entity.text, entity.category, entity.confidence_score
                   )
               )
       elif custom_entities_result.is_error is True:
           print("...Is an error with code '{}' and message '{}'".format(
               custom_entities_result.error.code, custom_entities_result.error.message
               )
           )

Starten Sie einen lang andauernden benutzerdefinierten Klassifizierungsvorgang für eine einzelne Bezeichnung.

Informationen zur regionalen Unterstützung benutzerdefinierter Features und zum Trainieren eines Modells zum Klassifizieren Ihrer Dokumente finden Sie unter https://aka.ms/azsdk/textanalytics/customfunctionalities

Neu in Version 2022-05-01: Die begin_single_label_classify Clientmethode.

begin_single_label_classify(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], project_name: str, deployment_name: str, *, continuation_token: str | None = None, disable_service_logs: bool | None = None, display_name: str | None = None, language: str | None = None, polling_interval: int | None = None, show_stats: bool | None = None, **kwargs: Any) -> TextAnalysisLROPoller[ItemPaged[ClassifyDocumentResult | DocumentError]]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

project_name: str

Erforderlich

Erforderlich. Dieses Feld gibt den Projektnamen für das Modell an.

deployment_name: str

Erforderlich

Dieses Feld gibt den Bereitstellungsnamen für das Modell an.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene.

disable_service_logs: bool

Wenn true festgelegt ist, deaktivieren Sie die Anmeldung Ihrer Texteingabe auf der Dienstseite zur Problembehandlung. Standardmäßig protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, nur um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Wenn Sie diesen Parameter auf true festlegen, wird die Eingabeprotokollierung deaktiviert, und es kann sein, dass wir probleme beheben können, die auftreten. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

polling_interval: int

Wartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist. Der Standardwert ist 5 Sekunden.

continuation_token: str

Rufen Sie continuation_token() für das Poller-Objekt auf, um den LRO-Zustand (Long-Running Operation) in einem undurchsichtigen Token zu speichern. Übergeben Sie den Wert als continuation_token Schlüsselwort (keyword) Argument, um den LRO aus einem gespeicherten Zustand neu zu starten.

display_name: str

Ein optionaler Anzeigename, der für die angeforderte Analyse festgelegt werden soll.

Gibt zurück

Eine instance eines TextAnalysisLROPollers. Rufen Sie result() für dieses Objekt auf, um eine heterogene Auslagerung von ClassifyDocumentResult und DocumentErrorzurückzugeben.

Rückgabetyp

TextAnalysisLROPoller[ItemPaged[ ClassifyDocumentResult,

DocumentError]]

Ausnahmen

HttpResponseError

Beispiele

Führen Sie die Klassifizierung mit einer einzelnen Bezeichnung für einen Batch von Dokumenten aus.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]
   project_name = os.environ["SINGLE_LABEL_CLASSIFY_PROJECT_NAME"]
   deployment_name = os.environ["SINGLE_LABEL_CLASSIFY_DEPLOYMENT_NAME"]
   path_to_sample_document = os.path.abspath(
       os.path.join(
           os.path.abspath(__file__),
           "..",
           "./text_samples/custom_classify_sample.txt",
       )
   )

   text_analytics_client = TextAnalyticsClient(
       endpoint=endpoint,
       credential=AzureKeyCredential(key),
   )

   with open(path_to_sample_document) as fd:
       document = [fd.read()]

   poller = text_analytics_client.begin_single_label_classify(
       document,
       project_name=project_name,
       deployment_name=deployment_name
   )

   document_results = poller.result()
   for doc, classification_result in zip(document, document_results):
       if classification_result.kind == "CustomDocumentClassification":
           classification = classification_result.classifications[0]
           print("The document text '{}' was classified as '{}' with confidence score {}.".format(
               doc, classification.category, classification.confidence_score)
           )
       elif classification_result.is_error is True:
           print("Document text '{}' has an error with code '{}' and message '{}'".format(
               doc, classification_result.error.code, classification_result.error.message
           ))

Schließen Sie sockets, die vom Client geöffnet werden. Das Aufrufen dieser Methode ist nicht erforderlich, wenn der Client als Kontext-Manager verwendet wird.

close() -> None

Ausnahmen

HttpResponseError

TypeError

ValueError

Erkennen der Sprache für einen Batch von Dokumenten.

Gibt die erkannte Sprache und einen numerischen Score zwischen 0 und 1 zurück. Ergebnisse in der Nähe von 100% geben an, dass die identifizierte Sprache wahr ist. Die Liste der aktivierten Sprachen finden Sie https://aka.ms/talangs unter.

Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten.

Neu in Version 3.1: Das argument disable_service_logs Schlüsselwort (keyword).

detect_language(documents: List[str] | List[DetectLanguageInput] | List[Dict[str, str]], *, country_hint: str | None = None, disable_service_logs: bool | None = None, model_version: str | None = None, show_stats: bool | None = None, **kwargs: Any) -> List[DetectLanguageResult | DocumentError]

Parameter

documents: list[str] oder list[DetectLanguageInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und die country_hint auf Elementbasis angeben möchten, müssen Sie als Eingabe eine Liste[DetectLanguageInput] oder eine Liste von Diktatdarstellungen von DetectLanguageInputverwenden, z. B. {"id": "1", "country_hint": "us", "text": "hello world"}.

country_hint: str

Hinweis zum Ursprungsland für den gesamten Batch. Akzeptiert länderspezifische Codes mit zwei Buchstaben gemäß ISO 3166-1 Alpha-2. Länderhinweise pro Dokument haben Vorrang vor ganzen Batchhinweisen. Der Standardwert ist "US". Wenn Sie keinen Länderhinweis verwenden möchten, übergeben Sie die Zeichenfolge "none".

model_version: str

Die Modellversion, die für die Analyse verwendet werden soll, z. B. "latest". Wenn keine Modellversion angegeben ist, verwendet die API standardmäßig die neueste Version ohne Vorschauversion. Weitere Informationen finden Sie hier: https://aka.ms/text-analytics-model-versioning

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene im Statistikfeld der Antwort auf Dokumentebene.

disable_service_logs: bool

Wenn true festgelegt ist, deaktivieren Sie die Anmeldung Ihrer Texteingabe auf der Dienstseite zur Problembehandlung. Standardmäßig protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, nur um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Wenn Sie diesen Parameter auf true festlegen, wird die Eingabeprotokollierung deaktiviert, und es kann sein, dass wir probleme beheben können, die auftreten. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

Gibt zurück

Die kombinierte Liste von DetectLanguageResult und DocumentError in der Reihenfolge, in der die Originaldokumente übergeben wurden.

Rückgabetyp

list[DetectLanguageResult,

DocumentError]

Ausnahmen

HttpResponseError

TypeError

ValueError

Beispiele

Erkennen der Sprache in einem Batch von Dokumenten.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]

   text_analytics_client = TextAnalyticsClient(endpoint=endpoint, credential=AzureKeyCredential(key))
   documents = [
       """
       The concierge Paulette was extremely helpful. Sadly when we arrived the elevator was broken, but with Paulette's help we barely noticed this inconvenience.
       She arranged for our baggage to be brought up to our room with no extra charge and gave us a free meal to refurbish all of the calories we lost from
       walking up the stairs :). Can't say enough good things about my experience!
       """,
       """
       最近由于工作压力太大，我们决定去富酒店度假。那儿的温泉实在太舒服了，我跟我丈夫都完全恢复了工作前的青春精神！加油！
       """
   ]

   result = text_analytics_client.detect_language(documents)
   reviewed_docs = [doc for doc in result if not doc.is_error]

   print("Let's see what language each review is in!")

   for idx, doc in enumerate(reviewed_docs):
       print("Review #{} is in '{}', which has ISO639-1 name '{}'\n".format(
           idx, doc.primary_language.name, doc.primary_language.iso6391_name
       ))

Extrahieren Sie Schlüsselbegriffe aus einem Batch von Dokumenten.

Gibt eine Liste von Zeichenfolgen zurück, die die Schlüsselbegriffe im Eingabetext angibt. Beispielsweise gibt die API für den Eingabetext "Das Essen war lecker und es gab wunderbares Personal" die Standard Gesprächspunkte zurück: "Essen" und "wunderbares Personal".

Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten.

Neu in Version 3.1: Das argument disable_service_logs Schlüsselwort (keyword).

extract_key_phrases(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], *, disable_service_logs: bool | None = None, language: str | None = None, model_version: str | None = None, show_stats: bool | None = None, **kwargs: Any) -> List[ExtractKeyPhrasesResult | DocumentError]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

model_version: str

Die Modellversion, die für die Analyse verwendet werden soll, z. B. "latest". Wenn keine Modellversion angegeben ist, verwendet die API standardmäßig die neueste Version ohne Vorschauversion. Weitere Informationen finden Sie hier: https://aka.ms/text-analytics-model-versioning

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene im Statistikfeld der Antwort auf Dokumentebene.

disable_service_logs: bool

Wenn true festgelegt ist, deaktivieren Sie die Anmeldung Ihrer Texteingabe auf der Dienstseite zur Problembehandlung. Standardmäßig protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, nur um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Wenn Sie diesen Parameter auf true festlegen, wird die Eingabeprotokollierung deaktiviert, und es kann sein, dass wir probleme beheben können, die auftreten. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

Gibt zurück

Die kombinierte Liste von ExtractKeyPhrasesResult und DocumentError in der Reihenfolge, in der die Originaldokumente übergeben wurden.

Rückgabetyp

list[ExtractKeyPhrasesResult,

DocumentError]

Ausnahmen

HttpResponseError

TypeError

ValueError

Beispiele

Extrahieren Sie die Schlüsselbegriffe in einem Batch von Dokumenten.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]

   text_analytics_client = TextAnalyticsClient(endpoint=endpoint, credential=AzureKeyCredential(key))
   articles = [
       """
       Washington, D.C. Autumn in DC is a uniquely beautiful season. The leaves fall from the trees
       in a city chock-full of forests, leaving yellow leaves on the ground and a clearer view of the
       blue sky above...
       """,
       """
       Redmond, WA. In the past few days, Microsoft has decided to further postpone the start date of
       its United States workers, due to the pandemic that rages with no end in sight...
       """,
       """
       Redmond, WA. Employees at Microsoft can be excited about the new coffee shop that will open on campus
       once workers no longer have to work remotely...
       """
   ]

   result = text_analytics_client.extract_key_phrases(articles)
   for idx, doc in enumerate(result):
       if not doc.is_error:
           print("Key phrases in article #{}: {}".format(
               idx + 1,
               ", ".join(doc.key_phrases)
           ))

Erkennen von Entitäten für einen Batch von Dokumenten.

Identifiziert und kategorisiert Entitäten in Ihrem Text als Personen, Orte, Organisationen, Datum/Uhrzeit, Mengen, Prozentsätze, Währungen und vieles mehr. Eine Liste der unterstützten Entitätstypen finden Sie unter: https://aka.ms/taner

Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten.

Neu in Version 3.1: Die Argumente disable_service_logs und string_index_type Schlüsselwort (keyword).

recognize_entities(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], *, disable_service_logs: bool | None = None, language: str | None = None, model_version: str | None = None, show_stats: bool | None = None, string_index_type: str | None = None, **kwargs: Any) -> List[RecognizeEntitiesResult | DocumentError]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

model_version: str

Die Modellversion, die für die Analyse verwendet werden soll, z. B. "latest". Wenn keine Modellversion angegeben ist, verwendet die API standardmäßig die neueste Version ohne Vorschauversion. Weitere Informationen finden Sie hier: https://aka.ms/text-analytics-model-versioning

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene im Statistikfeld der Antwort auf Dokumentebene.

string_index_type: str

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. UnicodeCodePoint, die Python-Codierung, ist die Standardeinstellung. Um die Python-Standardeinstellung zu überschreiben, können Sie auch utf16CodeUnit oder TextElement_v8 übergeben. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets

disable_service_logs: bool

Wenn true festgelegt ist, deaktivieren Sie die Anmeldung Ihrer Texteingabe auf der Dienstseite zur Problembehandlung. Standardmäßig protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, nur um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Wenn Sie diesen Parameter auf true festlegen, wird die Eingabeprotokollierung deaktiviert, und es kann sein, dass wir probleme beheben können, die auftreten. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

Gibt zurück

Die kombinierte Liste von RecognizeEntitiesResult und DocumentError in der Reihenfolge, in der die Originaldokumente übergeben wurden.

Rückgabetyp

list[RecognizeEntitiesResult,

DocumentError]

Ausnahmen

HttpResponseError

TypeError

ValueError

Beispiele

Erkennen von Entitäten in einem Batch von Dokumenten.


   import os
   import typing
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]

   text_analytics_client = TextAnalyticsClient(endpoint=endpoint, credential=AzureKeyCredential(key))
   reviews = [
       """I work for Foo Company, and we hired Contoso for our annual founding ceremony. The food
       was amazing and we all can't say enough good words about the quality and the level of service.""",
       """We at the Foo Company re-hired Contoso after all of our past successes with the company.
       Though the food was still great, I feel there has been a quality drop since their last time
       catering for us. Is anyone else running into the same problem?""",
       """Bar Company is over the moon about the service we received from Contoso, the best sliders ever!!!!"""
   ]

   result = text_analytics_client.recognize_entities(reviews)
   result = [review for review in result if not review.is_error]
   organization_to_reviews: typing.Dict[str, typing.List[str]] = {}

   for idx, review in enumerate(result):
       for entity in review.entities:
           print(f"Entity '{entity.text}' has category '{entity.category}'")
           if entity.category == 'Organization':
               organization_to_reviews.setdefault(entity.text, [])
               organization_to_reviews[entity.text].append(reviews[idx])

   for organization, reviews in organization_to_reviews.items():
       print(
           "\n\nOrganization '{}' has left us the following review(s): {}".format(
               organization, "\n\n".join(reviews)
           )
       )

Erkennen von verknüpften Entitäten aus einer bekannten Wissensdatenbank für einen Batch von Dokumenten.

Identifiziert und eindeutig die Identität der einzelnen Entitäten, die im Text gefunden werden (z. B. die Bestimmung, ob sich ein Vorkommen des Worts Mars auf den Planeten oder den römischen Kriegsgott bezieht). Erkannte Entitäten werden URLs einer bekannten Wissensdatenbank wie Wikipedia zugeordnet.

Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten.

Neu in Version 3.1: Die Argumente disable_service_logs und string_index_type Schlüsselwort (keyword).

recognize_linked_entities(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], *, disable_service_logs: bool | None = None, language: str | None = None, model_version: str | None = None, show_stats: bool | None = None, string_index_type: str | None = None, **kwargs: Any) -> List[RecognizeLinkedEntitiesResult | DocumentError]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

model_version: str

Die Modellversion, die für die Analyse verwendet werden soll, z. B. "latest". Wenn keine Modellversion angegeben ist, verwendet die API standardmäßig die neueste Version ohne Vorschauversion. Weitere Informationen finden Sie hier: https://aka.ms/text-analytics-model-versioning

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene im Statistikfeld der Antwort auf Dokumentebene.

string_index_type: str

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. UnicodeCodePoint, die Python-Codierung, ist die Standardeinstellung. Um die Python-Standardeinstellung zu überschreiben, können Sie auch utf16CodeUnit oder TextElement_v8 übergeben. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets

disable_service_logs: bool

Wenn true festgelegt ist, deaktivieren Sie die Anmeldung Ihrer Texteingabe auf der Dienstseite zur Problembehandlung. Standardmäßig protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, nur um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Wenn Sie diesen Parameter auf true festlegen, wird die Eingabeprotokollierung deaktiviert, und es kann sein, dass wir probleme beheben können, die auftreten. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

Gibt zurück

Die kombinierte Liste von RecognizeLinkedEntitiesResult und DocumentError in der Reihenfolge, in der die Originaldokumente übergeben wurden.

Rückgabetyp

list[RecognizeLinkedEntitiesResult,

DocumentError]

Ausnahmen

HttpResponseError

TypeError

ValueError

Beispiele

Erkennen verknüpfter Entitäten in einem Batch von Dokumenten.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]

   text_analytics_client = TextAnalyticsClient(endpoint=endpoint, credential=AzureKeyCredential(key))
   documents = [
       """
       Microsoft was founded by Bill Gates with some friends he met at Harvard. One of his friends,
       Steve Ballmer, eventually became CEO after Bill Gates as well. Steve Ballmer eventually stepped
       down as CEO of Microsoft, and was succeeded by Satya Nadella.
       Microsoft originally moved its headquarters to Bellevue, Washington in January 1979, but is now
       headquartered in Redmond.
       """
   ]

   result = text_analytics_client.recognize_linked_entities(documents)
   docs = [doc for doc in result if not doc.is_error]

   print(
       "Let's map each entity to it's Wikipedia article. I also want to see how many times each "
       "entity is mentioned in a document\n\n"
   )
   entity_to_url = {}
   for doc in docs:
       for entity in doc.entities:
           print("Entity '{}' has been mentioned '{}' time(s)".format(
               entity.name, len(entity.matches)
           ))
           if entity.data_source == "Wikipedia":
               entity_to_url[entity.name] = entity.url

Erkennen von Entitäten, die personenbezogene Informationen für einen Batch von Dokumenten enthalten.

Gibt eine Liste der Entitäten personenbezogener Informationen ("SSN", "Bankkonto" usw.) im Dokument zurück. Eine Liste der unterstützten Entitätstypen finden Sie unter https://aka.ms/azsdk/language/pii

Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten.

Neu in Version 3.1: Die recognize_pii_entities Clientmethode.

recognize_pii_entities(documents: List[str] | List[TextDocumentInput] | List[Dict[str, str]], *, categories_filter: List[str | PiiEntityCategory] | None = None, disable_service_logs: bool | None = None, domain_filter: str | PiiEntityDomain | None = None, language: str | None = None, model_version: str | None = None, show_stats: bool | None = None, string_index_type: str | None = None, **kwargs: Any) -> List[RecognizePiiEntitiesResult | DocumentError]

Parameter

documents: list[str] oder list[TextDocumentInput] oder list[dict[str, str]]

Erforderlich

Der Satz von Dokumenten, die als Teil dieses Batches verarbeitet werden sollen. Wenn Sie die ID und sprache pro Element angeben möchten, müssen Sie als Eingabe eine Liste[TextDocumentInput] oder eine Liste von Diktatdarstellungen von TextDocumentInputverwenden, z. B. {"id": "1", "language": "en", "text": "hello world"}.

language: str

Die 2 Buchstaben ISO 639-1 Darstellung der Sprache für den gesamten Batch. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird "en" für Englisch als Standard verwendet. Die Pro-Dokument-Sprache hat Vorrang vor der gesamten Batchsprache. Unter Unterstützte Sprachen finden Sie https://aka.ms/talangs in der Sprach-API.

model_version: str

Die Modellversion, die für die Analyse verwendet werden soll, z. B. "latest". Wenn keine Modellversion angegeben ist, verwendet die API standardmäßig die neueste Version ohne Vorschauversion. Weitere Informationen finden Sie hier: https://aka.ms/text-analytics-model-versioning

show_stats: bool

Wenn diese Einstellung auf TRUE festgelegt ist, enthält die Antwort Statistiken auf Dokumentebene im Statistikfeld der Antwort auf Dokumentebene.

domain_filter: str oder PiiEntityDomain

Filtert die Antwortentitäten auf die Entitäten, die nur in der angegebenen Domäne enthalten sind. Wenn sie also auf "phi" festgelegt ist, werden nur Entitäten in der Domäne "Geschützte Gesundheitsinformationen" zurückgegeben. Weitere Informationen finden Sie unter https://aka.ms/azsdk/language/pii.

categories_filter: list[str oder PiiEntityCategory]

Anstatt alle Kategorien von PII-Entitäten zu filtern, können Sie eine Liste der spezifischen personenbezogene Entitätskategorien übergeben, die Sie herausfiltern möchten. Wenn Sie beispielsweise nur US-Sozialversicherungsnummern in einem Dokument herausfiltern möchten, können Sie [PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER] für diesen Kwarg übergeben.

string_index_type: str

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. UnicodeCodePoint, die Python-Codierung, ist die Standardeinstellung. Um die Python-Standardeinstellung zu überschreiben, können Sie auch utf16CodeUnit oder TextElement_v8 übergeben. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets

disable_service_logs: bool

Der Standardwert ist true, d. h. der Sprachdienst protokolliert Ihren Eingabetext nicht auf der Dienstseite zur Problembehandlung. Wenn dieser Wert auf False festgelegt ist, protokolliert der Sprachdienst Ihren Eingabetext 48 Stunden lang, um die Behandlung von Problemen bei der Bereitstellung der Verarbeitungsfunktionen für natürliche Sprache des Diensts zu ermöglichen. Weitere Details finden Sie unter Compliance- und Datenschutzhinweise für https://aka.ms/cs-compliance Cognitive Services und Prinzipien für verantwortungsbewusste KI von Microsoft unter https://www.microsoft.com/ai/responsible-ai.

Gibt zurück

Die kombinierte Liste von RecognizePiiEntitiesResult und DocumentError in der Reihenfolge, in der die Originaldokumente übergeben wurden.

Rückgabetyp

list[RecognizePiiEntitiesResult,

DocumentError]

Ausnahmen

HttpResponseError

TypeError

ValueError

Beispiele

Erkennen persönlich identifizierbarer Informationsentitäten in einem Batch von Dokumenten.


   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.textanalytics import TextAnalyticsClient

   endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"]
   key = os.environ["AZURE_LANGUAGE_KEY"]

   text_analytics_client = TextAnalyticsClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )
   documents = [
       """Parker Doe has repaid all of their loans as of 2020-04-25.
       Their SSN is 859-98-0987. To contact them, use their phone number
       555-555-5555. They are originally from Brazil and have Brazilian CPF number 998.214.865-68"""
   ]

   result = text_analytics_client.recognize_pii_entities(documents)
   docs = [doc for doc in result if not doc.is_error]

   print(
       "Let's compare the original document with the documents after redaction. "
       "I also want to comb through all of the entities that got redacted"
   )
   for idx, doc in enumerate(docs):
       print(f"Document text: {documents[idx]}")
       print(f"Redacted document text: {doc.redacted_text}")
       for entity in doc.entities:
           print("...Entity '{}' with category '{}' got redacted".format(
               entity.text, entity.category
           ))

analyze_sentiment	Analysieren der Stimmung für einen Batch von Dokumenten. Aktivieren Sie Opinion Mining mit show_opinion_mining. Gibt eine Stimmungsvorhersage sowie Stimmungsbewertungen für jede Stimmungsklasse (Positiv, Negativ und Neutral) für das Dokument und jeden darin enthaltenen Satz zurück. Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten. Neu in Version 3.1: Die Argumente show_opinion_mining, disable_service_logs und string_index_type Schlüsselwort (keyword).
begin_abstract_summary	Starten Sie einen zeitintensiven abstraktiven Zusammenfassungsvorgang. Eine konzeptionelle Erläuterung der abstrakten Zusammenfassung finden Sie in der Dienstdokumentation: https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/overview Neu in Version 2023-04-01: Die begin_abstract_summary Clientmethode.
begin_analyze_actions	Starten Sie einen zeitintensiven Vorgang, um eine Vielzahl von Textanalyseaktionen für einen Batch von Dokumenten auszuführen. Es wird empfohlen, diese Funktion zu verwenden, wenn Sie größere Dokumente analysieren und/oder mehrere Textanalyseaktionen in einem Aufruf kombinieren möchten. Andernfalls wird empfohlen, die aktionsspezifischen Endpunkte zu verwenden, z. B analyze_sentiment. . Hinweis Informationen zur regionalen Unterstützung benutzerdefinierter Aktionsfeatures finden Sie in der Dienstdokumentation: https://aka.ms/azsdk/textanalytics/customfunctionalities Neu in Version 3.1: Die begin_analyze_actions Clientmethode. Neu in Version 2022-05-01: Die Eingabeoptionen RecognizeCustomEntitiesAction, SingleLabelClassifyAction, MultiLabelClassifyAction und AnalyzeHealthcareEntitiesAction sowie die entsprechenden RecognizeCustomEntitiesResult,ClassifyDocumentResult und AnalyzeHealthcareEntitiesResult-Ergebnisobjekte Neu in Version 2023-04-01: Die Eingabeoptionen ExtractiveSummaryAction und AbstractiveSummaryAction sowie die entsprechenden ExtractiveSummaryResult - und AbstractiveSummaryResult-Ergebnisobjekte .
begin_analyze_healthcare_entities	Analysieren Sie Entitäten im Gesundheitswesen, und identifizieren Sie Beziehungen zwischen diesen Entitäten in einem Batch von Dokumenten. Entitäten sind Verweisen zugeordnet, die in vorhandenen Wissensdatenbanken wie UMLS, CHV, MSH usw. gefunden werden können. Wir extrahieren auch die Beziehungen zwischen Entitäten, z. B. in "Der Antragsteller nahm 100 mg Ibuprofen", wir würden die Beziehung zwischen der Dosierung "100 mg" und dem "Ibuprofen" Medikament extrahieren. Neu in Version 3.1: Die begin_analyze_healthcare_entities Clientmethode. Neu in Version 2022-05-01: Das argument display_name Schlüsselwort (keyword).
begin_extract_summary	Starten Sie einen zeitintensiven extraktiven Zusammenfassungsvorgang. Eine konzeptionelle Erläuterung der extraktiven Zusammenfassung finden Sie in der Dienstdokumentation: https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/overview Neu in Version 2023-04-01: Die begin_extract_summary Clientmethode.
begin_multi_label_classify	Starten Sie einen lang andauernden benutzerdefinierten Klassifizierungsvorgang mit mehreren Bezeichnungen. Informationen zur regionalen Unterstützung benutzerdefinierter Features und zum Trainieren eines Modells zum Klassifizieren Ihrer Dokumente finden Sie unter https://aka.ms/azsdk/textanalytics/customfunctionalities Neu in Version 2022-05-01: Die begin_multi_label_classify Clientmethode.
begin_recognize_custom_entities	Starten Sie einen zeitintensiven benutzerdefinierten Vorgang zur Erkennung benannter Entitäten. Informationen zur regionalen Unterstützung benutzerdefinierter Features und zum Trainieren eines Modells zum Erkennen benutzerdefinierter Entitäten finden Sie unter https://aka.ms/azsdk/textanalytics/customentityrecognition Neu in Version 2022-05-01: Die begin_recognize_custom_entities Clientmethode.
begin_single_label_classify	Starten Sie einen lang andauernden benutzerdefinierten Klassifizierungsvorgang für eine einzelne Bezeichnung. Informationen zur regionalen Unterstützung benutzerdefinierter Features und zum Trainieren eines Modells zum Klassifizieren Ihrer Dokumente finden Sie unter https://aka.ms/azsdk/textanalytics/customfunctionalities Neu in Version 2022-05-01: Die begin_single_label_classify Clientmethode.
close	Schließen Sie sockets, die vom Client geöffnet werden. Das Aufrufen dieser Methode ist nicht erforderlich, wenn der Client als Kontext-Manager verwendet wird.
detect_language	Erkennen der Sprache für einen Batch von Dokumenten. Gibt die erkannte Sprache und einen numerischen Score zwischen 0 und 1 zurück. Ergebnisse in der Nähe von 100% geben an, dass die identifizierte Sprache wahr ist. Die Liste der aktivierten Sprachen finden Sie https://aka.ms/talangs unter. Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten. Neu in Version 3.1: Das argument disable_service_logs Schlüsselwort (keyword).
extract_key_phrases	Extrahieren Sie Schlüsselbegriffe aus einem Batch von Dokumenten. Gibt eine Liste von Zeichenfolgen zurück, die die Schlüsselbegriffe im Eingabetext angibt. Beispielsweise gibt die API für den Eingabetext "Das Essen war lecker und es gab wunderbares Personal" die Standard Gesprächspunkte zurück: "Essen" und "wunderbares Personal". Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten. Neu in Version 3.1: Das argument disable_service_logs Schlüsselwort (keyword).
recognize_entities	Erkennen von Entitäten für einen Batch von Dokumenten. Identifiziert und kategorisiert Entitäten in Ihrem Text als Personen, Orte, Organisationen, Datum/Uhrzeit, Mengen, Prozentsätze, Währungen und vieles mehr. Eine Liste der unterstützten Entitätstypen finden Sie unter: https://aka.ms/taner Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten. Neu in Version 3.1: Die Argumente disable_service_logs und string_index_type Schlüsselwort (keyword).
recognize_linked_entities	Erkennen von verknüpften Entitäten aus einer bekannten Wissensdatenbank für einen Batch von Dokumenten. Identifiziert und eindeutig die Identität der einzelnen Entitäten, die im Text gefunden werden (z. B. die Bestimmung, ob sich ein Vorkommen des Worts Mars auf den Planeten oder den römischen Kriegsgott bezieht). Erkannte Entitäten werden URLs einer bekannten Wissensdatenbank wie Wikipedia zugeordnet. Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten. Neu in Version 3.1: Die Argumente disable_service_logs und string_index_type Schlüsselwort (keyword).
recognize_pii_entities	Erkennen von Entitäten, die personenbezogene Informationen für einen Batch von Dokumenten enthalten. Gibt eine Liste der Entitäten personenbezogener Informationen ("SSN", "Bankkonto" usw.) im Dokument zurück. Eine Liste der unterstützten Entitätstypen finden Sie unter https://aka.ms/azsdk/language/pii Weitere Informationen finden Sie https://aka.ms/azsdk/textanalytics/data-limits unter Grenzwerte für Dienstdaten. Neu in Version 3.1: Die recognize_pii_entities Clientmethode.

TextAnalyticsClient Klasse

Konstruktor

Parameter

Beispiele

Methoden

analyze_sentiment

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

begin_abstract_summary

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

begin_analyze_actions

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

begin_analyze_healthcare_entities

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

begin_extract_summary

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

begin_multi_label_classify

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

begin_recognize_custom_entities

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

begin_single_label_classify

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

close

Ausnahmen

detect_language

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

extract_key_phrases

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

recognize_entities

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

recognize_linked_entities

Parameter

Gibt zurück

Rückgabetyp

Ausnahmen

Beispiele

recognize_pii_entities