azure.ai.textanalytics.TextAnalyticsClient class

Analizowanie tonacji dla partii dokumentów. Włącz górnictwo opinii przy użyciu show_opinion_mining.

Zwraca przewidywanie tonacji, a także wyniki tonacji dla każdej klasy tonacji (pozytywne, ujemne i neutralne) dla dokumentu i każdego zdania w nim.

Zobacz, aby zapoznać się https://aka.ms/azsdk/textanalytics/data-limits z limitami danych usługi.

Nowość w wersji 3.1: argumenty słów kluczowych show_opinion_mining, disable_service_logs i string_index_type .

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]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji dyktowych, TextDocumentInputtakich jak {"id": "1", "language": "en", "text": "hello world"}.

show_opinion_mining: bool

Czy poznać opinie zdania i przeprowadzić bardziej szczegółową analizę aspektów produktu lub usługi (znanej również jako analiza tonacji opartej na aspektach). Jeśli ustawiono wartość true, zwrócone SentenceSentiment obiekty będą miały właściwość mined_opinions zawierającą wynik tej analizy. Dostępne tylko dla interfejsu API w wersji 3.1 i nowszej.

language: str

2 litera ISO 639-1 reprezentacja języka dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

model_version: str

Wersja modelu do użycia na potrzeby analizy, np. "latest". Jeśli wersja modelu nie zostanie określona, interfejs API będzie domyślnie korzystać z najnowszej, innej niż wersja zapoznawcza. Zobacz tutaj, aby uzyskać więcej informacji: https://aka.ms/text-analytics-model-versioning

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki na poziomie dokumentu w polu statystyk odpowiedzi na poziomie dokumentu.

string_index_type: str

Określa metodę używaną do interpretowania przesunięcia ciągów. UnicodeCodePoint, kodowanie języka Python, jest wartością domyślną. Aby zastąpić wartość domyślną języka Python, możesz również przekazać ciąg Utf16CodeUnit lub TextElement_v8. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets

disable_service_logs: bool

Jeśli ustawiono wartość true, zrezygnowasz z logowania tekstu po stronie usługi w celu rozwiązywania problemów. Domyślnie usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Ustawienie tego parametru na wartość true powoduje wyłączenie rejestrowania danych wejściowych i może ograniczyć możliwość korygowania występujących problemów. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnej sztucznej inteligencji, zobacz Informacje o zgodności i ochronie prywatności usług Cognitive Services pod https://aka.ms/cs-compliance adresem https://www.microsoft.com/ai/responsible-ai.

Zwraca

Połączona lista AnalyzeSentimentResult i DocumentError w kolejności przekazania oryginalnych dokumentów.

Typ zwracany

list[AnalyzeSentimentResult,

DocumentError]

Wyjątki

HttpResponseError

TypeError

ValueError

Przykłady

Analizowanie tonacji w partii dokumentów.


   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}")

Rozpocznij długotrwałą operację podsumowania abstrakcyjnego.

Aby zapoznać się z koncepcyjnym omówieniem podsumowania abstrakcyjnego, zobacz dokumentację usługi: https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/overview

Nowość w wersji 2023-04-01: metoda klienta begin_abstract_summary .

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]]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji dyktowych, TextDocumentInputtakich jak {"id": "1", "language": "en", "text": "hello world"}.

language: str

2 litera ISO 639-1 reprezentacja języka dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki na poziomie dokumentu.

sentence_count: Optional[int]

Steruje przybliżoną liczbą zdań w podsumowaniach danych wyjściowych.

model_version: Optional[str]

Wersja modelu do użycia na potrzeby analizy, np. "latest". Jeśli wersja modelu nie zostanie określona, interfejs API będzie domyślnie korzystać z najnowszej, innej niż wersja zapoznawcza. Zobacz tutaj, aby uzyskać więcej informacji: https://aka.ms/text-analytics-model-versioning

string_index_type: Optional[str]

Określa metodę używaną do interpretowania przesunięcia ciągów.

disable_service_logs: bool

Jeśli ustawiono wartość true, zrezygnowasz z logowania tekstu po stronie usługi w celu rozwiązywania problemów. Domyślnie usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Ustawienie tego parametru na wartość true powoduje wyłączenie rejestrowania danych wejściowych i może ograniczyć możliwość korygowania występujących problemów. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnej sztucznej inteligencji, zobacz Informacje o zgodności i ochronie prywatności usług Cognitive Services pod https://aka.ms/cs-compliance adresem https://www.microsoft.com/ai/responsible-ai.

polling_interval: int

Czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka. Wartość domyślna to 5 sekund.

continuation_token: str

Wywołaj continuation_token() w obiekcie poller, aby zapisać stan długotrwałej operacji (LRO) do nieprzezroczystego tokenu. Przekaż wartość jako argument słowa kluczowego continuation_token , aby ponownie uruchomić funkcję LRO ze stanu zapisanego.

display_name: str

Opcjonalna nazwa wyświetlana ustawiona dla żądanej analizy.

Zwraca

Wystąpienie elementu TextAnalysisLROPoller. Wywołaj wynik() dla tego obiektu, aby zwrócić heterogeniczny stronicowy element AbstractiveSummaryResult i DocumentError.

Typ zwracany

TextAnalysisLROPoller[ItemPaged[ AbstractiveSummaryResult,

DocumentError]]

Wyjątki

HttpResponseError

Przykłady

Wykonywanie podsumowania abstrakcyjnego w partii dokumentów.


   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
           ))

