ConversationAnalysisClient クラス

リファレンス

言語サービス会話 API は、構造化された会話 (テキストまたは音声) の分析に使用できる自然言語処理 (NLP) スキルのスイートです。その他のドキュメントについては、を https://docs.microsoft.com/azure/cognitive-services/language-service/overview参照してください。

継承: azure.ai.language.conversations.aio._client.ConversationAnalysisClient

ConversationAnalysisClient

コンストラクター

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

パラメーター

endpoint: str

必須

サポートされている Cognitive Services エンドポイント ( 例: https://<resource-name>.cognitiveservices.azure.com)。必須。

credential: AzureKeyCredential または AsyncTokenCredential

必須

クライアントが Azure に接続するために必要な資格情報。 Language API キーまたはからの identityトークン資格情報を使用する場合は、AzureKeyCredential のインスタンスを指定できます。

api_version: str

API バージョン。使用可能な値は、"2023-04-01" と "2022-05-01" です。既定値は "2023-04-01" です。この既定値をオーバーライドすると、サポートされていない動作が発生する可能性があることに注意してください。

polling_interval: int

Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

メソッド

analyze_conversation	入力された会話発話を分析します。詳細については、「 https://learn.microsoft.com/rest/api/language/2023-04-01/conversation-analysis-runtime/analyze-conversation 」を参照してください。
begin_conversation_analysis	会話の分析ジョブを送信します。分析のために会話のコレクションを送信します。実行する 1 つまたは複数の一意のタスクを指定します。詳細については、「 https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/submit-job 」を参照してください。
close
send_request	クライアントのチェーンポリシーを使用してネットワーク要求を実行します。 `>>> 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>` このコードフローの詳細については、次を参照してください。 https://aka.ms/azsdk/dpcodegen/python/send_request

analyze_conversation

入力された会話発話を分析します。

詳細については、「 https://learn.microsoft.com/rest/api/language/2023-04-01/conversation-analysis-runtime/analyze-conversation 」を参照してください。

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

パラメーター

task: <xref:JSON> または IO

必須

実行する 1 つの会話型タスク。 JSON 型または IO 型のいずれかです。必須。

content_type: str

Body Parameter content-type。既知の値は、'application/json' です。既定値は [なし] です。

戻り値

JSON オブジェクト

の戻り値の型 :

<xref:JSON>

例外

HttpResponseError

例


   # 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

会話の分析ジョブを送信します。

分析のために会話のコレクションを送信します。実行する 1 つまたは複数の一意のタスクを指定します。

詳細については、「 https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/submit-job 」を参照してください。

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

パラメーター

task: <xref:JSON> または IO

必須

分析する会話のコレクションと、実行する 1 つ以上のタスク。 JSON 型または IO 型のいずれかです。必須。

content_type: str

Body Parameter content-type。既知の値は、'application/json' です。既定値は [なし] です。

continuation_token: str

保存された状態からポーリングを再開するための継続トークン。

polling: bool または AsyncPollingMethod

既定では、ポーリングメソッドは AsyncLROBasePolling になります。この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリングオブジェクトを渡します。

polling_interval: int

Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

戻り値

JSON オブジェクトを返す AsyncLROPoller のインスタンス

の戻り値の型 :

AsyncLROPoller[<xref:JSON>]

例外

HttpResponseError

例


   # 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

例外

HttpResponseError

send_request

クライアントのチェーンポリシーを使用してネットワーク要求を実行します。


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

このコードフローの詳細については、次を参照してください。 https://aka.ms/azsdk/dpcodegen/python/send_request

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

パラメーター

request: HttpRequest

必須

作成するネットワーク要求。必須。

stream: bool

応答ペイロードがストリーミングされるかどうか。既定値は False です。

戻り値

ネットワーク呼び出しの応答。応答でエラー処理を行いません。

の戻り値の型 :

AsyncHttpResponse

例外

HttpResponseError

次の方法で共有

ConversationAnalysisClient クラス

コンストラクター

パラメーター

メソッド

analyze_conversation

パラメーター

戻り値

の戻り値の型 :

例外

例

begin_conversation_analysis

パラメーター

戻り値

の戻り値の型 :

例外

例

close

例外

send_request

パラメーター

戻り値

の戻り値の型 :

例外

その他のリソース