SpellCheckClientExtensions.SpellCheckerAsync Método

Definição

Namespace:

Microsoft.Azure.CognitiveServices.Language.SpellCheck

Assembly:

Microsoft.Azure.CognitiveServices.Language.SpellCheck.dll

Pacote:

Microsoft.Azure.CognitiveServices.Language.SpellCheck v4.0.0

A API de Verificação Ortográfica do Bing permite fazer verificações contextuais de gramática e ortografia. O Bing desenvolveu um corretor ortográfico baseado na web que aproveita o aprendizado de máquina e a tradução automática estatística para treinar dinamicamente um algoritmo em constante evolução e altamente contextual. O verificador ortográfico baseia-se em um grande corpus de documentos e pesquisas da Web.

public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Language.SpellCheck.Models.SpellCheckModel> SpellCheckerAsync (this Microsoft.Azure.CognitiveServices.Language.SpellCheck.ISpellCheckClient operations, string text, string acceptLanguage = default, string pragma = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string actionType = default, string appName = default, string countryCode = default, string clientMachineName = default, string docId = default, string market = default, string sessionId = default, string setLang = default, string userId = default, string mode = default, string preContextText = default, string postContextText = default, System.Threading.CancellationToken cancellationToken = default);

static member SpellCheckerAsync : Microsoft.Azure.CognitiveServices.Language.SpellCheck.ISpellCheckClient * string * string * string * string * string * string * string * string * string * string * string * string * string * string * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Language.SpellCheck.Models.SpellCheckModel>

<Extension()>
Public Function SpellCheckerAsync (operations As ISpellCheckClient, text As String, Optional acceptLanguage As String = Nothing, Optional pragma As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional actionType As String = Nothing, Optional appName As String = Nothing, Optional countryCode As String = Nothing, Optional clientMachineName As String = Nothing, Optional docId As String = Nothing, Optional market As String = Nothing, Optional sessionId As String = Nothing, Optional setLang As String = Nothing, Optional userId As String = Nothing, Optional mode As String = Nothing, Optional preContextText As String = Nothing, Optional postContextText As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of SpellCheckModel)

Parâmetros

operations

ISpellCheckClient

O grupo de operações para esse método de extensão.

text

String

A cadeia de caracteres de texto a marcar para erros ortográficos e gramaticais. O comprimento combinado da cadeia de caracteres de texto, da cadeia de caracteres preContextText e da cadeia de caracteres postContextText pode não exceder 10.000 caracteres. Você pode especificar esse parâmetro na cadeia de caracteres de consulta de uma solicitação GET ou no corpo de uma solicitação POST. Devido ao limite de comprimento da cadeia de caracteres de consulta, você normalmente usará uma solicitação POST, a menos que esteja verificando apenas cadeias de caracteres curtas.

acceptLanguage

String

Uma lista delimitada por vírgulas de um ou mais idiomas a serem usados para cadeias de caracteres de interface do usuário. A lista está em ordem decrescente de preferência. Para obter informações adicionais, incluindo o formato esperado, consulte RFC2616. Esse cabeçalho e o parâmetro de consulta setLang são mutuamente exclusivos; não especifique ambos. Se você definir esse cabeçalho, também deverá especificar o parâmetro de consulta cc. O Bing usará a primeira linguagem com suporte encontrada na lista e combinará essa linguagem com o valor do parâmetro cc para determinar o mercado para o qual retornar os resultados. Se a lista não incluir um idioma com suporte, o Bing encontrará o idioma e o mercado mais próximos que dão suporte à solicitação e poderá usar um mercado agregado ou padrão para os resultados em vez de um especificado. Você deve usar esse cabeçalho e o parâmetro de consulta cc somente se especificar vários idiomas; caso contrário, você deve usar os parâmetros de consulta mkt e setLang. Uma cadeia de caracteres de interface do usuário é uma cadeia de caracteres que é usada como um rótulo em uma interface do usuário. Há muito poucas cadeias de caracteres de interface do usuário nos objetos de resposta JSON. Todos os links nos objetos de resposta para Bing.com propriedades aplicarão o idioma especificado.

pragma

String

