Condividi tramite


Analyze Conversations - Analyze Conversations

Analizza l'espressione di conversazione di input.

POST {Endpoint}/language/:analyze-conversations?api-version=2023-04-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
Endpoint
path True

string

Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).

api-version
query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

ConversationalTask

Input per un'attività di comprensione del linguaggio di conversazione.

Nome Necessario Tipo Descrizione
analysisInput True

ConversationAnalysisOptions

Input ConversationItem e relativi parametri facoltativi

kind True string:

Conversation

Classe di base di un'attività di input della conversazione.

parameters True

ConversationTaskParameters

Parametri di input necessari per un'attività di comprensione del linguaggio di conversazione.

Risposte

Nome Tipo Descrizione
200 OK AnalyzeConversationTaskResult:

ConversationalTaskResult

La richiesta ha avuto esito positivo.

Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome Descrizione
https://cognitiveservices.azure.com/.default

Esempio

SuccessfulAnalyzeConversations
SuccessfulAnalyzeConversationsArbitration
SuccessfulAnalyzeConversationsArbitrationDirectTarget

SuccessfulAnalyzeConversations

Esempio di richiesta

POST {Endpoint}/language/:analyze-conversations?api-version=2023-04-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "id": "1",
      "participantId": "1",
      "text": "play In the air tonight from Phil Collins"
    }
  },
  "parameters": {
    "projectName": "{project-name}",
    "deploymentName": "{deployment-name}",
    "stringIndexType": "TextElement_V8"
  }
}

Risposta di esempio

{
  "kind": "ConversationResult",
  "result": {
    "query": "play In the air tonight from Phil Collins",
    "prediction": {
      "topIntent": "PlayMusic",
      "projectKind": "Conversation",
      "intents": [
        {
          "category": "PlayMusic",
          "confidenceScore": 1
        },
        {
          "category": "SearchCreativeWork",
          "confidenceScore": 0
        },
        {
          "category": "AddToPlaylist",
          "confidenceScore": 0
        }
      ],
      "entities": [
        {
          "category": "Media.Artist",
          "text": "Phil Collins",
          "offset": 29,
          "length": 12,
          "confidenceScore": 1
        }
      ]
    }
  }
}

SuccessfulAnalyzeConversationsArbitration

Esempio di richiesta

POST {Endpoint}/language/:analyze-conversations?api-version=2023-04-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "participantId": "1",
      "id": "1",
      "modality": "text",
      "language": "en-GB",
      "text": "trains from London"
    }
  },
  "parameters": {
    "projectName": "{project-name}",
    "deploymentName": "{deployment-name}",
    "verbose": true,
    "isLoggingEnabled": false,
    "stringIndexType": "TextElement_V8"
  }
}

Risposta di esempio

{
  "kind": "ConversationResult",
  "result": {
    "query": "trains from London",
    "prediction": {
      "topIntent": "Rail",
      "projectKind": "Orchestration",
      "intents": {
        "Rail": {
          "confidenceScore": 1,
          "targetProjectKind": "Conversation",
          "result": {
            "query": "trains from London",
            "prediction": {
              "topIntent": "Timetable",
              "projectKind": "Conversation",
              "intents": [
                {
                  "category": "Timetable",
                  "confidenceScore": 0.99968535
                },
                {
                  "category": "Locomotive",
                  "confidenceScore": 0.000314623
                }
              ],
              "entities": []
            }
          }
        },
        "Tree": {
          "confidenceScore": 0.2641529,
          "targetProjectKind": "QuestionAnswering"
        },
        "None": {
          "confidenceScore": 0,
          "targetProjectKind": "NonLinked"
        }
      }
    }
  }
}

SuccessfulAnalyzeConversationsArbitrationDirectTarget

Esempio di richiesta

POST {Endpoint}/language/:analyze-conversations?api-version=2023-04-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "text": "Ports and connectors",
      "participantId": "1",
      "id": "1"
    }
  },
  "parameters": {
    "projectName": "prj1",
    "deploymentName": "dep1",
    "directTarget": "qnaProject",
    "targetProjectParameters": {
      "qnaProject": {
        "targetProjectKind": "QuestionAnswering",
        "callingOptions": {
          "context": {
            "previousUserQuery": "Meet Surface Pro 4",
            "previousQnaId": 4
          },
          "top": 1,
          "question": "App Service overview"
        }
      }
    }
  }
}

Risposta di esempio

{
  "kind": "ConversationResult",
  "result": {
    "query": "Ports and connectors",
    "prediction": {
      "projectKind": "Orchestration",
      "topIntent": "qnaTargetApp",
      "intents": {
        "qnaTargetApp": {
          "targetProjectKind": "QuestionAnswering",
          "confidenceScore": 1,
          "result": {
            "answers": [
              {
                "questions": [
                  "App Service overview"
                ],
                "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.",
                "confidenceScore": 0.7384000000000001,
                "id": 1,
                "source": "https://docs.microsoft.com/en-us/azure/app-service/overview",
                "metadata": {},
                "dialog": {
                  "isContextOnly": false,
                  "prompts": []
                }
              }
            ]
          }
        }
      }
    }
  }
}

Definizioni

Nome Descrizione
AgeResolution

Rappresenta il modello di risoluzione delle entità Age.

AgeUnit

Unità di misura dell'età

AnalyzeConversationResult

Rappresenta una risposta di analisi della conversazione.

AnalyzeConversationTaskKind

Enumerazione delle attività di conversazione supportate.

AnalyzeConversationTaskResultsKind

Enumerazione dei risultati delle attività conversazionali supportate.

AnswersOptions

Parametri per eseguire query su una Knowledge Base.

AnswerSpan

Oggetto intervallo di risposte di QnA.

AnswersResult

Rappresenta l'elenco delle risposte alle domande.

AreaResolution

Rappresenta il modello di risoluzione delle entità dell'area.

AreaUnit

Unità di misura dell'area.

BooleanResolution