Rozpocznij długotrwałą operację, aby wykonać różne akcje analizy tekstu w partii dokumentów.

Zalecamy użycie tej funkcji, jeśli chcesz analizować większe dokumenty i /lub połączyć wiele akcji analizy tekstu w jedno wywołanie. W przeciwnym razie zalecamy użycie określonych punktów końcowych akcji, na przykład analyze_sentiment.

Uwaga

Zapoznaj się z dokumentacją usługi, aby uzyskać pomoc regionalną dotyczącą funkcji akcji niestandardowych:

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

Nowość w wersji 3.1: metoda klienta begin_analyze_actions .

Nowość w wersji 2022-05-01: RecognizeCustomEntitiesAction, SingleLabelClassifyAction, MultiLabelClassifyAction i AnalyzeHealthcareEntitiesAction opcje wejściowe oraz odpowiadające im obiekty wejściowe RecognizeCustomEntitiesResult, ClassifyDocumentResult i AnalyzeHealthcareEntitiesResult

Nowość w wersji 2023-04-01: Obiekty wyniku ExtractiveSummaryAction i AbstractiveSummaryAction oraz odpowiadające im obiekty wynikowe ExtractiveSummaryResult i AbstractiveSummaryResult .

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]]]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji dyktowych, TextDocumentInputtakich jak {"id": "1", "language": "en", "text": "hello world"}.

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

Wymagane

Heterogeniczna lista akcji do wykonania w dokumentach wejściowych. Każdy obiekt akcji hermetyzuje parametry używane dla określonego typu akcji. Wyniki akcji będą mieć taką samą kolejność akcji wejściowych.

display_name: str

Opcjonalna nazwa wyświetlana ustawiona dla żądanej analizy.

language: str

2 litera ISO 639-1 reprezentacja języka dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki na poziomie dokumentu.

polling_interval: int

Czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka. Wartość domyślna to 5 sekund.

continuation_token: str

Wywołaj continuation_token() w obiekcie poller, aby zapisać stan długotrwałej operacji (LRO) do nieprzezroczystego tokenu. Przekaż wartość jako argument słowa kluczowego continuation_token , aby ponownie uruchomić funkcję LRO ze stanu zapisanego.

Zwraca

Wystąpienie elementu TextAnalysisLROPoller. Wywołaj wynik() w obiekcie poller, aby zwrócić stronicową heterogeniczną listę list. Ta lista list jest najpierw uporządkowana przez wprowadzone dokumenty, a następnie uporządkowana przez wprowadzone akcje. Jeśli na przykład masz dokumenty wejściowe ["Hello", "world"] i akcje RecognizeEntitiesAction oraz , podczas AnalyzeSentimentActioniterowania listy list najpierw iterujesz wyniki akcji dla dokumentu "Hello", otrzymujesz RecognizeEntitiesResult wartość "Hello", a następnie AnalyzeSentimentResult "Hello". Następnie uzyskasz RecognizeEntitiesResult i AnalyzeSentimentResult "świata".

Typ zwracany

TextAnalysisLROPoller[ItemPaged[ list[RecognizeEntitiesResult,

RecognizeLinkedEntitiesResult,

RecognizePiiEntitiesResult,

ExtractKeyPhrasesResult,

AnalyzeSentimentResult,

RecognizeCustomEntitiesResult,

ClassifyDocumentResult,

AnalyzeHealthcareEntitiesResult,

ExtractiveSummaryResult,

AbstractiveSummaryResult,

DocumentError]]]

Wyjątki

HttpResponseError

TypeError

ValueError

Przykłady

Rozpocznij długotrwałą operację, aby wykonać różne akcje analizy tekstu w partii dokumentów.


   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("------------------------------------------")

Analizowanie jednostek opieki zdrowotnej i identyfikowanie relacji między tymi jednostkami w partii dokumentów.

Jednostki są skojarzone z odwołaniami, które można znaleźć w istniejących bazach wiedzy, takich jak UMLS, CHV, MSH itp.

Wyodrębniamy również relacje znalezione między jednostkami, na przykład w "Temat wziął 100 mg ibuprofenu", wyodrębnimy związek między "100 mg" dawki i "ibuprofen" leki.

Nowość w wersji 3.1: metoda klienta begin_analyze_healthcare_entities .

Nowość w wersji 2022-05-01: argument słowa kluczowego display_name .

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]]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji TextDocumentInputdyktowania , takich jak {"id": "1", "language": "en", "text": "hello world"}.

model_version: str

Wersja modelu używana do analizy, np. "latest". Jeśli wersja modelu nie zostanie określona, interfejs API będzie domyślnie korzystać z najnowszej, innej niż wersja zapoznawcza. Aby uzyskać więcej informacji, zobacz tutaj: https://aka.ms/text-analytics-model-versioning

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki poziomu dokumentu.

language: str

Dwuliterowa reprezentacja języka ISO 639-1 dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

display_name: str

Opcjonalna nazwa wyświetlana ustawiana dla żądanej analizy.

string_index_type: str

Określa metodę używaną do interpretowania przesunięć ciągów. Kodowanie UnicodeCodePoint w języku Python jest wartością domyślną. Aby zastąpić wartość domyślną języka Python, możesz również przekazać wartość Utf16CodeUnit lub TextElement_v8. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets

polling_interval: int

Czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka. Wartość domyślna to 5 sekund.

continuation_token: str