Por padrão, o Bing retorna o conteúdo armazenado em cache se disponível. Para impedir que o Bing retorne o conteúdo armazenado em cache, defina o cabeçalho Pragma como no-cache (por exemplo, Pragma: no-cache).

userAgent

String

O agente do usuário que originou a solicitação. O Bing usa o agente do usuário para fornecer uma experiência otimizada aos usuários móveis. Embora seja opcional, você é altamente incentivado a sempre especificar esse cabeçalho. O agente de usuário deve ser a mesma cadeia de caracteres que qualquer navegador comumente usado enviaria. Para obter informações sobre agentes do usuário, confira RFC 2616.

clientId

String

O Bing usa esse cabeçalho para fornecer aos usuários um comportamento consistente nas chamadas à API do Bing. Em geral, o Bing faz o pré-lançamento de novos recursos e novas melhorias e usa a ID do cliente como uma chave para atribuição de tráfego em versões de pré-lançamento diferentes. Se você não usar a mesma ID do cliente para um usuário em várias solicitações, o Bing poderá atribuir o usuário a várias versões de pré-lançamento conflitantes. A atribuição a várias versões de pré-lançamento conflitantes pode levar a uma experiência do usuário inconsistente. Por exemplo, se a segunda solicitação tem uma atribuição de versão de pré-lançamento diferente da primeira, a experiência pode ser inesperada. Além disso, o Bing pode usar a ID do cliente para adaptar os resultados da Web ao histórico de pesquisa dessa ID do cliente, fornecendo uma experiência mais rica para o usuário. O Bing também usa esse cabeçalho para ajudar a melhorar as classificações de resultado pela análise da atividade gerada por uma ID do cliente. As melhorias de relevância ajudam com uma melhor qualidade dos resultados fornecidos pelas APIs do Bing e, por sua vez, permitem taxas de clickthrough mais altas para o consumidor da API. IMPORTANTE: embora isso seja opcional, você deve considerar esse cabeçalho obrigatório. A persistência da ID do cliente em várias solicitações para a mesma combinação de usuário final e dispositivo permite 1) ao consumidor da API receber uma experiência do usuário consistente e 2) taxas de clickthrough mais altas por meio de uma melhor qualidade dos resultados das APIs do Bing. Cada usuário que usa o aplicativo no dispositivo precisa ter uma ID do cliente exclusiva gerada pelo Bing. Se você não incluir esse cabeçalho na solicitação, o Bing gerará uma ID e a retornará no cabeçalho de resposta X-MSEdge-ClientID. A única vez que você NÃO deve incluir esse cabeçalho em uma solicitação é a primeira vez que o usuário usa o aplicativo nesse dispositivo. Use a ID do cliente para cada solicitação da API do Bing feita pelo aplicativo para esse usuário no dispositivo. Persista a ID do cliente. Para persistir a ID em um aplicativo de navegador, use um cookie HTTP persistente para garantir que a ID seja usada em todas as sessões. Não use um cookie de sessão. Para outros aplicativos, como aplicativos móveis, use o armazenamento persistente do dispositivo para persistir a ID. Na próxima vez que o usuário usar o aplicativo no dispositivo, obtenha a ID do cliente persistente. As respostas do Bing podem ou não incluir esse cabeçalho. Se a resposta incluir esse cabeçalho, capture a ID do cliente e use-a para todas as solicitações seguintes do Bing para o usuário no dispositivo. Se você incluir o X-MSEdge-ClientID, não deverá incluir cookies na solicitação.

clientIp

String

O endereço IPv4 ou IPv6 do dispositivo cliente. O endereço IP é usado para descobrir o local do usuário. O Bing usa as informações de local para determinar o comportamento da pesquisa segura. Embora opcional, é recomendável sempre especificar esse cabeçalho e o cabeçalho X-Search-Location. Não oculte o endereço (por exemplo, alterando o último octeto para 0). Se você ocultar o endereço, isso fará com que o local não fique em nenhum lugar próximo ao local real do dispositivo, o que poderá resultar no fornecimento de resultados incorretos pelo Bing.

location

String