Risoluzione per le espressioni booleane

ConversationalTask

Input per un'attività di comprensione del linguaggio di conversazione.

ConversationalTaskResult

Risultati di un'attività Conversation.

ConversationAnalysisOptions

Input ConversationItem e relativi parametri facoltativi

ConversationCallingOptions

Opzione da impostare per chiamare un progetto di conversazione.

ConversationEntity

Risultato dell'estrazione di entità di un progetto conversation.

ConversationIntent

Risultato della classificazione delle finalità di un progetto conversation.

ConversationParameters

Si tratta di un set di parametri di richiesta per i progetti di conversazione personalizzata.

ConversationPrediction

Rappresenta la sezione di stima di un progetto conversation.

ConversationResult

Risposta restituita da un progetto conversation.

ConversationTargetIntentResult

Riepilogo della risposta del progetto conversation.

ConversationTaskParameters

Parametri di input necessari per un'attività Conversation.

CurrencyResolution

Rappresenta il modello di risoluzione delle entità di valuta.

DateTimeResolution

Risoluzione per le istanze di entità datetime.

DateTimeSubKind

Sottomaschera Datetime.

EntitySubtype

Modello sottotipo di entità concreta di informazioni aggiuntive.

Error

Oggetto error.

ErrorCode

Codice di errore leggibile.

ErrorResponse

Risposta di errore.

ExtraInformationKind

Tipo di oggetto informazioni aggiuntivo.

InformationResolution

Rappresenta il modello di risoluzione delle entità informazioni (dati).

InformationUnit

Unità di misura delle informazioni (dati).

InnerErrorCode

Codice di errore leggibile.

InnerErrorModel

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

InputModality

Enumerazione delle modalità di conversazione supportate.

KnowledgeBaseAnswer

Rappresenta la risposta della Knowledge Base.

KnowledgeBaseAnswerContext

Oggetto contesto con le informazioni precedenti di QnA.

KnowledgeBaseAnswerDialog

Finestra di dialogo associata a Answer.

KnowledgeBaseAnswerPrompt

Richiedi una risposta.

LengthResolution

Rappresenta il modello di risoluzione delle entità di lunghezza.

LengthUnit

Unità di misura di lunghezza.

ListKey

Tipo di dati aggiuntivi della chiave di elenco.

LogicalOperationKind

Operazione utilizzata per unire filtri di metadati.

LuisCallingOptions

Ciò consente di personalizzare il modo in cui il servizio chiama i progetti LUIS disponibili a livello generale.

LuisParameters

Si tratta di un set di parametri di richiesta per i progetti LUIS a disponibilità generale.

LuisTargetIntentResult

Si tratta di un riepilogo della risposta LUIS disponibile a livello generale.

MetadataFilter

Trovare domande e risposte associate all'elenco specificato di metadati.

MetadataRecord

Oggetto per fornire la coppia di valori di chiave per ogni metadati.

NoneLinkedTargetIntentResult

Riepilogo della risposta con finalità non collegate.

NumberKind

Tipo dell'entità numero estratto.

NumberResolution

Risoluzione per le istanze di entità numeriche.

NumericRangeResolution

rappresenta la risoluzione degli intervalli numerici.

OrchestrationPrediction

Rappresenta il risultato della stima di un progetto di orchestrazione.

OrdinalResolution

Risoluzione per le istanze di entità numeri ordinali.

projectKind

Tipo del progetto.

QueryFilters

filtra la knowledge base.

QuestionAnsweringParameters

Si tratta di un set di parametri di richiesta per le knowledge base di risposta alle domande.

QuestionAnsweringTargetIntentResult

Si tratta di una risposta della Knowledge Base di risposte alle domande.

RangeKind

Tipo di intervallo rappresentato dall'oggetto risoluzione.

RankerKind

Tipo di ranker da usare

RegexKey

Tipo di dati aggiuntivi della chiave regex.

RelativeTo

Punto di riferimento che indica il numero ordinale.

ResolutionKind

Tipo di oggetto di risoluzione delle entità.

role

Ruolo del partecipante.

ShortAnswerOptions

Per configurare la funzionalità di stima dell'intervallo di risposte.

SpeedResolution

Rappresenta il modello di risoluzione delle entità di velocità.

SpeedUnit

Unità di misura della velocità

StringIndexType

Tipo di indice stringa

targetProjectKind

Tipo di servizio di destinazione.

TemperatureResolution

Rappresenta il modello di risoluzione delle entità della temperatura.

TemperatureUnit

Unità di misura della temperatura.

TemporalModifier

Modificatore facoltativo di un'istanza di data/ora.

TemporalSpanResolution

rappresenta la risoluzione di una data e/o di un intervallo di tempo.

TextConversationItem

Modalità di testo di una conversazione di input.

VolumeResolution

Rappresenta il modello di risoluzione delle entità del volume.

VolumeUnit

Unità di misura del volume

WeightResolution

Rappresenta il modello di risoluzione delle entità di ponderazione.

WeightUnit

Unità di misura del peso.

AgeResolution

Rappresenta il modello di risoluzione delle entità Age.

Nome Tipo Descrizione
resolutionKind string:

AgeResolution

Tipo di oggetto di risoluzione delle entità.

unit

AgeUnit

Unità di misura dell'età

value

number

Valore numerico che indica il testo estratto.

AgeUnit

Unità di misura dell'età

Nome Tipo Descrizione
Day

string

Unità di età del giorno

Month

string

Unità di età mensile

Unspecified

string

Unità di età non specificata

Week

string

Unità di età della settimana

Year

string

Unità di età dell'anno

AnalyzeConversationResult

Rappresenta una risposta di analisi della conversazione.

Nome Tipo Descrizione
detectedLanguage

string

Linguaggio rilevato dal sistema per la query nella rappresentazione della lingua BCP 47.

prediction BasePrediction:

Risultato della stima di un progetto di conversazione.

query

string

Espressione di conversazione specificata dal chiamante.