Wywołaj metodę continuation_token() w obiekcie poller, aby zapisać stan długotrwałej operacji (LRO) w nieprzezroczystych tokenach. Przekaż wartość jako argument słowa kluczowego continuation_token , aby ponownie uruchomić LRO z zapisanego stanu.

disable_service_logs: bool

Wartość domyślna to true, co oznacza, że usługa językowa nie będzie rejestrować tekstu wejściowego po stronie usługi na potrzeby rozwiązywania problemów. W przypadku ustawienia wartości Fałsz usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnego używania sztucznej inteligencji, zobacz Informacje https://aka.ms/cs-compliance o zgodności i ochronie prywatności w usługach Cognitive Services na stronie https://www.microsoft.com/ai/responsible-ai.

Zwraca

Wystąpienie elementu AnalyzeHealthcareEntitiesLROPoller. Wywołaj metodę result() dla tego obiektu, aby zwrócić heterogeniczne stronicowalne wartości AnalyzeHealthcareEntitiesResult i DocumentError.

Typ zwracany

AnalyzeHealthcareEntitiesLROPoller[ItemPaged[ AnalyzeHealthcareEntitiesResult,

DocumentError]]

Wyjątki

HttpResponseError

TypeError

ValueError

Przykłady

Rozpoznawanie jednostek opieki zdrowotnej w partii dokumentów.


   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
   ]

Uruchom długotrwałą operację podsumowania wyodrębniającego.

Aby zapoznać się z koncepcyjnym omówieniem podsumowania wyodrębnianego, zobacz dokumentację usługi: https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/overview

Nowość w wersji 2023-04-01: metoda klienta begin_extract_summary .

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]]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji TextDocumentInputdyktowania , takich jak {"id": "1", "language": "en", "text": "hello world"}.

language: str

Dwuliterowa reprezentacja języka ISO 639-1 dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki poziomu dokumentu.

max_sentence_count: Optional[int]

Maksymalna liczba zdań do zwrócenia. Wartość domyślna to 3.

order_by: Optional[str]

Możliwe wartości to: "Przesunięcie", "Ranga". Wartość domyślna: "Przesunięcie".

model_version: Optional[str]

Wersja modelu używana do analizy, np. "latest". Jeśli wersja modelu nie zostanie określona, interfejs API będzie domyślnie korzystać z najnowszej, innej niż wersja zapoznawcza. Aby uzyskać więcej informacji, zobacz tutaj: https://aka.ms/text-analytics-model-versioning

string_index_type: Optional[str]

Określa metodę używaną do interpretowania przesunięć ciągów.

disable_service_logs: bool

W przypadku ustawienia wartości true użytkownik zrezygnował z rejestrowania tekstu po stronie usługi w celu rozwiązywania problemów. Domyślnie usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Ustawienie tego parametru na wartość true powoduje wyłączenie rejestrowania danych wejściowych i może ograniczyć możliwość korygowania występujących problemów. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnego używania sztucznej inteligencji, zobacz Informacje https://aka.ms/cs-compliance o zgodności i ochronie prywatności w usługach Cognitive Services na stronie https://www.microsoft.com/ai/responsible-ai.

polling_interval: int

Czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka. Wartość domyślna to 5 sekund.

continuation_token: str

Wywołaj metodę continuation_token() w obiekcie poller, aby zapisać stan długotrwałej operacji (LRO) w nieprzezroczystych tokenach. Przekaż wartość jako argument słowa kluczowego continuation_token , aby ponownie uruchomić LRO z zapisanego stanu.

display_name: str

Opcjonalna nazwa wyświetlana ustawiana dla żądanej analizy.

Zwraca

Wystąpienie elementu TextAnalysisLROPoller. Wywołaj metodę result() dla tego obiektu, aby zwrócić heterogeniczne stronicowalne wartości ExtractiveSummaryResult i DocumentError.

Typ zwracany

TextAnalysisLROPoller[ItemPaged[ ExtractiveSummaryResult,

DocumentError]]

Wyjątki

HttpResponseError

Przykłady

Wykonywanie podsumowania wyodrębnianego w partii dokumentów.


   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
           ))

Rozpocznij długotrwałą operację klasyfikacji z wieloma etykietami.

Aby uzyskać informacje na temat regionalnej obsługi funkcji niestandardowych i sposobu trenowania modelu w celu klasyfikowania dokumentów, zobacz https://aka.ms/azsdk/textanalytics/customfunctionalities

Nowość w wersji 2022-05-01: metoda klienta begin_multi_label_classify .

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]]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji TextDocumentInputdyktowania , takich jak {"id": "1", "language": "en", "text": "hello world"}.

project_name: str

Wymagane

Wymagane. To pole wskazuje nazwę projektu dla modelu.

deployment_name: str

Wymagane

To pole wskazuje nazwę wdrożenia modelu.

language: str

Dwuliterowa reprezentacja języka ISO 639-1 dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki poziomu dokumentu.

disable_service_logs: bool

W przypadku ustawienia wartości true użytkownik zrezygnował z rejestrowania tekstu po stronie usługi w celu rozwiązywania problemów. Domyślnie usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Ustawienie tego parametru na wartość true powoduje wyłączenie rejestrowania danych wejściowych i może ograniczyć możliwość korygowania występujących problemów. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnego używania sztucznej inteligencji, zobacz Informacje https://aka.ms/cs-compliance o zgodności i ochronie prywatności w usługach Cognitive Services na stronie https://www.microsoft.com/ai/responsible-ai.

polling_interval: int

Czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka. Wartość domyślna to 5 sekund.

continuation_token: str

Wywołaj metodę continuation_token() w obiekcie poller, aby zapisać stan długotrwałej operacji (LRO) w nieprzezroczystych tokenach. Przekaż wartość jako argument słowa kluczowego continuation_token , aby ponownie uruchomić LRO z zapisanego stanu.

display_name: str

Opcjonalna nazwa wyświetlana ustawiana dla żądanej analizy.

Zwraca

Wystąpienie elementu TextAnalysisLROPoller. Wywołaj metodę result() dla tego obiektu, aby zwrócić heterogeniczne stronicowalne wartości ClassifyDocumentResult i DocumentError.

Typ zwracany

TextAnalysisLROPoller[ItemPaged[ ClassifyDocumentResult,

DocumentError]]

Wyjątki

HttpResponseError

Przykłady

Wykonywanie klasyfikacji wielu etykiet na partii dokumentów.


   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
           ))

Uruchom długotrwałą operację rozpoznawania nazwanych jednostek.

Aby uzyskać informacje na temat regionalnej obsługi funkcji niestandardowych i sposobu trenowania modelu w celu rozpoznawania jednostek niestandardowych, zobacz https://aka.ms/azsdk/textanalytics/customentityrecognition

Nowość w wersji 2022-05-01: metoda klienta begin_recognize_custom_entities .

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]]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji TextDocumentInputdyktowania , takich jak {"id": "1", "language": "en", "text": "hello world"}.

project_name: str

Wymagane

Wymagane. To pole wskazuje nazwę projektu dla modelu.

deployment_name: str

Wymagane

To pole wskazuje nazwę wdrożenia modelu.

language: str

Dwuliterowa reprezentacja języka ISO 639-1 dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki poziomu dokumentu.

disable_service_logs: bool

W przypadku ustawienia wartości true użytkownik zrezygnował z rejestrowania tekstu po stronie usługi w celu rozwiązywania problemów. Domyślnie usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Ustawienie tego parametru na wartość true powoduje wyłączenie rejestrowania danych wejściowych i może ograniczyć możliwość korygowania występujących problemów. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnego używania sztucznej inteligencji, zobacz Informacje https://aka.ms/cs-compliance o zgodności i ochronie prywatności w usługach Cognitive Services na stronie https://www.microsoft.com/ai/responsible-ai.

string_index_type: str

Określa metodę używaną do interpretowania przesunięć ciągów. Kodowanie UnicodeCodePoint w języku Python jest wartością domyślną. Aby zastąpić wartość domyślną języka Python, możesz również przekazać wartość Utf16CodeUnit lub TextElement_v8. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets

polling_interval: int

Czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka. Wartość domyślna to 5 sekund.

continuation_token: str

Wywołaj metodę continuation_token() w obiekcie poller, aby zapisać stan długotrwałej operacji (LRO) w nieprzezroczystych tokenach. Przekaż wartość jako argument słowa kluczowego continuation_token , aby ponownie uruchomić LRO z zapisanego stanu.

display_name: str

Opcjonalna nazwa wyświetlana ustawiana dla żądanej analizy.

Zwraca

Wystąpienie elementu TextAnalysisLROPoller. Wywołaj metodę result() dla tego obiektu, aby zwrócić heterogeniczne stronicowalne wartości RecognizeCustomEntitiesResult i DocumentError.

Typ zwracany

TextAnalysisLROPoller[ItemPaged[ RecognizeCustomEntitiesResult,

DocumentError]]

Wyjątki

HttpResponseError

Przykłady

Rozpoznawanie jednostek niestandardowych w partii dokumentów.


   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
               )
           )

Rozpocznij długotrwałą operację klasyfikacji z pojedynczą etykietą.

Aby uzyskać informacje na temat regionalnej obsługi funkcji niestandardowych i sposobu trenowania modelu w celu klasyfikowania dokumentów, zobacz https://aka.ms/azsdk/textanalytics/customfunctionalities

Nowość w wersji 2022-05-01: metoda klienta begin_single_label_classify .

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]]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji TextDocumentInputdyktowania , takich jak {"id": "1", "language": "en", "text": "hello world"}.

project_name: str

Wymagane

Wymagane. To pole wskazuje nazwę projektu dla modelu.

deployment_name: str

Wymagane

To pole wskazuje nazwę wdrożenia modelu.

language: str

Dwuliterowa reprezentacja języka ISO 639-1 dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki poziomu dokumentu.

disable_service_logs: bool

W przypadku ustawienia wartości true użytkownik zrezygnował z rejestrowania tekstu po stronie usługi w celu rozwiązywania problemów. Domyślnie usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Ustawienie tego parametru na wartość true powoduje wyłączenie rejestrowania danych wejściowych i może ograniczyć możliwość korygowania występujących problemów. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnego używania sztucznej inteligencji, zobacz Informacje https://aka.ms/cs-compliance o zgodności i ochronie prywatności w usługach Cognitive Services na stronie https://www.microsoft.com/ai/responsible-ai.

polling_interval: int

Czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka. Wartość domyślna to 5 sekund.

continuation_token: str

Wywołaj metodę continuation_token() w obiekcie poller, aby zapisać stan długotrwałej operacji (LRO) w nieprzezroczystych tokenach. Przekaż wartość jako argument słowa kluczowego continuation_token , aby ponownie uruchomić LRO z zapisanego stanu.

display_name: str

Opcjonalna nazwa wyświetlana ustawiana dla żądanej analizy.