Uma lista delimitada por ponto-e-vírgula de pares chave/valor que descrevem a localização geográfica do cliente. O Bing usa as informações de local para determinar o comportamento da pesquisa segura e retornar o conteúdo local relevante. Especifique o par chave/valor como <key>:<value>. Veja a seguir as chaves usadas para especificar o local do usuário. lat (obrigatório): a latitude do local do cliente, em graus. A latitude precisa ser superior ou igual a -90,0 e inferior ou igual a +90,0. Valores negativos indicam latitudes sul e valores positivos indicam latitudes norte. long (obrigatório): a longitude do local do cliente, em graus. A longitude precisa ser superior ou igual a -180,0 e inferior ou igual a +180,0. Valores negativos indicam longitudes oeste e valores positivos indicam longitudes leste. re (obrigatório): o raio, em metros, que especifica a precisão horizontal das coordenadas. Passe o valor retornado pelo serviço de local do dispositivo. Os valores típicos podem ser 22 m para GPS/Wi-Fi, 380 m para triangulação de torres de celular e 18.000 m para a pesquisa inversa de IP. ts (opcional): o carimbo de data/hora UTC UNIX de quando o cliente estava no local. (O carimbo de data/hora UNIX é o número de segundos desde 1º de janeiro de 1970.) head (opcional): o título relativo do cliente ou a direção da viagem. Especifique a direção da viagem como graus de 0 a 360, no sentido horário em relação ao norte verdadeiro. Especifique essa chave somente se a chave sp for diferente de zero. sp (opcional): a velocidade horizontal (velocidade), em metros por segundo, que o dispositivo cliente está viajando. alt (opcional): a altitude do dispositivo cliente, em metros. são (opcional): o raio, em metros, que especifica a precisão vertical das coordenadas. Especifique essa chave somente se você especificar a tecla Alt. Embora muitas chaves sejam opcionais, quanto mais informações você fornecer, mais precisos serão os resultados da localização. Embora opcional, é recomendável sempre especificar a localização geográfica do usuário. O fornecimento do local é especialmente importante se o endereço IP do cliente não reflete precisamente o local físico do usuário (por exemplo, se o cliente usa VPN). Para obter resultados ideais, você deve incluir esse cabeçalho e o cabeçalho X-Search-ClientIP, mas, no mínimo, você deve incluir esse cabeçalho.

actionType

String

Uma cadeia de caracteres usada pelo registro em log para determinar se a solicitação vem de uma sessão interativa ou de um carregamento de página. Veja os valores possíveis a seguir: 1) Editar — A solicitação é de uma sessão interativa 2) Carregar — A solicitação é de um carregamento de página. Os valores possíveis incluem: 'Editar', 'Carregar'

appName

String

O nome exclusivo do seu aplicativo. O nome deve ser conhecido pelo Bing. Não inclua esse parâmetro, a menos que você tenha contatado anteriormente o Bing para obter um nome de aplicativo exclusivo. Para obter um nome exclusivo, entre em contato com o gerente de Desenvolvimento de Negócios do Bing.

countryCode

String

O código de dois caracteres do país do qual os resultados são obtidos. Essa API dá suporte apenas ao mercado de Estados Unidos. Se você especificar esse parâmetro de consulta, ele deverá ser definido para nós. Se você definir esse parâmetro, também precisará especificar o cabeçalho Accept-Language. O Bing usa o primeiro idioma com suporte encontrado na lista de idiomas e combina esse idioma com o código do país que você especifica para determinar o mercado para o qual retornar os resultados. Se a lista de idiomas não incluir um idioma com suporte, o Bing localizará o idioma e o mercado mais próximos que dão suporte à solicitação ou poderá usar um mercado agregado ou padrão para os resultados em vez de um especificado. Você deve usar esse parâmetro de consulta e o parâmetro de consulta Accept-Language somente se especificar vários idiomas; caso contrário, você deve usar os parâmetros de consulta mkt e setLang. Esse parâmetro e o parâmetro de consulta mkt são mutuamente exclusivos – não especifique ambos.

clientMachineName

String

Um nome exclusivo do dispositivo do qual a solicitação está sendo feita. Gere um valor exclusivo para cada dispositivo (o valor não é importante). O serviço usa a ID para ajudar a depurar problemas e melhorar a qualidade das correções.