AnalyzeConversationTaskKind

Enumerazione delle attività di conversazione supportate.

Nome Tipo Descrizione
Conversation

string

Tipo di attività di conversazione

AnalyzeConversationTaskResultsKind

Enumerazione dei risultati delle attività conversazionali supportate.

Nome Tipo Descrizione
ConversationResult

string

Tipo di attività risultato conversazione

AnswersOptions

Parametri per eseguire query su una Knowledge Base.

Nome Tipo Descrizione
answerSpanRequest

ShortAnswerOptions

Per configurare la funzionalità di stima dell'intervallo di risposte.

confidenceScoreThreshold

number

Punteggio di soglia minimo per le risposte, valore compreso tra 0 e 1.

context

KnowledgeBaseAnswerContext

Oggetto contesto con le informazioni precedenti di QnA.

filters

QueryFilters

Filtrare le domande e risposte in base all'elenco di metadati e alle origini della Knowledge Base specificati.

includeUnstructuredSources

boolean

(Facoltativo) Flag per abilitare Query su origini non strutturate.

qnaId

integer

Id QnA esatto da recuperare dalla knowledge base, questo campo ha la priorità rispetto alla domanda.

question

string

Domanda dell'utente su cui eseguire query sulla knowledge base.

rankerType

RankerKind

Tipo di ranker da usare.

top

integer

Numero massimo di risposte da restituire per la domanda.

userId

string

Identificatore univoco per l'utente.

AnswerSpan

Oggetto intervallo di risposte di QnA.

Nome Tipo Descrizione
confidenceScore

number

Punteggio stimato dell'intervallo di risposte, intervallo di valori compreso tra 0 e 1.

length

integer

Lunghezza dell'intervallo di risposte.

offset

integer

Offset dell'intervallo di risposte dall'inizio della risposta.

text

string

Testo stimato dell'intervallo di risposte.

AnswersResult

Rappresenta l'elenco delle risposte alle domande.

Nome Tipo Descrizione
answers

KnowledgeBaseAnswer[]

Rappresenta l'elenco dei risultati della risposta.

AreaResolution

Rappresenta il modello di risoluzione delle entità dell'area.

Nome Tipo Descrizione
resolutionKind string:

AreaResolution

Tipo di oggetto di risoluzione delle entità.

unit

AreaUnit

Unità di misura dell'area

value

number

Valore numerico che indica il testo estratto.

AreaUnit

Unità di misura dell'area.

Nome Tipo Descrizione
Acre

string

Unità area acri

SquareCentimeter

string

Unità di area centimetro quadrato

SquareDecameter

string

Unità di area del decametro quadrato

SquareDecimeter

string

Unità di area decimetro quadrato

SquareFoot

string

Unità area piede quadrato

SquareHectometer

string

Unità di area dell'hectometro quadrato

SquareInch

string

Unità di area pollice quadrato

SquareKilometer

string

Unità di area del chilometro quadrato

SquareMeter

string

Unità di area contatore quadrato

SquareMile

string

Unità di zona miglio quadrato

SquareMillimeter

string

Unità di area millimetri quadrati

SquareYard

string

Unità di area del cortile quadrato

Unspecified

string

Unità di area non specificata

BooleanResolution

Risoluzione per le espressioni booleane

Nome Tipo Descrizione
resolutionKind string:

BooleanResolution

Tipo di oggetto di risoluzione delle entità.

value

boolean

Risoluzione per le espressioni booleane

ConversationalTask

Input per un'attività di comprensione del linguaggio di conversazione.

Nome Tipo Descrizione
analysisInput

ConversationAnalysisOptions

Input ConversationItem e relativi parametri facoltativi

kind string:

Conversation

Classe di base di un'attività di input della conversazione.

parameters

ConversationTaskParameters

Parametri di input necessari per un'attività di comprensione del linguaggio di conversazione.

ConversationalTaskResult

Risultati di un'attività Conversation.

Nome Tipo Descrizione
kind string:

ConversationResult

Classe base di un risultato dell'attività di input della conversazione.

result

AnalyzeConversationResult

Rappresenta una risposta di analisi della conversazione.

ConversationAnalysisOptions

Input ConversationItem e relativi parametri facoltativi

Nome Tipo Descrizione
conversationItem

TextConversationItem

Base astratta per una conversazione formattata dall'utente (ad esempio, Testo, Trascrizione).

ConversationCallingOptions

Opzione da impostare per chiamare un progetto di conversazione.

Nome Tipo Descrizione
isLoggingEnabled

boolean

Se true, la query verrà salvata per consentire ai clienti di esaminare ulteriormente la creazione, per migliorare la qualità del modello.

language

string

Linguaggio della query nella rappresentazione in linguaggio BCP 47.

verbose

boolean

Se true, il servizio restituirà informazioni più dettagliate.

ConversationEntity

Risultato dell'estrazione di entità di un progetto conversation.

Nome Tipo Descrizione
category

string

Categoria di entità.

confidenceScore

number

Punteggio di attendibilità dell'entità.

extraInformation BaseExtraInformation[]:

Raccolta di oggetti informazioni aggiuntivi dell'entità.

length

integer

Lunghezza del testo.

offset

integer

Indice iniziale di questa entità nella query.

resolutions BaseResolution[]:

Raccolta di oggetti di risoluzione delle entità.

text

string

Testo previsto dell'entità.

ConversationIntent

Risultato della classificazione delle finalità di un progetto conversation.

Nome Tipo Descrizione
category

string

Classe stimata.

confidenceScore

number

Punteggio di attendibilità della classe da 0,0 a 1,0.

ConversationParameters

Si tratta di un set di parametri di richiesta per i progetti di conversazione personalizzata.

Nome Tipo Descrizione
apiVersion

string

Versione dell'API da usare quando si chiama un servizio di destinazione specifico.

callingOptions

ConversationCallingOptions

Opzione da impostare per chiamare un progetto di conversazione.