Zwraca

Wystąpienie elementu TextAnalysisLROPoller. Wywołaj metodę result() dla tego obiektu, aby zwrócić heterogeniczne stronicowalne wartości ClassifyDocumentResult i DocumentError.

Typ zwracany

TextAnalysisLROPoller[ItemPaged[ ClassifyDocumentResult,

DocumentError]]

Wyjątki

HttpResponseError

Przykłady

Wykonywanie klasyfikacji pojedynczej etykiety na partii dokumentów.


   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
           ))

Zamknij gniazda otwarte przez klienta. Wywoływanie tej metody jest niepotrzebne w przypadku korzystania z klienta jako menedżera kontekstu.

close() -> None

Wyjątki

HttpResponseError

TypeError

ValueError

Wykrywanie języka dla partii dokumentów.

Zwraca wykryty język i wynik liczbowy z zakresu od zera do jednego. Wyniki zbliżone do jednego wskazują 100% pewności, że zidentyfikowany język jest prawdziwy. Zobacz https://aka.ms/talangs listę obsługiwanych języków.

Zobacz https://aka.ms/azsdk/textanalytics/data-limits limity danych usługi.

Nowość w wersji 3.1: argument słowa kluczowego disable_service_logs .

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]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i country_hint dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[DetectLanguageInput] lub listy reprezentacji DetectLanguageInputdyktowania , takich jak {"id": "1", "country_hint": "us", "text": "hello world"}.

country_hint: str

Wskazówka dotycząca kraju pochodzenia dla całej partii. Akceptuje dwa litery kody krajów określone przez ISO 3166-1 alfa-2. Wskazówki dotyczące poszczególnych krajów będą miały pierwszeństwo przed całymi wskazówkami partii. Wartość domyślna to "US". Jeśli nie chcesz używać wskazówki dotyczącej kraju, przekaż ciąg "none".

model_version: str

Wersja modelu używana do analizy, np. "latest". Jeśli wersja modelu nie zostanie określona, interfejs API będzie domyślnie korzystać z najnowszej, innej niż wersja zapoznawcza. Aby uzyskać więcej informacji, zobacz tutaj: https://aka.ms/text-analytics-model-versioning

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki na poziomie dokumentu w polu statystyk odpowiedzi na poziomie dokumentu.

disable_service_logs: bool

W przypadku ustawienia wartości true użytkownik zrezygnował z rejestrowania tekstu po stronie usługi w celu rozwiązywania problemów. Domyślnie usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Ustawienie tego parametru na wartość true powoduje wyłączenie rejestrowania danych wejściowych i może ograniczyć możliwość korygowania występujących problemów. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnego używania sztucznej inteligencji, zobacz Informacje https://aka.ms/cs-compliance o zgodności i ochronie prywatności w usługach Cognitive Services na stronie https://www.microsoft.com/ai/responsible-ai.

Zwraca

Połączona lista elementów DetectLanguageResult i DocumentError w kolejności przekazania oryginalnych dokumentów.

Typ zwracany

list[DetectLanguageResult,

DocumentError]

Wyjątki

HttpResponseError

TypeError

ValueError

Przykłady

Wykrywanie języka w partii dokumentów.


   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
       ))

Wyodrębnianie kluczowych fraz z partii dokumentów.

Zwraca listę ciągów oznaczających kluczowe frazy w tekście wejściowym. Na przykład w przypadku tekstu wejściowego "Jedzenie było pyszne i było wspaniałe personel", interfejs API zwraca główne punkty rozmów: "jedzenie" i "wspaniały personel"

Zobacz https://aka.ms/azsdk/textanalytics/data-limits limity danych usługi.

Nowość w wersji 3.1: argument słowa kluczowego disable_service_logs .

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]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji TextDocumentInputdyktowania , takich jak {"id": "1", "language": "en", "text": "hello world"}.

language: str

Dwuliterowa reprezentacja języka ISO 639-1 dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

model_version: str

Wersja modelu używana do analizy, np. "latest". Jeśli wersja modelu nie zostanie określona, interfejs API będzie domyślnie korzystać z najnowszej, innej niż wersja zapoznawcza. Aby uzyskać więcej informacji, zobacz tutaj: https://aka.ms/text-analytics-model-versioning

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki na poziomie dokumentu w polu statystyk odpowiedzi na poziomie dokumentu.

disable_service_logs: bool

W przypadku ustawienia wartości true użytkownik zrezygnował z rejestrowania tekstu po stronie usługi w celu rozwiązywania problemów. Domyślnie usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Ustawienie tego parametru na wartość true powoduje wyłączenie rejestrowania danych wejściowych i może ograniczyć możliwość korygowania występujących problemów. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnego używania sztucznej inteligencji, zobacz Informacje https://aka.ms/cs-compliance o zgodności i ochronie prywatności w usługach Cognitive Services na stronie https://www.microsoft.com/ai/responsible-ai.

Zwraca

Połączona lista elementów ExtractKeyPhrasesResult i DocumentError w kolejności przekazania oryginalnych dokumentów.

Typ zwracany

list[ExtractKeyPhrasesResult,

DocumentError]

Wyjątki

HttpResponseError

TypeError

ValueError

Przykłady

Wyodrębnij kluczowe frazy w partii dokumentów.


   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)
           ))

Rozpoznawanie jednostek dla partii dokumentów.

