Partager via


ConversationAnalysisClient Classe

L’API conversations du service de langage est une suite de compétences de traitement en langage naturel (NLP) qui peuvent être utilisées pour analyser des conversations structurées (textuelles ou parlées). Vous trouverez une documentation supplémentaire dans https://docs.microsoft.com/azure/cognitive-services/language-service/overview.

Héritage
azure.ai.language.conversations.aio._client.ConversationAnalysisClient
ConversationAnalysisClient

Constructeur

ConversationAnalysisClient(endpoint: str, credential: AzureKeyCredential | AsyncTokenCredential, **kwargs: Any)

Paramètres

endpoint
str
Obligatoire

Point de terminaison Cognitive Services pris en charge (par exemple, https://<resource-name>.cognitiveservices.azure.com). Obligatoire.

credential
AzureKeyCredential ou AsyncTokenCredential
Obligatoire

Informations d’identification nécessaires pour que le client se connecte à Azure. Il peut s’agir d’un instance d’AzureKeyCredential si vous utilisez une clé API Language ou des informations d’identification de jeton à partir de identity.

api_version
str

Version de l’API. Les valeurs disponibles sont « 01/04/2023 » et « 2022-05-01 ». La valeur par défaut est « 01/04/2023 ». Notez que la substitution de cette valeur par défaut peut entraîner un comportement non pris en charge.

polling_interval
int

Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.

Méthodes

analyze_conversation

Analyse l’énoncé de conversation d’entrée.

Consultez la rubrique https://learn.microsoft.com/rest/api/language/2023-04-01/conversation-analysis-runtime/analyze-conversation (éventuellement en anglais) pour plus d'informations.

begin_conversation_analysis

Envoyer un travail d’analyse pour les conversations.

Envoyez une collection de conversations à des fins d’analyse. Spécifier une ou plusieurs tâches uniques à exécuter.

Consultez la rubrique https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/submit-job (éventuellement en anglais) pour plus d'informations.

close
send_request

Exécute la requête réseau via les stratégies chaînées du client.


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = await client.send_request(request)
<AsyncHttpResponse: 200 OK>

Pour plus d’informations sur ce flux de code, consultez https://aka.ms/azsdk/dpcodegen/python/send_request

analyze_conversation

Analyse l’énoncé de conversation d’entrée.

Consultez la rubrique https://learn.microsoft.com/rest/api/language/2023-04-01/conversation-analysis-runtime/analyze-conversation (éventuellement en anglais) pour plus d'informations.

async analyze_conversation(task: MutableMapping[str, Any] | IO, **kwargs: Any) -> MutableMapping[str, Any]

Paramètres

task
<xref:JSON> ou IO
Obligatoire

Tâche conversationnelle unique à exécuter. Est un type JSON ou un type d’E/S. Obligatoire.

content_type
str

Type de contenu de paramètre de corps. Les valeurs connues sont « application/json ». La valeur par défaut est Aucun.

Retours

Objet JSON

Type de retour

<xref:JSON>

Exceptions

Exemples


   # The input is polymorphic. The following are possible polymorphic inputs based off
     discriminator "kind":

   # JSON input template for discriminator value "Conversation":
   analyze_conversation_task = {
       "analysisInput": {
           "conversationItem": {
               "id": "str",  # The ID of a conversation item. Required.
               "participantId": "str",  # The participant ID of a
                 conversation item. Required.
               "language": "str",  # Optional. The override language of a
                 conversation item in BCP 47 language representation.
               "modality": "str",  # Optional. Enumeration of supported
                 conversational modalities. Known values are: "transcript" and "text".
               "role": "str"  # Optional. Role of the participant. Known
                 values are: "agent", "customer", and "generic".
           }
       },
       "kind": "Conversation",
       "parameters": {
           "deploymentName": "str",  # The name of the deployment to use.
             Required.
           "projectName": "str",  # The name of the project to use. Required.
           "directTarget": "str",  # Optional. The name of a target project to
             forward the request to.
           "isLoggingEnabled": bool,  # Optional. If true, the service will keep
             the query for further review.
           "stringIndexType": "TextElements_v8",  # Optional. Default value is
             "TextElements_v8". Specifies the method used to interpret string offsets. Set
             to "UnicodeCodePoint" for Python strings. Known values are:
             "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit".
           "targetProjectParameters": {
               "str": analysis_parameters
           },
           "verbose": bool  # Optional. If true, the service will return more
             detailed information in the response.
       }
   }

   # JSON input template you can fill out and use as your body input.
   task = analyze_conversation_task
   # The response is polymorphic. The following are possible polymorphic responses based
     off discriminator "kind":

   # JSON input template for discriminator value "ConversationResult":
   analyze_conversation_task_result = {
       "kind": "ConversationResult",
       "result": {
           "prediction": base_prediction,
           "query": "str",  # The conversation utterance given by the caller.
             Required.
           "detectedLanguage": "str"  # Optional. The system detected language
             for the query in BCP 47 language representation..
       }
   }

   # JSON input template for discriminator value "Conversation":
   base_prediction = {
       "entities": [
           {
               "category": "str",  # The entity category. Required.
               "confidenceScore": 0.0,  # The entity confidence score.
                 Required.
               "length": 0,  # The length of the text. Required.
               "offset": 0,  # The starting index of this entity in the
                 query. Required.
               "text": "str",  # The predicted entity text. Required.
               "extraInformation": [
                   base_extra_information
               ],
               "resolutions": [
                   base_resolution
               ]
           }
       ],
       "intents": [
           {
               "category": "str",  # A predicted class. Required.
               "confidenceScore": 0.0  # The confidence score of the class
                 from 0.0 to 1.0. Required.
           }
       ],
       "projectKind": "Conversation",
       "topIntent": "str"  # Optional. The intent with the highest score.
   }

   # JSON input template for discriminator value "Orchestration":
   base_prediction = {
       "intents": {
           "str": target_intent_result
       },
       "projectKind": "Orchestration",
       "topIntent": "str"  # Optional. The intent with the highest score.
   }

   # response body for status code(s): 200
   response == analyze_conversation_task_result

begin_conversation_analysis

Envoyer un travail d’analyse pour les conversations.

Envoyez une collection de conversations à des fins d’analyse. Spécifier une ou plusieurs tâches uniques à exécuter.

Consultez la rubrique https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/submit-job (éventuellement en anglais) pour plus d'informations.

async begin_conversation_analysis(task: MutableMapping[str, Any] | IO, **kwargs: Any) -> AsyncLROPoller[MutableMapping[str, Any]]

Paramètres

task
<xref:JSON> ou IO
Obligatoire

Collecte de conversations à analyser et une ou plusieurs tâches à exécuter. Est un type JSON ou un type d’E/S. Obligatoire.

content_type
str

Type de contenu de paramètre de corps. Les valeurs connues sont « application/json ». La valeur par défaut est Aucun.

continuation_token
str

Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.

polling
bool ou AsyncPollingMethod

Par défaut, votre méthode d’interrogation est AsyncLROBasePolling. Passez la valeur False pour que cette opération n’interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.

polling_interval
int

Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.

Retours

Instance d’AsyncLROPoller qui retourne un objet JSON

Type de retour

AsyncLROPoller[<xref:JSON>]

Exceptions

Exemples


   # JSON input template you can fill out and use as your body input.
   task = {
       "analysisInput": {
           "conversations": [
               conversation
           ]
       },
       "tasks": [
           analyze_conversation_lro_task
       ],
       "displayName": "str"  # Optional. Display name for the analysis job.
   }

   # response body for status code(s): 200
   response == {
       "createdDateTime": "2020-02-20 00:00:00",  # Required.
       "jobId": "str",  # Required.
       "lastUpdatedDateTime": "2020-02-20 00:00:00",  # Required.
       "status": "str",  # The status of the task at the mentioned last update time.
         Required. Known values are: "notStarted", "running", "succeeded", "failed",
         "cancelled", "cancelling", and "partiallyCompleted".
       "tasks": {
           "completed": 0,  # Count of tasks that finished successfully.
             Required.
           "failed": 0,  # Count of tasks that failed. Required.
           "inProgress": 0,  # Count of tasks that are currently in progress.
             Required.
           "total": 0,  # Total count of tasks submitted as part of the job.
             Required.
           "items": [
               analyze_conversation_job_result
           ]
       },
       "displayName": "str",  # Optional.
       "errors": [
           {
               "code": "str",  # One of a server-defined set of error codes.
                 Required. Known values are: "InvalidRequest", "InvalidArgument",
                 "Unauthorized", "Forbidden", "NotFound", "ProjectNotFound",
                 "OperationNotFound", "AzureCognitiveSearchNotFound",
                 "AzureCognitiveSearchIndexNotFound", "TooManyRequests",
                 "AzureCognitiveSearchThrottling",
                 "AzureCognitiveSearchIndexLimitReached", "InternalServerError",
                 "ServiceUnavailable", "Timeout", "QuotaExceeded", "Conflict", and
                 "Warning".
               "message": "str",  # A human-readable representation of the
                 error. Required.
               "details": [
                   ...
               ],
               "innererror": {
                   "code": "str",  # One of a server-defined set of
                     error codes. Required. Known values are: "InvalidRequest",
                     "InvalidParameterValue", "KnowledgeBaseNotFound",
                     "AzureCognitiveSearchNotFound", "AzureCognitiveSearchThrottling",
                     "ExtractionFailure", "InvalidRequestBodyFormat", "EmptyRequest",
                     "MissingInputDocuments", "InvalidDocument", "ModelVersionIncorrect",
                     "InvalidDocumentBatch", "UnsupportedLanguageCode", and
                     "InvalidCountryHint".
                   "message": "str",  # Error message. Required.
                   "details": {
                       "str": "str"  # Optional. Error details.
                   },
                   "innererror": ...,
                   "target": "str"  # Optional. Error target.
               },
               "target": "str"  # Optional. The target of the error.
           }
       ],
       "expirationDateTime": "2020-02-20 00:00:00",  # Optional.
       "nextLink": "str",  # Optional.
       "statistics": {
           "conversationsCount": 0,  # Number of conversations submitted in the
             request. Required.
           "documentsCount": 0,  # Number of documents submitted in the request.
             Required.
           "erroneousConversationsCount": 0,  # Number of invalid documents.
             This includes documents that are empty, over the size limit, or in
             unsupported languages. Required.
           "erroneousDocumentsCount": 0,  # Number of invalid documents. This
             includes empty, over-size limit or non-supported languages documents.
             Required.
           "transactionsCount": 0,  # Number of transactions for the request.
             Required.
           "validConversationsCount": 0,  # Number of conversation documents.
             This excludes documents that are empty, over the size limit, or in
             unsupported languages. Required.
           "validDocumentsCount": 0  # Number of valid documents. This excludes
             empty, over-size limit or non-supported languages documents. Required.
       }
   }

close

async close() -> None

Exceptions

send_request

Exécute la requête réseau via les stratégies chaînées du client.


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = await client.send_request(request)
<AsyncHttpResponse: 200 OK>

Pour plus d’informations sur ce flux de code, consultez https://aka.ms/azsdk/dpcodegen/python/send_request

send_request(request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]

Paramètres

request
HttpRequest
Obligatoire

Demande réseau que vous souhaitez effectuer. Obligatoire.

stream
bool

Indique si la charge utile de réponse sera diffusée en continu. Valeur par défaut False.

Retours

Réponse de votre appel réseau. Ne gère pas les erreurs sur votre réponse.

Type de retour

Exceptions