targetProjectKind string:

Conversation

Tipo di servizio di destinazione

ConversationPrediction

Rappresenta la sezione di stima di un progetto conversation.

Nome Tipo Descrizione
entities

ConversationEntity[]

Risultati dell'estrazione di entità.

intents

ConversationIntent[]

Risultati della classificazione delle finalità.

projectKind string:

Conversation

Tipo del progetto.

topIntent

string

Finalità con il punteggio più alto.

ConversationResult

Risposta restituita da un progetto conversation.

Nome Tipo Descrizione
detectedLanguage

string

Linguaggio rilevato dalla query nella rappresentazione della lingua BCP 47.

prediction

ConversationPrediction

Risultato stimato per la query.

query

string

La stessa query specificata nella richiesta.

ConversationTargetIntentResult

Riepilogo della risposta del progetto conversation.

Nome Tipo Descrizione
apiVersion

string

Versione dell'API usata per chiamare un servizio di destinazione.

confidenceScore

number

Il punteggio di stima e varia da 0,0 a 1,0.

result

ConversationResult

Risposta effettiva da un progetto conversation.

targetProjectKind string:

Conversation

Si tratta della classe base di una stima delle finalità

ConversationTaskParameters

Parametri di input necessari per un'attività Conversation.

Nome Tipo Valore predefinito Descrizione
deploymentName

string

Nome della distribuzione da usare.

directTarget

string

Nome di un progetto di destinazione a cui inoltrare la richiesta.

isLoggingEnabled

boolean

Se true, il servizio manterrà la query per un'ulteriore revisione.

projectName

string

Nome del progetto da utilizzare.

stringIndexType

StringIndexType

TextElements_v8

Specifica il metodo utilizzato per interpretare gli offset di stringa. L'impostazione predefinita è Elementi di testo (Graphemes) in base a Unicode v8.0.0. Per altre informazioni, vedere https://aka.ms/text-analytics-offsets.

targetProjectParameters

object

Dizionario che rappresenta i parametri per ogni progetto di destinazione.

verbose

boolean

Se true, il servizio restituirà informazioni più dettagliate nella risposta.

CurrencyResolution

Rappresenta il modello di risoluzione delle entità di valuta.

Nome Tipo Descrizione
ISO4217

string

Codice alfabetico basato su un altro standard ISO, ISO 3166, che elenca i codici per i nomi dei paesi. Le prime due lettere del codice ISO 4217 a tre lettere corrispondono al codice per il nome del paese e, ove possibile, la terza lettera corrisponde alla prima lettera del nome della valuta.

resolutionKind string:

CurrencyResolution

Tipo di oggetto di risoluzione delle entità.

unit

string

Unità della quantità acquisita nell'entità estratta

value

number

Importo del denaro acquisito nell'entità estratta

DateTimeResolution

Risoluzione per le istanze di entità datetime.

Nome Tipo Descrizione
dateTimeSubKind

DateTimeSubKind

Sottomaschera DateTime

modifier

TemporalModifier

Modificatore facoltativo di un'istanza di data/ora.

resolutionKind string:

DateTimeResolution

Tipo di oggetto di risoluzione delle entità.

timex

string

Rappresentazione di data/ora ISO 8601 estesa come descritto in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)

value

string

Ora effettiva in cui il testo estratto indica.

DateTimeSubKind

Sottomaschera Datetime.

Nome Tipo Descrizione
Date

string

Sottomaschera data

DateTime

string

Sottomaschera DateTime

Duration

string

Sottomaschera durata

Set

string

Imposta sottomaschera

Time

string

Sottomaschera temporale

EntitySubtype

Modello sottotipo di entità concreta di informazioni aggiuntive.

Nome Tipo Descrizione
extraInformationKind string:

EntitySubtype

Tipo di oggetto informazioni aggiuntivo.

value

string

Sottotipo di un tipo di entità estratto.

Error

Oggetto error.

Nome Tipo Descrizione
code

ErrorCode

Uno di un set definito dal server di codici di errore.

details

Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.

innererror

InnerErrorModel

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

message

string

Rappresentazione leggibile dell'errore.

target

string

Destinazione dell'errore.

ErrorCode

Codice di errore leggibile.

Nome Tipo Descrizione
AzureCognitiveSearchIndexLimitReached

string

Errore raggiunto dal limite di indice di Ricerca cognitiva di Azure

AzureCognitiveSearchIndexNotFound

string

Errore non trovato nell'indice di Ricerca cognitiva di Azure

AzureCognitiveSearchNotFound

string

Errore di Ricerca cognitiva di Azure non trovato

AzureCognitiveSearchThrottling

string

Errore di limitazione della limitazione di Ricerca cognitiva di Azure

Conflict

string

Errore di conflitto

Forbidden

string

Errore di accesso negato

InternalServerError

string

Errore interno del server

InvalidArgument

string

Errore di argomento non valido

InvalidRequest

string

Errore di richiesta non valido

NotFound

string

Errore non trovato

OperationNotFound

string

Errore di operazione non trovata

ProjectNotFound

string

Errore di progetto non trovato

QuotaExceeded

string

Errore di superamento della quota

ServiceUnavailable

string

Errore di servizio non disponibile

Timeout

string

Errore di timeout

TooManyRequests

string

Errore di troppe richieste

Unauthorized

string

Errore di accesso non autorizzato

Warning

string

Errore di avviso

ErrorResponse

Risposta di errore.

Nome Tipo Descrizione
error

Error

Oggetto error.

ExtraInformationKind

Tipo di oggetto informazioni aggiuntivo.

Nome Tipo Descrizione
EntitySubtype

string

Tipo di informazioni aggiuntive sottotipo di entità

ListKey

string

Tipo di informazioni aggiuntive chiave elenco

RegexKey

string

Tipo di informazioni aggiuntive chiave regex

InformationResolution

Rappresenta il modello di risoluzione delle entità informazioni (dati).

Nome Tipo Descrizione
resolutionKind string:

InformationResolution

Tipo di oggetto di risoluzione delle entità.

unit

InformationUnit

Unità di misura delle informazioni (dati).

value

number

Valore numerico che indica il testo estratto.

InformationUnit

Unità di misura delle informazioni (dati).

Nome Tipo Descrizione
Bit

string

Unità informazioni sui bit

Byte

string

Unità informazioni byte

Gigabit

string

Unità informazioni Gigabit

Gigabyte

string

Unità informazioni gigabyte

Kilobit

string

Unità informazioni kilobit

Kilobyte

string

Unità informativa kilobyte

Megabit

string

Unità informazioni megabit

Megabyte

string

Unità informativa megabyte

Petabit

string

Unità informazioni petabit

Petabyte

string

Unità informazioni petabyte

Terabit

string

Unità informazioni Terabit

Terabyte

string

Unità informazioni Terabyte

Unspecified

string

Unità informazioni non specificate

InnerErrorCode

Codice di errore leggibile.

Nome Tipo Descrizione
AzureCognitiveSearchNotFound

string

Errore di Ricerca cognitiva di Azure non trovato

AzureCognitiveSearchThrottling

string

Errore di limitazione della limitazione di Ricerca cognitiva di Azure

EmptyRequest

string

Errore di richiesta vuota

ExtractionFailure

string

Errore di estrazione

InvalidCountryHint

string

Errore di hint paese non valido

InvalidDocument

string

Errore del documento non valido

InvalidDocumentBatch

string

Errore del batch di documenti non valido

InvalidParameterValue

string

Errore del valore del parametro non valido

InvalidRequest

string

Errore di richiesta non valido

InvalidRequestBodyFormat

string

Errore di formato del corpo della richiesta non valido

KnowledgeBaseNotFound

string

Errore della Knowledge Base non trovato

MissingInputDocuments

string

Errore dei documenti di input mancanti

ModelVersionIncorrect

string

Errore di versione del modello non corretto

UnsupportedLanguageCode

string

Errore di codice della lingua non supportato

InnerErrorModel

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Descrizione
code

InnerErrorCode

Uno di un set definito dal server di codici di errore.

details

object

Dettagli errore.

innererror

InnerErrorModel

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

message

string

Messaggio di errore.

target

string

Destinazione errore.

InputModality

Enumerazione delle modalità di conversazione supportate.

Nome Tipo Descrizione
text

string

Modalità di input di testo

transcript

string

Modalità di input trascrizione

KnowledgeBaseAnswer

Rappresenta la risposta della Knowledge Base.

Nome Tipo Descrizione
answer

string

Testo della risposta.

answerSpan

AnswerSpan

Oggetto intervallo di risposte di QnA rispetto alla domanda dell'utente.

confidenceScore

number

Punteggio di attendibilità della risposta, valore compreso tra 0 e 1.

dialog

KnowledgeBaseAnswerDialog

Finestra di dialogo associata a Answer.

id

integer

ID del risultato QnA.

metadata

object

Metadati associati alla risposta, utili per classificare o filtrare le risposte alle domande.

questions

string[]

Elenco di domande associate alla risposta.

source

string

Origine del risultato QnA.

KnowledgeBaseAnswerContext

Oggetto contesto con le informazioni precedenti di QnA.

Nome Tipo Descrizione
previousQnaId

integer

L'ID QnA del risultato della risposta principale precedente.

previousUserQuery

string

Query utente precedente.

KnowledgeBaseAnswerDialog

Finestra di dialogo associata a Answer.

Nome Tipo Descrizione
isContextOnly

boolean

Per contrassegnare se una richiesta è rilevante solo con una domanda precedente o meno. Se true, non includere questo QnA come risultato della ricerca per le query senza contesto; in caso contrario, se false, ignora il contesto e include questo QnA nei risultati della ricerca.

prompts

KnowledgeBaseAnswerPrompt[]

Elenco di richieste associate alla risposta.

KnowledgeBaseAnswerPrompt

Richiedi una risposta.

Nome Tipo Descrizione
displayOrder

integer

Indice del prompt: usato nell'ordinamento delle richieste.

displayText

string

Testo visualizzato per rappresentare un prompt delle domande di completamento.

qnaId

integer

ID QnA corrispondente al prompt.

LengthResolution

Rappresenta il modello di risoluzione delle entità di lunghezza.

Nome Tipo Descrizione
resolutionKind string:

LengthResolution

Tipo di oggetto di risoluzione delle entità.

unit

LengthUnit

Unità di misura di lunghezza

value

number

Valore numerico che indica il testo estratto.

LengthUnit

Unità di misura di lunghezza.

Nome Tipo Descrizione
Centimeter

string

Unità di lunghezza centimetri

Decameter

string

Unità di lunghezza del decametro

Decimeter

string

Unità di lunghezza decimetro

Foot

string

Unità lunghezza piede

Hectometer

string

Unità di lunghezza dell'hectometro

Inch

string

Unità lunghezza pollice

Kilometer

string

Unità di lunghezza del chilometro

LightYear

string

Unità di lunghezza anno leggero

Meter

string

Unità lunghezza contatore

Micrometer

string

Unità di lunghezza micrometer

Mile

string

Unità di lunghezza miglio

Millimeter

string

Unità di lunghezza millimetri

Nanometer

string

Unità di lunghezza nanometrica

Picometer

string

Unità di lunghezza picometro

Pt

string

Unità lunghezza punto

Unspecified

string

Unità di lunghezza non specificata

Yard

string

Unità lunghezza cortile

ListKey

Tipo di dati aggiuntivi della chiave di elenco.

Nome Tipo Descrizione
extraInformationKind string:

ListKey

Tipo di oggetto informazioni aggiuntivo.

key

string

Forma canonica dell'entità estratta.

LogicalOperationKind

Operazione utilizzata per unire filtri di metadati.

Nome Tipo Descrizione
AND

string

AND logico

OR