Identyfikuje i kategoryzuje jednostki w tekście jako osoby, miejsca, organizacje, datę/godzinę, ilości, wartości procentowe, waluty i nie tylko. Aby uzyskać listę obsługiwanych typów jednostek, sprawdź: https://aka.ms/taner

Zobacz https://aka.ms/azsdk/textanalytics/data-limits limity danych usługi.

Nowość w wersji 3.1: argumenty słów kluczowych disable_service_logs i string_index_type .

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]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji TextDocumentInputdyktowania , takich jak {"id": "1", "language": "en", "text": "hello world"}.

language: str

Dwuliterowa reprezentacja języka ISO 639-1 dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

model_version: str

Wersja modelu używana do analizy, np. "latest". Jeśli wersja modelu nie zostanie określona, interfejs API będzie domyślnie korzystać z najnowszej, innej niż wersja zapoznawcza. Aby uzyskać więcej informacji, zobacz tutaj: https://aka.ms/text-analytics-model-versioning

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki na poziomie dokumentu w polu statystyk odpowiedzi na poziomie dokumentu.

string_index_type: str

Określa metodę używaną do interpretowania przesunięć ciągów. Kodowanie UnicodeCodePoint w języku Python jest wartością domyślną. Aby zastąpić wartość domyślną języka Python, możesz również przekazać wartość Utf16CodeUnit lub TextElement_v8. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets

disable_service_logs: bool

W przypadku ustawienia wartości true użytkownik zrezygnował z rejestrowania tekstu po stronie usługi w celu rozwiązywania problemów. Domyślnie usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Ustawienie tego parametru na wartość true powoduje wyłączenie rejestrowania danych wejściowych i może ograniczyć możliwość korygowania występujących problemów. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnego używania sztucznej inteligencji, zobacz Informacje https://aka.ms/cs-compliance o zgodności i ochronie prywatności w usługach Cognitive Services na stronie https://www.microsoft.com/ai/responsible-ai.

Zwraca

Połączona lista elementów RecognizeEntitiesResult i DocumentError w kolejności przekazania oryginalnych dokumentów.

Typ zwracany

list[RecognizeEntitiesResult,

DocumentError]

Wyjątki

HttpResponseError

TypeError

ValueError

Przykłady

Rozpoznawanie jednostek w partii dokumentów.


   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)
           )
       )

Rozpoznawanie połączonych jednostek z dobrze znanych baza wiedzy dla partii dokumentów.

Identyfikuje i dysambiguje tożsamość każdej jednostki znalezionej w tekście (na przykład określenie, czy wystąpienie słowa Mars odnosi się do planety, czy do rzymskiego boga wojny). Rozpoznane jednostki są skojarzone z adresami URL dobrze znanymi baza wiedzy, takimi jak Wikipedia.

Zobacz https://aka.ms/azsdk/textanalytics/data-limits limity danych usługi.

Nowość w wersji 3.1: argumenty słów kluczowych disable_service_logs i string_index_type .

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]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji TextDocumentInputdyktowania , takich jak {"id": "1", "language": "en", "text": "hello world"}.

language: str

Dwuliterowa reprezentacja języka ISO 639-1 dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

model_version: str

Wersja modelu używana do analizy, np. "latest". Jeśli wersja modelu nie zostanie określona, interfejs API będzie domyślnie korzystać z najnowszej, innej niż wersja zapoznawcza. Aby uzyskać więcej informacji, zobacz tutaj: https://aka.ms/text-analytics-model-versioning

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki na poziomie dokumentu w polu statystyk odpowiedzi na poziomie dokumentu.

string_index_type: str

Określa metodę używaną do interpretowania przesunięć ciągów. Kodowanie UnicodeCodePoint w języku Python jest wartością domyślną. Aby zastąpić wartość domyślną języka Python, możesz również przekazać wartość Utf16CodeUnit lub TextElement_v8. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets

disable_service_logs: bool

W przypadku ustawienia wartości true użytkownik zrezygnował z rejestrowania tekstu po stronie usługi w celu rozwiązywania problemów. Domyślnie usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Ustawienie tego parametru na wartość true powoduje wyłączenie rejestrowania danych wejściowych i może ograniczyć możliwość korygowania występujących problemów. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnego używania sztucznej inteligencji, zobacz Informacje https://aka.ms/cs-compliance o zgodności i ochronie prywatności w usługach Cognitive Services na stronie https://www.microsoft.com/ai/responsible-ai.

Zwraca

Połączona lista elementów RecognizeLinkedEntitiesResult i DocumentError w kolejności przekazania oryginalnych dokumentów.

Typ zwracany

list[RecognizeLinkedEntitiesResult,

DocumentError]

Wyjątki

HttpResponseError

TypeError

ValueError

Przykłady

Rozpoznawanie połączonych jednostek w partii dokumentów.


   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

Rozpoznawanie jednostek zawierających dane osobowe dla partii dokumentów.

Zwraca listę jednostek informacji osobistych ("SSN", "Konto bankowe" itp.) w dokumencie. Aby uzyskać listę obsługiwanych typów jednostek, sprawdź https://aka.ms/azsdk/language/pii

Zobacz https://aka.ms/azsdk/textanalytics/data-limits limity danych usługi.

Nowość w wersji 3.1: metoda klienta recognize_pii_entities .

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]

Parametry

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

Wymagane

Zestaw dokumentów do przetworzenia w ramach tej partii. Jeśli chcesz określić identyfikator i język dla poszczególnych elementów, musisz użyć jako danych wejściowych listy[TextDocumentInput] lub listy reprezentacji TextDocumentInputdyktowania , takich jak {"id": "1", "language": "en", "text": "hello world"}.