docId

String

Uma ID exclusiva que identifica o documento ao qual o texto pertence. Gere um valor exclusivo para cada documento (o valor não é importante). O serviço usa a ID para ajudar a depurar problemas e melhorar a qualidade das correções.

market

String

O mercado do qual os resultados são obtidos. Você é fortemente incentivado a sempre especificar o mercado, se conhecido. A especificação do mercado ajuda o Bing a encaminhar a solicitação e retornar uma resposta apropriada e ideal. Esse parâmetro e o parâmetro de consulta cc são mutuamente exclusivos – não especifique ambos.

sessionId

String

Uma ID exclusiva que identifica essa sessão de usuário. Gere um valor exclusivo para cada sessão de usuário (o valor não é importante). O serviço usa a ID para ajudar a depurar problemas e melhorar a qualidade das correções

setLang

String

O idioma a ser usado para cadeias de caracteres de interface do usuário. Especifique o idioma usando o código de idioma ISO 639-1 de 2 letras. Por exemplo, o código de idioma para o inglês é EN. O padrão é EN (inglês). Embora isso seja opcional, você sempre deve especificar o idioma. Normalmente, você define setLang como o mesmo idioma especificado pelo mkt, a menos que o usuário queira que as cadeias de caracteres de interface do usuário sejam exibidas em um idioma diferente. Esse parâmetro e o cabeçalho Accept-Language são mutuamente exclusivos – não especifique ambos. Uma cadeia de caracteres de interface do usuário é uma cadeia de caracteres que é usada como um rótulo em uma interface do usuário. Há poucas cadeias de caracteres de interface do usuário nos objetos de resposta JSON. Além disso, todos os links para as propriedades de Bing.com nos objetos de resposta aplicam o idioma especificado.

userId

String

Uma ID exclusiva que identifica o usuário. Gere um valor exclusivo para cada usuário (o valor não é importante). O serviço usa a ID para ajudar a depurar problemas e melhorar a qualidade das correções.

mode

String

O tipo de verificações ortográficas e gramaticais a serem executadas. A seguir estão os valores possíveis (os valores não diferenciam maiúsculas de minúsculas). O padrão é Prova. 1) Prova — localiza a maioria dos erros ortográficos e gramaticais. 2) Ortografia — localiza a maioria dos erros ortográficos, mas não encontra alguns dos erros gramaticais que Proof captura (por exemplo, maiúsculas e palavras repetidas). Os valores possíveis incluem: 'proof', 'spell'

preContextText

String

Uma cadeia de caracteres que dá contexto à cadeia de caracteres de texto. Por exemplo, a pétala de cadeia de texto é válida. No entanto, se você definir preContextText como bike, o contexto será alterado e a cadeia de caracteres de texto se tornará inválida. Nesse caso, a API sugere que você altere pétala para pedal (como no pedal da bicicleta). Este texto não é verificado quanto a erros gramaticais ou ortográficos. O comprimento combinado da cadeia de caracteres de texto, da cadeia de caracteres preContextText e da cadeia de caracteres postContextText pode não exceder 10.000 caracteres. Você pode especificar esse parâmetro na cadeia de caracteres de consulta de uma solicitação GET ou no corpo de uma solicitação POST.

postContextText

String

Uma cadeia de caracteres que dá contexto à cadeia de caracteres de texto. Por exemplo, a leitura da cadeia de texto é válida. No entanto, se você definir postContextText como carpete, o contexto será alterado e a cadeia de caracteres de texto se tornará inválida. Nesse caso, a API sugere que você altere a leitura para vermelho (como no tapete vermelho). Este texto não é verificado quanto a erros gramaticais ou ortográficos. O comprimento combinado da cadeia de caracteres de texto, da cadeia de caracteres preContextText e da cadeia de caracteres postContextText pode não exceder 10.000 caracteres. Você pode especificar esse parâmetro na cadeia de caracteres de consulta de uma solicitação GET ou no corpo de uma solicitação POST.

cancellationToken

CancellationToken

O token de cancelamento.

Retornos

Task<SpellCheckModel>