string

OR logico

LuisCallingOptions

Ciò consente di personalizzare il modo in cui il servizio chiama i progetti LUIS disponibili a livello generale.

Nome Tipo Descrizione
bing-spell-check-subscription-key

string

Chiave di sottoscrizione da usare quando si abilita il controllo ortografico Bing

log

boolean

Salvare il log per aggiungere espressioni di training in un secondo momento.

show-all-intents

boolean

Impostare true per visualizzare tutte le finalità.

spellCheck

boolean

Abilitare il controllo ortografico.

timezoneOffset

integer

Offset del fuso orario per la posizione della richiesta.

verbose

boolean

Abilitare la risposta dettagliata.

LuisParameters

Si tratta di un set di parametri di richiesta per i progetti LUIS a disponibilità generale.

Nome Tipo Descrizione
apiVersion

string

Versione dell'API da usare quando si chiama un servizio di destinazione specifico.

callingOptions

LuisCallingOptions

Ciò consente di personalizzare il modo in cui il servizio chiama i progetti LUIS disponibili a livello generale.

query

string

Espressione da stimare.

targetProjectKind string:

Luis

Tipo di servizio di destinazione

LuisTargetIntentResult

Si tratta di un riepilogo della risposta LUIS disponibile a livello generale.

Nome Tipo Descrizione
apiVersion

string

Versione dell'API usata per chiamare un servizio di destinazione.

confidenceScore

number

Il punteggio di stima e varia da 0,0 a 1,0.

result

LuisResult

Risposta effettiva da un'applicazione LUIS disponibile a livello generale.

targetProjectKind string:

Luis

Si tratta della classe base di una stima delle finalità

MetadataFilter

Trovare domande e risposte associate all'elenco specificato di metadati.

Nome Tipo Valore predefinito Descrizione
logicalOperation

LogicalOperationKind

AND

Operazione utilizzata per unire filtri di metadati.

metadata

MetadataRecord[]

Elenco di metadati.

MetadataRecord

Oggetto per fornire la coppia di valori di chiave per ogni metadati.

Nome Tipo Descrizione
key

string

Chiave di metadati dal dizionario metadati usato nel QnA.

value

string

Valore dei metadati dal dizionario metadati usato nel QnA.

NoneLinkedTargetIntentResult

Riepilogo della risposta con finalità non collegate.

Nome Tipo Descrizione
apiVersion

string

Versione dell'API usata per chiamare un servizio di destinazione.

confidenceScore

number

Il punteggio di stima e varia da 0,0 a 1,0.

result

ConversationResult

Risposta effettiva da un progetto conversation.

targetProjectKind string:

NonLinked

Si tratta della classe base di una stima delle finalità

NumberKind

Tipo dell'entità numero estratto.

Nome Tipo Descrizione
Decimal

string

Numero decimale

Fraction

string

Numero frazionario

Integer

string

Numero intero

Percent

string

Numero percentuale

Power

string

Numero di alimentazione

Unspecified

string

Tipo di numero non specificato

NumberResolution

Risoluzione per le istanze di entità numeriche.

Nome Tipo Descrizione
numberKind

NumberKind

Tipo dell'entità numero estratto.

resolutionKind string:

NumberResolution

Tipo di oggetto di risoluzione delle entità.

value

number

Rappresentazione numerica di ciò che il testo estratto indica.

NumericRangeResolution

rappresenta la risoluzione degli intervalli numerici.

Nome Tipo Descrizione
maximum

number

Valore finale dell'intervallo.

minimum

number

Valore iniziale dell'intervallo.

rangeKind

RangeKind

Tipo di intervallo rappresentato dall'oggetto risoluzione.

resolutionKind string:

NumericRangeResolution

Tipo di oggetto di risoluzione delle entità.

OrchestrationPrediction

Rappresenta il risultato della stima di un progetto di orchestrazione.

Nome Tipo Descrizione
intents

object

Dizionario che contiene tutte le finalità. Una chiave è un nome di finalità e un valore è il relativo punteggio di attendibilità e il tipo di destinazione. Il valore della finalità superiore contiene anche la risposta effettiva del progetto di destinazione.

projectKind string:

Orchestration

Tipo del progetto.

topIntent

string

Finalità con il punteggio più alto.

OrdinalResolution

Risoluzione per le istanze di entità numeri ordinali.

Nome Tipo Descrizione
offset

string

Offset rispetto al riferimento ,ad esempio offset = -1 indica il secondo all'ultimo)

relativeTo

RelativeTo

Punto di riferimento che indica il numero ordinale.

resolutionKind string:

OrdinalResolution

Tipo di oggetto di risoluzione delle entità.

value

string

Espressione aritmetica semplice che indica l'ordinale.

projectKind

Tipo del progetto.

Nome Tipo Descrizione
Conversation

string

Tipo di conversazione

Orchestration

string

Tipo di orchestrazione

QueryFilters

filtra la knowledge base.

Nome Tipo Valore predefinito Descrizione
logicalOperation

LogicalOperationKind

AND

Operazione logica usata per unire il filtro dei metadati con il filtro di origine.

metadataFilter

MetadataFilter

filtra la knowledge base.

sourceFilter

string[]

filtra la knowledge base.

QuestionAnsweringParameters

Si tratta di un set di parametri di richiesta per le knowledge base di risposta alle domande.

Nome Tipo Descrizione
apiVersion

string

Versione dell'API da usare quando si chiama un servizio di destinazione specifico.

callingOptions

AnswersOptions

Le opzioni inviate a una Knowledge Base di risposte alle domande.

targetProjectKind string:

QuestionAnswering

Tipo di servizio di destinazione

QuestionAnsweringTargetIntentResult

Si tratta di una risposta della Knowledge Base di risposte alle domande.

Nome Tipo Descrizione
apiVersion

string

Versione dell'API usata per chiamare un servizio di destinazione.

confidenceScore

number

Il punteggio di stima e varia da 0,0 a 1,0.