language: str

Dwuliterowa reprezentacja języka ISO 639-1 dla całej partii. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego. Język poszczególnych dokumentów będzie mieć pierwszeństwo przed całym językiem wsadowym. Zobacz https://aka.ms/talangs obsługiwane języki w interfejsie API języka.

model_version: str

Wersja modelu używana do analizy, np. "latest". Jeśli wersja modelu nie zostanie określona, interfejs API będzie domyślnie korzystać z najnowszej, innej niż wersja zapoznawcza. Aby uzyskać więcej informacji, zobacz tutaj: https://aka.ms/text-analytics-model-versioning

show_stats: bool

W przypadku ustawienia wartości true odpowiedź będzie zawierać statystyki na poziomie dokumentu w polu statystyk odpowiedzi na poziomie dokumentu.

domain_filter: str lub PiiEntityDomain

Filtruje jednostki odpowiedzi na jednostki uwzględnione tylko w określonej domenie. Tj. w przypadku ustawienia wartości "phi" zostaną zwrócone tylko jednostki w domenie Protected Healthcare Information. Aby uzyskać więcej informacji, zobacz https://aka.ms/azsdk/language/pii.

categories_filter: list[str lub PiiEntityCategory]

Zamiast filtrować wszystkie kategorie jednostek PII, możesz przekazać listę określonych kategorii jednostek PII, które chcesz odfiltrować. Jeśli na przykład chcesz odfiltrować numery ubezpieczenia społecznego w USA w dokumencie, możesz przekazać [PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER] dla tego kwargu.

string_index_type: str

Określa metodę używaną do interpretowania przesunięć ciągów. Kodowanie UnicodeCodePoint w języku Python jest wartością domyślną. Aby zastąpić wartość domyślną języka Python, możesz również przekazać wartość Utf16CodeUnit lub TextElement_v8. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets

disable_service_logs: bool

Wartość domyślna to true, co oznacza, że usługa językowa nie będzie rejestrować tekstu wejściowego po stronie usługi na potrzeby rozwiązywania problemów. W przypadku ustawienia wartości Fałsz usługa językowa rejestruje tekst wejściowy przez 48 godzin, wyłącznie w celu umożliwienia rozwiązywania problemów w dostarczaniu funkcji przetwarzania języka naturalnego usługi. Aby uzyskać dodatkowe informacje na temat zasad odpowiedzialnego używania sztucznej inteligencji, zobacz Informacje https://aka.ms/cs-compliance o zgodności i ochronie prywatności w usługach Cognitive Services na stronie https://www.microsoft.com/ai/responsible-ai.

Zwraca

Połączona lista elementów RecognizePiiEntitiesResult i DocumentError w kolejności przekazania oryginalnych dokumentów.

Typ zwracany

list[RecognizePiiEntitiesResult,

DocumentError]

Wyjątki

HttpResponseError

TypeError

ValueError

Przykłady

Rozpoznawanie jednostek danych osobowych w partii dokumentów.


   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	Analizowanie tonacji dla partii dokumentów. Włącz górnictwo opinii przy użyciu show_opinion_mining. Zwraca przewidywanie tonacji, a także wyniki tonacji dla każdej klasy tonacji (pozytywne, ujemne i neutralne) dla dokumentu i każdego zdania w nim. Zobacz, aby zapoznać się https://aka.ms/azsdk/textanalytics/data-limits z limitami danych usługi. Nowość w wersji 3.1: argumenty słów kluczowych show_opinion_mining, disable_service_logs i string_index_type .