result

AnswersResult

Risposta generata da una Knowledge Base di risposte alle domande.

targetProjectKind string:

QuestionAnswering

Si tratta della classe base di una stima delle finalità

RangeKind

Tipo di intervallo rappresentato dall'oggetto risoluzione.

Nome Tipo Descrizione
Age

string

Fascia di età

Area

string

Intervallo di aree

Currency

string

Intervallo di valuta

Information

string

Intervallo di informazioni

Length

string

Intervallo di lunghezza

Number

string

Intervallo di numeri

Speed

string

Intervallo di velocità

Temperature

string

Intervallo di temperatura

Volume

string

Intervallo di volumi

Weight

string

Intervallo di peso

RankerKind

Tipo di ranker da usare

Nome Tipo Descrizione
Default

string

Ranker predefinito.

QuestionOnly

string

Solo classificazione della domanda.

RegexKey

Tipo di dati aggiuntivi della chiave regex.

Nome Tipo Descrizione
extraInformationKind string:

RegexKey

Tipo di oggetto informazioni aggiuntivo.

key

string

Chiave del modello regex usato per estrarre l'entità.

regexPattern

string

Modello regex .NET usato per estrarre l'entità. Per altre informazioni sulle espressioni regolari .NET, visitare https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions.

RelativeTo

Punto di riferimento che indica il numero ordinale.

Nome Tipo Descrizione
Current

string

Stato corrente

End

string

Stato finale

Start

string

Stato iniziale

ResolutionKind

Tipo di oggetto di risoluzione delle entità.

Nome Tipo Descrizione
AgeResolution

string

Risoluzione di un'entità age

AreaResolution

string

Risoluzione di un'entità area

BooleanResolution

string

Risoluzione di un'entità booleana

CurrencyResolution

string

Risoluzione di un'entità valuta

DateTimeResolution

string

Risoluzione di un'entità data/ora

InformationResolution

string

Risoluzione di un'entità di informazioni

LengthResolution

string

Risoluzione di un'entità length

NumberResolution

string

Risoluzione di un'entità numerica

NumericRangeResolution

string

Risoluzione di un'entità di intervallo numerico

OrdinalResolution

string

Risoluzione di un'entità ordinale

SpeedResolution

string

Risoluzione di un'entità speed

TemperatureResolution

string

Risoluzione di un'entità temperatura

TemporalSpanResolution

string

Risoluzione di un'entità intervallo temporale

VolumeResolution

string

Risoluzione di un'entità volume

WeightResolution

string

Risoluzione di un'entità peso

role

Ruolo del partecipante.

Nome Tipo Descrizione
agent

string

Il partecipante è un agente.

customer

string

Il partecipante è un cliente.

generic

string

è un partecipante generico.

ShortAnswerOptions

Per configurare la funzionalità di stima dell'intervallo di risposte.

Nome Tipo Valore predefinito Descrizione
confidenceScoreThreshold

number

Punteggio soglia minimo necessario per includere un intervallo di risposte, il valore è compreso tra 0 e 1.

enable

boolean

True

Abilitare o disabilitare la stima dell'intervallo di risposte.

topAnswersWithSpan

integer

Numero di risposte principali da considerare per la stima dell'intervallo da 1 a 10.

SpeedResolution

Rappresenta il modello di risoluzione delle entità di velocità.

Nome Tipo Descrizione
resolutionKind string:

SpeedResolution

Tipo di oggetto di risoluzione delle entità.

unit

SpeedUnit

Unità di misura della velocità

value

number

Valore numerico che indica il testo estratto.

SpeedUnit

Unità di misura della velocità

Nome Tipo Descrizione
CentimetersPerMillisecond

string

Centimetri per millisecondo unità di velocità

FootPerMinute

string

Unità di velocità piede al minuto

FootPerSecond

string

Unità di velocità piede al secondo

KilometersPerHour

string

Unità di velocità chilometri all'ora

KilometersPerMillisecond

string

Chilometri per unità di velocità in millisecondi

KilometersPerMinute

string

Chilometri al minuto unità di velocità

KilometersPerSecond

string

Unità di velocità chilometri al secondo

Knot

string

Unità di velocità nodo

MetersPerMillisecond

string

Metri per millisecondo unità di velocità

MetersPerSecond

string

Unità di velocità metri al secondo

MilesPerHour

string

Unità di velocità miglia all'ora

Unspecified

string

Unità di velocità non specificata

YardsPerMinute

string

Unità di velocità yard al minuto

YardsPerSecond

string

Unità di velocità yard al secondo

StringIndexType

Tipo di indice stringa

Nome Tipo Descrizione
TextElements_v8

string

I valori di offset e lunghezza restituiti corrispondono a TextElements (cluster Graphemes e Grapheme) che confermano lo standard Unicode 8.0.0. Usare questa opzione se l'applicazione è scritta in .Net Framework o .Net Core e si userà StringInfo.

UnicodeCodePoint

string

I valori di offset e lunghezza restituiti corrispondono ai punti di codice Unicode. Usare questa opzione se l'applicazione è scritta in un linguaggio che supporta Unicode, ad esempio Python.

Utf16CodeUnit

string

I valori di offset e lunghezza restituiti corrispondono alle unità di codice UTF-16. Usare questa opzione se l'applicazione viene scritta in un linguaggio che supporta Unicode, ad esempio JavaScript.

targetProjectKind

Tipo di servizio di destinazione.

Nome Tipo Descrizione
Conversation

string

Tipo di servizio di destinazione conversazione

Luis

string

Tipo di servizio di destinazione Luis

NonLinked

string

Tipo di servizio di destinazione non collegato

QuestionAnswering

string

Tipo di servizio di destinazione QuestionAnswering

TemperatureResolution

Rappresenta il modello di risoluzione delle entità della temperatura.

Nome Tipo Descrizione
resolutionKind string:

TemperatureResolution

Tipo di oggetto di risoluzione delle entità.