begin_abstract_summary	Rozpocznij długotrwałą operację podsumowania abstrakcyjnego. Aby zapoznać się z koncepcyjnym omówieniem podsumowania abstrakcyjnego, zobacz dokumentację usługi: https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/overview Nowość w wersji 2023-04-01: metoda klienta begin_abstract_summary .
begin_analyze_actions	Rozpocznij długotrwałą operację, aby wykonać różne akcje analizy tekstu w partii dokumentów. Zalecamy użycie tej funkcji, jeśli chcesz analizować większe dokumenty i /lub połączyć wiele akcji analizy tekstu w jedno wywołanie. W przeciwnym razie zalecamy użycie określonych punktów końcowych akcji, na przykład analyze_sentiment. Uwaga Zapoznaj się z dokumentacją usługi, aby uzyskać pomoc regionalną dotyczącą funkcji akcji niestandardowych: https://aka.ms/azsdk/textanalytics/customfunctionalities Nowość w wersji 3.1: metoda klienta begin_analyze_actions . Nowość w wersji 2022-05-01: RecognizeCustomEntitiesAction, SingleLabelClassifyAction, MultiLabelClassifyAction i AnalyzeHealthcareEntitiesAction opcje wejściowe oraz odpowiadające im obiekty wejściowe RecognizeCustomEntitiesResult, ClassifyDocumentResult i AnalyzeHealthcareEntitiesResult Nowość w wersji 2023-04-01: Obiekty wyniku ExtractiveSummaryAction i AbstractiveSummaryAction oraz odpowiadające im obiekty wynikowe ExtractiveSummaryResult i AbstractiveSummaryResult .
begin_analyze_healthcare_entities	Analizowanie jednostek opieki zdrowotnej i identyfikowanie relacji między tymi jednostkami w partii dokumentów. Jednostki są skojarzone z odwołaniami, które można znaleźć w istniejących bazach wiedzy, takich jak UMLS, CHV, MSH itp. Wyodrębniamy również relacje znalezione między jednostkami, na przykład w "Temat wziął 100 mg ibuprofenu", wyodrębnimy związek między "100 mg" dawki i "ibuprofen" leki. Nowość w wersji 3.1: metoda klienta begin_analyze_healthcare_entities . Nowość w wersji 2022-05-01: argument słowa kluczowego display_name .
begin_extract_summary	Uruchom długotrwałą operację podsumowania wyodrębniającego. Aby zapoznać się z koncepcyjnym omówieniem podsumowania wyodrębnianego, zobacz dokumentację usługi: https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/overview Nowość w wersji 2023-04-01: metoda klienta begin_extract_summary .
begin_multi_label_classify	Rozpocznij długotrwałą operację klasyfikacji z wieloma etykietami. Aby uzyskać informacje na temat regionalnej obsługi funkcji niestandardowych i sposobu trenowania modelu w celu klasyfikowania dokumentów, zobacz https://aka.ms/azsdk/textanalytics/customfunctionalities Nowość w wersji 2022-05-01: metoda klienta begin_multi_label_classify .
begin_recognize_custom_entities	Uruchom długotrwałą operację rozpoznawania nazwanych jednostek. Aby uzyskać informacje na temat regionalnej obsługi funkcji niestandardowych i sposobu trenowania modelu w celu rozpoznawania jednostek niestandardowych, zobacz https://aka.ms/azsdk/textanalytics/customentityrecognition Nowość w wersji 2022-05-01: metoda klienta begin_recognize_custom_entities .
begin_single_label_classify	Rozpocznij długotrwałą operację klasyfikacji z pojedynczą etykietą. Aby uzyskać informacje na temat regionalnej obsługi funkcji niestandardowych i sposobu trenowania modelu w celu klasyfikowania dokumentów, zobacz https://aka.ms/azsdk/textanalytics/customfunctionalities Nowość w wersji 2022-05-01: metoda klienta begin_single_label_classify .
close	Zamknij gniazda otwarte przez klienta. Wywoływanie tej metody jest niepotrzebne w przypadku korzystania z klienta jako menedżera kontekstu.
detect_language	Wykrywanie języka dla partii dokumentów. Zwraca wykryty język i wynik liczbowy z zakresu od zera do jednego. Wyniki zbliżone do jednego wskazują 100% pewności, że zidentyfikowany język jest prawdziwy. Zobacz https://aka.ms/talangs listę obsługiwanych języków. Zobacz https://aka.ms/azsdk/textanalytics/data-limits limity danych usługi. Nowość w wersji 3.1: argument słowa kluczowego disable_service_logs .
extract_key_phrases	Wyodrębnianie kluczowych fraz z partii dokumentów. Zwraca listę ciągów oznaczających kluczowe frazy w tekście wejściowym. Na przykład w przypadku tekstu wejściowego "Jedzenie było pyszne i było wspaniałe personel", interfejs API zwraca główne punkty rozmów: "jedzenie" i "wspaniały personel" Zobacz https://aka.ms/azsdk/textanalytics/data-limits limity danych usługi. Nowość w wersji 3.1: argument słowa kluczowego disable_service_logs .
recognize_entities	Rozpoznawanie jednostek dla partii dokumentów. Identyfikuje i kategoryzuje jednostki w tekście jako osoby, miejsca, organizacje, datę/godzinę, ilości, wartości procentowe, waluty i nie tylko. Aby uzyskać listę obsługiwanych typów jednostek, sprawdź: https://aka.ms/taner Zobacz https://aka.ms/azsdk/textanalytics/data-limits limity danych usługi. Nowość w wersji 3.1: argumenty słów kluczowych disable_service_logs i string_index_type .
recognize_linked_entities	Rozpoznawanie połączonych jednostek z dobrze znanych baza wiedzy dla partii dokumentów. Identyfikuje i dysambiguje tożsamość każdej jednostki znalezionej w tekście (na przykład określenie, czy wystąpienie słowa Mars odnosi się do planety, czy do rzymskiego boga wojny). Rozpoznane jednostki są skojarzone z adresami URL dobrze znanymi baza wiedzy, takimi jak Wikipedia. Zobacz https://aka.ms/azsdk/textanalytics/data-limits limity danych usługi. Nowość w wersji 3.1: argumenty słów kluczowych disable_service_logs i string_index_type .
recognize_pii_entities	Rozpoznawanie jednostek zawierających dane osobowe dla partii dokumentów. Zwraca listę jednostek informacji osobistych ("SSN", "Konto bankowe" itp.) w dokumencie. Aby uzyskać listę obsługiwanych typów jednostek, sprawdź https://aka.ms/azsdk/language/pii Zobacz https://aka.ms/azsdk/textanalytics/data-limits limity danych usługi. Nowość w wersji 3.1: metoda klienta recognize_pii_entities .

Udostępnij za pośrednictwem

TextAnalyticsClient Klasa

Konstruktor

Parametry

Przykłady

Metody

analyze_sentiment

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

begin_abstract_summary

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

begin_analyze_actions

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

begin_analyze_healthcare_entities

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

begin_extract_summary

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

begin_multi_label_classify

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

begin_recognize_custom_entities

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

begin_single_label_classify

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

close

Wyjątki

detect_language

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

extract_key_phrases

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

recognize_entities

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady

recognize_linked_entities

Parametry

Zwraca

Typ zwracany

Wyjątki

Przykłady