unit

TemperatureUnit

Unità di misura della temperatura.

value

number

Valore numerico che indica il testo estratto.

TemperatureUnit

Unità di misura della temperatura.

Nome Tipo Descrizione
Celsius

string

Unità di temperatura Celsius

Fahrenheit

string

Unità di temperatura Fahrenheit

Kelvin

string

Unità di temperatura Kelvin

Rankine

string

Unità di temperatura Rankine

Unspecified

string

Unità di temperatura non specificata

TemporalModifier

Modificatore facoltativo di un'istanza di data/ora.

Nome Tipo Descrizione
After

string

Dopo il modificatore temporale

AfterApprox

string

Modificatore temporale AfterApprox

AfterMid

string

Modificatore temporale AfterMid

AfterStart

string

Modificatore temporale AfterStart

Approx

string

Modificatore temporale approssimativo

Before

string

Prima del modificatore temporale

BeforeApprox

string

Modificatore temporale BeforeApprox

BeforeEnd

string

Modificatore temporale BeforeEnd

BeforeStart

string

Modificatore temporale BeforeStart

End

string

Modificatore temporale finale

Less

string

Modificatore meno temporale

Mid

string

Modificatore temporale medio

More

string

Modificatore più temporale

ReferenceUndefined

string

Modificatore temporale ReferenceUndefined

Since

string

Dal modificatore temporale

SinceEnd

string

Modificatore temporale SinceEnd

Start

string

Avviare il modificatore temporale

Until

string

Fino al modificatore temporale

TemporalSpanResolution

rappresenta la risoluzione di una data e/o di un intervallo di tempo.

Nome Tipo Descrizione
begin

string

rappresenta la risoluzione di una data e/o di un intervallo di tempo. Rappresentazione di data/ora ISO 8601 estesa come descritto in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)

duration

string

Valore di durata facoltativo formattato in base a ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)

end

string

rappresenta la risoluzione di una data e/o di un intervallo di tempo. Rappresentazione di data/ora ISO 8601 estesa come descritto in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)

modifier

TemporalModifier

Modificatore facoltativo di un'istanza di data/ora.

resolutionKind string:

TemporalSpanResolution

Tipo di oggetto di risoluzione delle entità.

timex

string

Triplo facoltativo contenente l'inizio, la fine e la durata sono tutte indicate come stringhe formattate ISO 8601.

TextConversationItem

Modalità di testo di una conversazione di input.

Nome Tipo Descrizione
id

string

ID di un elemento di conversazione.

language

string

Linguaggio di override di un elemento di conversazione nella rappresentazione in lingua BCP 47.

modality

InputModality

Enumerazione delle modalità di conversazione supportate.

participantId

string

ID partecipante di un elemento di conversazione.

role

role

Ruolo del partecipante.

text

string

Input di testo

VolumeResolution

Rappresenta il modello di risoluzione delle entità del volume.

Nome Tipo Descrizione
resolutionKind string:

VolumeResolution

Tipo di oggetto di risoluzione delle entità.

unit

VolumeUnit

Unità di misura del volume

value

number

Valore numerico che indica il testo estratto.

VolumeUnit

Unità di misura del volume

Nome Tipo Descrizione
Barrel

string

Unità di volume in barili.

Bushel

string

Unità di volume in cespugli.

Centiliter

string

Unità di volume in centiliter.

Cord

string

Unità di volume nei cavi.

CubicCentimeter

string

Unità di volume in centimetri cubi.

CubicFoot

string

Unità di volume in piedi cubici.

CubicInch

string

Unità di volume in pollici cubi.

CubicMeter

string

Unità di volume in metri cubi.

CubicMile

string

Unità di volume in miglia cubiche.

CubicMillimeter

string

Unità di volume in millimetri cubi.

CubicYard

string

Unità di volume in metri cubi.

Cup

string

Unità di volume in tazze.

Decaliter

string

Unità di volume nei decalitter.

FluidDram

string

Unità di volume in drammi fluidi.

FluidOunce

string

Unità di volume in once fluide.

Gill

string

Unità di volume nelle branchie.

Hectoliter

string

Unità di volume negli hectoliter.

Hogshead

string

Unità di volume in teste.

Liter

string

Unità di volume in litri.

Milliliter

string

Unità di volume in milliliter.

Minim

string

Unità di volume in minims.

Peck

string

Unità di volume in peck.

Pinch

string

Unità di volume in avvicinamento delle dita.

Pint

string

Unità di volume in pinte.

Quart

string

Unità di volume in quart.

Tablespoon

string

Unità volume in cucchiai.

Teaspoon

string

Unità volume in cucchiaini.

Unspecified

string

Unità di volume non specificata.

WeightResolution

Rappresenta il modello di risoluzione delle entità di ponderazione.

Nome Tipo Descrizione
resolutionKind string:

WeightResolution

Tipo di oggetto di risoluzione delle entità.

unit

WeightUnit

Unità di misura del peso.

value

number

Valore numerico che indica il testo estratto.

WeightUnit

Unità di misura del peso.

Nome Tipo Descrizione
Dram

string

Unità di peso in drammi

Gallon

string

Unità di volume in galloni

Grain

string

Unità di peso in grani

Gram

string

Unità di peso in grammi

Kilogram

string

Unità di peso in kg

LongTonBritish

string

Unità di peso in tonnellate lunghe (britannico)

MetricTon

string

Unità di peso in tonnellate di metrica

Milligram

string

Unità di peso ingrammi

Ounce

string

Unità di peso in once

PennyWeight

string

Unità di peso in pennyweight

Pound

string

Unità di peso in libbre

ShortHundredWeightUS

string

Unità di peso in centinaia di pesi brevi (STATI UNITI)

ShortTonUS

string

Unità di peso in tonnellate brevi (STATI UNITI)

Stone

string

Unità di peso in pietre

Ton

string

Unità di peso in tonnellate

Unspecified

string

Unità di peso non specificata