@azure/search-documents package
Classes
AzureKeyCredential |
Uma credencial baseada em chave estática que dá suporte à atualização do valor da chave subjacente. |
GeographyPoint |
Representa um ponto geográfico em coordenadas globais. |
IndexDocumentsBatch |
Classe usada para executar operações em lote com vários documentos para o índice. |
SearchClient |
Classe usada para executar operações em um índice de pesquisa, incluindo consultar documentos no índice, bem como adicioná-los, atualizá-los e removê-los. |
SearchIndexClient |
Classe para executar operações para gerenciar índices (criar, atualizar, listar/excluir), & sinônimos. |
SearchIndexerClient |
Classe para executar operações para gerenciar (criar, atualizar, listar/excluir) indexadores, fontes de dados & conjuntos de habilidades. |
SearchIndexingBufferedSender |
Classe usada para executar operações em buffer em um índice de pesquisa, incluindo adição, atualização e remoção delas. |
Interfaces
AnalyzeRequest |
Especifica alguns componentes de texto e análise usados para dividir esse texto em tokens. |
AnalyzeResult |
O resultado do teste de um analisador no texto. |
AnalyzedTokenInfo |
Informações sobre um token retornado por um analisador. |
AsciiFoldingTokenFilter |
Converte caracteres Unicode alfabéticos, numéricos e simbólicos que não estão nos primeiros 127 caracteres ASCII (o bloco Unicode "Latino Básico") em seus equivalentes ASCII, se esses equivalentes existirem. Esse filtro de token é implementado usando o Apache Lucene. |
AutocompleteItem |
O resultado das solicitações de preenchimento automático. |
AutocompleteRequest |
Parâmetros para correspondência difusa e outros comportamentos de consulta de preenchimento automático. |
AutocompleteResult |
O resultado da consulta de preenchimento automático. |
AzureActiveDirectoryApplicationCredentials |
Credenciais de um aplicativo registrado criado para seu serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault. |
AzureOpenAIEmbeddingSkill |
Permite que você gere uma inserção de vetor para uma determinada entrada de texto usando o recurso Azure OpenAI. |
AzureOpenAIParameters |
Contém os parâmetros específicos para usar um serviço de IA Aberta do Azure para vetorização no momento da consulta. |
AzureOpenAIVectorizer |
Contém os parâmetros específicos para usar um serviço de IA Aberta do Azure para vetorização no momento da consulta. |
BM25Similarity |
Função de classificação com base no algoritmo de similaridade Okapi BM25. BM25 é um algoritmo do tipo TF-IDF que inclui normalização de comprimento (controlada pelo parâmetro 'b'), bem como saturação de frequência de termo (controlada pelo parâmetro 'k1'). |
BaseCharFilter |
Tipo base para filtros de caractere. |
BaseCognitiveServicesAccount |
Tipo base para descrever qualquer recurso de serviço de IA do Azure anexado a um conjunto de habilidades. |
BaseDataChangeDetectionPolicy |
Tipo base para políticas de detecção de alterações de dados. |
BaseDataDeletionDetectionPolicy |
Tipo base para políticas de detecção de exclusão de dados. |
BaseLexicalAnalyzer |
Tipo base para analisadores. |
BaseLexicalTokenizer |
Tipo base para tokenizadores. |
BaseScoringFunction |
Tipo base para funções que podem modificar as pontuações do documento durante a classificação. |
BaseSearchIndexerDataIdentity |
Tipo base abstrato para identidades de dados. |
BaseSearchIndexerSkill |
Tipo base para habilidades. |
BaseSearchRequestOptions |
Parâmetros para filtragem, classificação, faceta, paginação e outros comportamentos de consulta de pesquisa. |
BaseTokenFilter |
Tipo base para filtros de token. |
BaseVectorQuery |
Os parâmetros de consulta para consultas de pesquisa vetor e híbrida. |
BaseVectorSearchAlgorithmConfiguration |
Contém opções de configuração específicas para o algoritmo usado durante a indexação e/ou consulta. |
BaseVectorSearchCompression |
Contém opções de configuração específicas para o método de compactação usado durante a indexação ou consulta. |
BaseVectorSearchVectorizer |
Contém detalhes específicos para um método de vetorização a ser usado durante o tempo de consulta. |
BinaryQuantizationCompression |
Contém opções de configuração específicas para o método de compactação de quantização binária usado durante a indexação e a consulta. |
CjkBigramTokenFilter |
Forma bigrams de termos CJK gerados a partir do tokenizador padrão. Esse filtro de token é implementado usando o Apache Lucene. |
ClassicSimilarity |
Algoritmo de similaridade herdado que usa a implementação lucene TFIDFSimilarity do TF-IDF. Essa variação de TF-IDF introduz a normalização do comprimento do documento estático, bem como fatores de coordenação que penalizam documentos que correspondem apenas parcialmente às consultas pesquisadas. |
ClassicTokenizer |
Tokenizador baseado em gramática adequado para processar a maioria dos documentos em idioma europeu. Esse tokenizador é implementado usando o Apache Lucene. |
CognitiveServicesAccountKey |
A chave da conta de várias regiões de um recurso de serviço de IA do Azure anexado a um conjunto de habilidades. |
CommonGramTokenFilter |
Construa bigrams para termos frequentes durante a indexação. Termos únicos ainda são indexados também, com bigrams sobrepostos. Esse filtro de token é implementado usando o Apache Lucene. |
ComplexField |
Representa um campo em uma definição de índice, que descreve o nome, o tipo de dados e o comportamento de pesquisa de um campo. |
ConditionalSkill |
Uma habilidade que permite cenários que exigem uma operação booliana para determinar os dados a serem atribuídos a uma saída. |
CorsOptions |
Define opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para um índice. |
CreateOrUpdateIndexOptions |
Opções para criar/atualizar a operação de índice. |
CreateOrUpdateSkillsetOptions |
Opções para a operação de conjunto de habilidades de criação/atualização. |
CreateOrUpdateSynonymMapOptions |
Opções para a operação de synonymmap de criação/atualização. |
CreateorUpdateDataSourceConnectionOptions |
Opções para criar/atualizar a operação de fonte de dados. |
CreateorUpdateIndexerOptions |
Opções para a operação do indexador de criação/atualização. |
CustomAnalyzer |
Permite que você assuma o controle sobre o processo de conversão de texto em tokens indexáveis/pesquisáveis. É uma configuração definida pelo usuário que consiste em um único tokenizador predefinido e um ou mais filtros. O tokenizador é responsável por dividir texto em tokens e os filtros para modificar tokens emitidos pelo tokenizer. |
CustomEntity |
Um objeto que contém informações sobre as correspondências que foram encontradas e metadados relacionados. |
CustomEntityAlias |
Um objeto complexo que pode ser usado para especificar ortografias ou sinônimos alternativos para o nome da entidade raiz. |
CustomEntityLookupSkill |
Uma habilidade procura texto de uma lista personalizada definida pelo usuário de palavras e frases. |
DefaultCognitiveServicesAccount |
Um objeto vazio que representa o recurso de serviço de IA do Azure padrão para um conjunto de habilidades. |
DeleteDataSourceConnectionOptions |
Opções para excluir a operação de fonte de dados. |
DeleteIndexOptions |
Opções para excluir a operação de índice. |
DeleteIndexerOptions |
Opções para excluir a operação do indexador. |
DeleteSkillsetOptions |
Opções para excluir a operação do conjunto de habilidades. |
DeleteSynonymMapOptions |
Opções para a operação de synonymmap de exclusão. |
DictionaryDecompounderTokenFilter |
Decompõe palavras compostas encontradas em muitas línguas germânicas. Esse filtro de token é implementado usando o Apache Lucene. |
DistanceScoringFunction |
Define uma função que aumenta as pontuações com base na distância de uma localização geográfica. |
DistanceScoringParameters |
Fornece valores de parâmetro para uma função de pontuação de distância. |
DocumentExtractionSkill |
Uma habilidade que extrai conteúdo de um arquivo dentro do pipeline de enriquecimento. |
EdgeNGramTokenFilter |
Gera n-gramas dos tamanhos fornecidos a partir da frente ou da parte traseira de um token de entrada. Esse filtro de token é implementado usando o Apache Lucene. |
EdgeNGramTokenizer |
Tokeniza a entrada de uma borda em n-gramas dos tamanhos fornecidos. Esse tokenizador é implementado usando o Apache Lucene. |
ElisionTokenFilter |
Remove elisões. Por exemplo, "l'avion" (o plano) será convertido em "avion" (plano). Esse filtro de token é implementado usando o Apache Lucene. |
EntityLinkingSkill |
Usando a API de Análise de Texto, extrai entidades vinculadas do texto. |
EntityRecognitionSkill |
Reconhecimento de entidade de análise de texto. |
EntityRecognitionSkillV3 |
Usando a API de Análise de Texto, extrai entidades de diferentes tipos do texto. |
ExhaustiveKnnParameters |
Contém os parâmetros específicos para o algoritmo KNN exaustivo. |
ExtractiveQueryAnswer |
Extrai os candidatos de resposta do conteúdo dos documentos retornados em resposta a uma consulta expressa como uma pergunta em linguagem natural. |
ExtractiveQueryCaption |
Extrai legendas dos documentos correspondentes que contêm passagens relevantes para a consulta de pesquisa. |
FacetResult |
Um único bucket de um resultado de consulta de faceta. Relata o número de documentos com um valor de campo caindo dentro de um intervalo específico ou com um determinado valor ou intervalo. |
FieldMapping |
Define um mapeamento entre um campo em uma fonte de dados e um campo de destino em um índice. |
FieldMappingFunction |
Representa uma função que transforma um valor de uma fonte de dados antes da indexação. |
FreshnessScoringFunction |
Define uma função que aumenta as pontuações com base no valor de um campo de data e hora. |
FreshnessScoringParameters |
Fornece valores de parâmetro para uma função de pontuação de atualização. |
GetDocumentOptions |
Opções para recuperar um único documento. |
HighWaterMarkChangeDetectionPolicy |
Define uma política de detecção de alteração de dados que captura alterações com base no valor de uma coluna de marca d'água alta. |
HnswParameters |
Contém os parâmetros específicos do algoritmo hnsw. |
ImageAnalysisSkill |
Uma habilidade que analisa arquivos de imagem. Ele extrai um conjunto avançado de recursos visuais com base no conteúdo da imagem. |
IndexDocumentsClient |
Cliente de Documentos de Índice |
IndexDocumentsOptions |
Opções para a operação de modificação do lote de índice. |
IndexDocumentsResult |
Resposta que contém o status das operações para todos os documentos na solicitação de indexação. |
IndexerExecutionResult |
Representa o resultado de uma execução individual do indexador. |
IndexingParameters |
Representa parâmetros para a execução do indexador. |
IndexingParametersConfiguration |
Um dicionário de propriedades de configuração específicas do indexador. Cada nome é o nome de uma propriedade específica. Cada valor deve ser de um tipo primitivo. |
IndexingResult |
Status de uma operação de indexação para um único documento. |
IndexingSchedule |
Representa um agendamento para a execução do indexador. |
InputFieldMappingEntry |
Mapeamento de campo de entrada para uma habilidade. |
KeepTokenFilter |
Um filtro de token que mantém apenas tokens com texto contido em uma lista de palavras especificada. Esse filtro de token é implementado usando o Apache Lucene. |
KeyPhraseExtractionSkill |
Uma habilidade que usa a análise de texto para extração de frases-chave. |
KeywordMarkerTokenFilter |
Marca termos como palavras-chave. Esse filtro de token é implementado usando o Apache Lucene. |
KeywordTokenizer |
Emite toda a entrada como um único token. Esse tokenizador é implementado usando o Apache Lucene. |
LanguageDetectionSkill |
Uma habilidade que detecta o idioma do texto de entrada e relata um único código de idioma para cada documento enviado na solicitação. O código de idioma é emparelhado com uma pontuação que indica a confiança da análise. |
LengthTokenFilter |
Remove palavras muito longas ou muito curtas. Esse filtro de token é implementado usando o Apache Lucene. |
LimitTokenFilter |
Limita o número de tokens durante a indexação. Esse filtro de token é implementado usando o Apache Lucene. |
ListSearchResultsPageSettings |
Argumentos para recuperar a próxima página de resultados da pesquisa. |
LuceneStandardAnalyzer |
Analisador standard do Apache Lucene; Composto pelo tokenizador padrão, filtro em letras minúsculas e filtro de parada. |
LuceneStandardTokenizer |
Quebra o texto seguindo as regras de Segmentação de Texto Unicode. Esse tokenizador é implementado usando o Apache Lucene. |
MagnitudeScoringFunction |
Define uma função que aumenta as pontuações com base na magnitude de um campo numérico. |
MagnitudeScoringParameters |
Fornece valores de parâmetro para uma função de pontuação de magnitude. |
MappingCharFilter |
Um filtro de caractere que aplica mapeamentos definidos com a opção de mapeamentos. A correspondência é gananciosa (a correspondência de padrões mais longa em um determinado ponto vence). A substituição tem permissão para ser a cadeia de caracteres vazia. Esse filtro de caractere é implementado usando o Apache Lucene. |
MergeSkill |
Uma habilidade para mesclar duas ou mais cadeias de caracteres em uma única cadeia de caracteres unificada, com um delimitador opcional definido pelo usuário separando cada parte do componente. |
MicrosoftLanguageStemmingTokenizer |
Divide o texto usando regras específicas do idioma e reduz as palavras aos formulários base. |
MicrosoftLanguageTokenizer |
Divide o texto usando regras específicas do idioma. |
NGramTokenFilter |
Gera n-gramas dos tamanhos determinados. Esse filtro de token é implementado usando o Apache Lucene. |
NGramTokenizer |
Tokeniza a entrada em n-gramas dos tamanhos fornecidos. Esse tokenizador é implementado usando o Apache Lucene. |
OcrSkill |
Uma habilidade que extrai texto de arquivos de imagem. |
OutputFieldMappingEntry |
Mapeamento de campo de saída para uma habilidade. |
PIIDetectionSkill |
Usando a API de Análise de Texto, extrai informações pessoais de um texto de entrada e oferece a opção de mascara-la. |
PathHierarchyTokenizer |
Tokenizer para hierarquias semelhantes a caminho. Esse tokenizador é implementado usando o Apache Lucene. |
PatternAnalyzer |
Separa o texto com flexibilidade em termos por meio de um padrão de expressão regular. Esse analisador é implementado usando o Apache Lucene. |
PatternCaptureTokenFilter |
Usa regexes Java para emitir vários tokens – um para cada grupo de captura em um ou mais padrões. Esse filtro de token é implementado usando o Apache Lucene. |
PatternReplaceCharFilter |
Um filtro de caractere que substitui caracteres na cadeia de caracteres de entrada. Ele usa uma expressão regular para identificar sequências de caracteres para preservar e um padrão de substituição para identificar caracteres a serem substituídos. Por exemplo, considerando o texto de entrada "aa bb aa bb", padrão "(aa)\s+(bb)" e substituição "$1#$2", o resultado seria "aa#bb aa#bb". Esse filtro de caractere é implementado usando o Apache Lucene. |
PatternReplaceTokenFilter |
Um filtro de caractere que substitui caracteres na cadeia de caracteres de entrada. Ele usa uma expressão regular para identificar sequências de caracteres para preservar e um padrão de substituição para identificar caracteres a serem substituídos. Por exemplo, considerando o texto de entrada "aa bb aa bb", padrão "(aa)\s+(bb)" e substituição "$1#$2", o resultado seria "aa#bb aa#bb". Esse filtro de token é implementado usando o Apache Lucene. |
PatternTokenizer |
Tokenizer que usa a correspondência de padrões regex para construir tokens distintos. Esse tokenizador é implementado usando o Apache Lucene. |
PhoneticTokenFilter |
Crie tokens para correspondências fonéticas. Esse filtro de token é implementado usando o Apache Lucene. |
QueryAnswerResult |
Uma resposta é uma passagem de texto extraída do conteúdo dos documentos mais relevantes que corresponderam à consulta. As respostas são extraídas dos principais resultados da pesquisa. Os candidatos de resposta são pontuados e as principais respostas são selecionadas. |
QueryCaptionResult |
As legendas são as passagens mais representativas do documento relativamente para a consulta de pesquisa. Eles geralmente são usados como resumo do documento. As legendas são retornadas apenas para consultas do tipo |
ResourceCounter |
Representa o uso e a cota de um recurso. |
ScalarQuantizationCompression |
Contém opções de configuração específicas para o método de compactação de quantização escalar usado durante a indexação e a consulta. |
ScalarQuantizationParameters |
Contém os parâmetros específicos para a Quantização Escalar. |
ScoringProfile |
Define parâmetros para um índice de pesquisa que influenciam a pontuação em consultas de pesquisa. |
SearchClientOptions |
Opções de cliente usadas para configurar solicitações de API de Pesquisa Cognitiva. |
SearchDocumentsPageResult |
Resposta que contém os resultados da página de pesquisa de um índice. |
SearchDocumentsResult |
Resposta que contém os resultados da pesquisa de um índice. |
SearchDocumentsResultBase |
Resposta que contém os resultados da pesquisa de um índice. |
SearchIndex |
Representa uma definição de índice de pesquisa, que descreve os campos e o comportamento de pesquisa de um índice. |
SearchIndexClientOptions |
Opções de cliente usadas para configurar solicitações de API de Pesquisa Cognitiva. |
SearchIndexStatistics |
Estatísticas de um determinado índice. As estatísticas são coletadas periodicamente e não são garantidas como sempre up-to-date. |
SearchIndexer |
Representa um indexador. |
SearchIndexerClientOptions |
Opções de cliente usadas para configurar solicitações de API de Pesquisa Cognitiva. |
SearchIndexerDataContainer |
Representa informações sobre a entidade (como a tabela SQL do Azure ou a coleção cosmosDB) que serão indexadas. |
SearchIndexerDataNoneIdentity |
Limpa a propriedade de identidade de uma fonte de dados. |
SearchIndexerDataSourceConnection |
Representa uma definição de fonte de dados, que pode ser usada para configurar um indexador. |
SearchIndexerDataUserAssignedIdentity |
Especifica a identidade de uma fonte de dados a ser usada. |
SearchIndexerError |
Representa um erro de indexação no nível do item ou do documento. |
SearchIndexerIndexProjection |
Definição de projeções adicionais para índices de pesquisa secundários. |
SearchIndexerIndexProjectionParameters |
Um dicionário de propriedades de configuração específicas da projeção de índice. Cada nome é o nome de uma propriedade específica. Cada valor deve ser de um tipo primitivo. |
SearchIndexerIndexProjectionSelector |
Descrição de quais dados armazenar no índice de pesquisa designado. |
SearchIndexerKnowledgeStore |
Definição de projeções adicionais para blob, tabela ou arquivos do Azure de dados enriquecidos. |
SearchIndexerKnowledgeStoreBlobProjectionSelector |
Classe abstrata para compartilhar propriedades entre seletores concretos. |
SearchIndexerKnowledgeStoreFileProjectionSelector |
Definição de projeção para quais dados armazenar nos Arquivos do Azure. |
SearchIndexerKnowledgeStoreObjectProjectionSelector |
Definição de projeção para quais dados armazenar no Blob do Azure. |
SearchIndexerKnowledgeStoreParameters |
Um dicionário de propriedades de configuração específicas do repositório de conhecimento. Cada nome é o nome de uma propriedade específica. Cada valor deve ser de um tipo primitivo. |
SearchIndexerKnowledgeStoreProjection |
Objeto de contêiner para vários seletores de projeção. |
SearchIndexerKnowledgeStoreProjectionSelector |
Classe abstrata para compartilhar propriedades entre seletores concretos. |
SearchIndexerKnowledgeStoreTableProjectionSelector |
Descrição de quais dados armazenar nas Tabelas do Azure. |
SearchIndexerLimits | |
SearchIndexerSkillset |
Uma lista de habilidades. |
SearchIndexerStatus |
Representa o status atual e o histórico de execução de um indexador. |
SearchIndexerWarning |
Representa um aviso no nível do item. |
SearchIndexingBufferedSenderOptions |
Opções para SearchIndexingBufferedSender. |
SearchResourceEncryptionKey |
Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso no Azure Cognitive Search, como índices e mapas de sinônimos. |
SearchServiceStatistics |
Resposta de uma solicitação obter estatísticas de serviço. Se tiver êxito, ele inclui contadores e limites de nível de serviço. |
SearchSuggester |
Define como a API de Sugestão deve se aplicar a um grupo de campos no índice. |
SemanticConfiguration |
Define uma configuração específica a ser usada no contexto de funcionalidades semânticas. |
SemanticField |
Um campo usado como parte da configuração semântica. |
SemanticPrioritizedFields |
Descreve os campos de título, conteúdo e palavras-chave a serem usados para classificação semântica, legendas, realces e respostas. |
SemanticSearch |
Define parâmetros para um índice de pesquisa que influenciam as funcionalidades semânticas. |
SemanticSearchOptions |
Define opções para consultas de pesquisa semântica |
SentimentSkill |
Análise de sentimento positivo-negativo da análise de texto, pontuada como um valor de ponto flutuante em um intervalo de zero a 1. |
SentimentSkillV3 |
Usando a API de Análise de Texto, avalia o texto não estruturado e, para cada registro, fornece rótulos de sentimento (como "negativo", "neutro" e "positivo") com base na pontuação de confiança mais alta encontrada pelo serviço em uma frase e no nível do documento. |
ServiceCounters |
Representa cotas e contadores de recursos no nível do serviço. |
ServiceLimits |
Representa vários limites de nível de serviço. |
ShaperSkill |
Uma habilidade para remodelar as saídas. Ele cria um tipo complexo para dar suporte a campos compostos (também conhecidos como campos de várias partes). |
ShingleTokenFilter |
Cria combinações de tokens como um único token. Esse filtro de token é implementado usando o Apache Lucene. |
Similarity |
Tipo base para algoritmos de similaridade. Algoritmos de similaridade são usados para calcular pontuações que vinculam consultas a documentos. Quanto maior a pontuação, mais relevante é o documento para essa consulta específica. Essas pontuações são usadas para classificar os resultados da pesquisa. |
SimpleField |
Representa um campo em uma definição de índice, que descreve o nome, o tipo de dados e o comportamento de pesquisa de um campo. |
SnowballTokenFilter |
Um filtro que resulta em palavras usando um lematizador gerado por Bola de Neve. Esse filtro de token é implementado usando o Apache Lucene. |
SoftDeleteColumnDeletionDetectionPolicy |
Define uma política de detecção de exclusão de dados que implementa uma estratégia de exclusão reversível. Ele determina se um item deve ser excluído com base no valor de uma coluna designada como "exclusão reversível". |
SplitSkill |
Uma habilidade para dividir uma cadeia de caracteres em partes de texto. |
SqlIntegratedChangeTrackingPolicy |
Define uma política de detecção de alteração de dados que captura alterações usando o recurso controle de alterações integrado do Banco de Dados SQL do Azure. |
StemmerOverrideTokenFilter |
Fornece a capacidade de substituir outros filtros com base em dicionário personalizado. Todos os termos de lematização de dicionário serão marcados como palavras-chave para que não sejam decorrentes de lematizadores na cadeia. Deve ser colocado antes de qualquer filtro de contenção. Esse filtro de token é implementado usando o Apache Lucene. |
StemmerTokenFilter |
Filtro de lematização específico da linguagem. Esse filtro de token é implementado usando o Apache Lucene. |
StopAnalyzer |
Divide o texto em letras não letras; Aplica os filtros de token de letras minúsculas e palavras irrelevantes. Esse analisador é implementado usando o Apache Lucene. |
StopwordsTokenFilter |
Remove palavras irrelevantes de um fluxo de token. Esse filtro de token é implementado usando o Apache Lucene. |
SuggestDocumentsResult |
Resposta que contém os resultados da consulta de sugestão de um índice. |
SuggestRequest |
Parâmetros para filtragem, classificação, correspondência difusa e outros comportamentos de consulta de sugestões. |
SynonymMap |
Representa uma definição de mapa de sinônimos. |
SynonymTokenFilter |
Corresponde a sinônimos de uma ou várias palavras em um fluxo de token. Esse filtro de token é implementado usando o Apache Lucene. |
TagScoringFunction |
Define uma função que aumenta as pontuações de documentos com valores de cadeia de caracteres correspondentes a uma determinada lista de marcas. |
TagScoringParameters |
Fornece valores de parâmetro para uma função de pontuação de marca. |
TextTranslationSkill |
Uma habilidade para traduzir texto de um idioma para outro. |
TextWeights |
Define os pesos nos campos de índice para os quais as correspondências devem aumentar a pontuação em consultas de pesquisa. |
TruncateTokenFilter |
Trunca os termos para um comprimento específico. Esse filtro de token é implementado usando o Apache Lucene. |
UaxUrlEmailTokenizer |
Tokeniza urls e emails como um token. Esse tokenizador é implementado usando o Apache Lucene. |
UniqueTokenFilter |
Filtra tokens com o mesmo texto do token anterior. Esse filtro de token é implementado usando o Apache Lucene. |
VectorSearch |
Contém opções de configuração relacionadas à pesquisa de vetor. |
VectorSearchOptions |
Define opções para consultas de pesquisa de vetor |
VectorSearchProfile |
Define uma combinação de configurações a serem usadas com a pesquisa de vetor. |
VectorizableTextQuery |
Os parâmetros de consulta a serem usados para pesquisa de vetor quando um valor de texto que precisa ser vetorizado é fornecido. |
VectorizedQuery |
Os parâmetros de consulta a serem usados para pesquisa de vetor quando um valor de vetor bruto é fornecido. |
WebApiParameters |
Especifica as propriedades para se conectar a um vetor definido pelo usuário. |
WebApiSkill |
Uma habilidade que pode chamar um ponto de extremidade de API Web, permitindo que você estenda um conjunto de habilidades fazendo com que ele chame seu código personalizado. |
WebApiVectorizer |
Especifica um vetor definido pelo usuário para gerar a inserção de vetor de uma cadeia de caracteres de consulta. A integração de um vetorizador externo é obtida usando a interface de API Web personalizada de um conjunto de habilidades. |
WordDelimiterTokenFilter |
Divide palavras em sub palavras e executa transformações opcionais em grupos de sub palavras. Esse filtro de token é implementado usando o Apache Lucene. |
Aliases de tipo
AnalyzeTextOptions |
Opções para analisar a operação de texto. |
AutocompleteMode |
Define valores para AutocompleteMode. |
AutocompleteOptions |
Opções para recuperar o texto de conclusão de um searchText parcial. |
AzureOpenAIModelName |
Define valores para AzureOpenAIModelName. Valores conhecidos compatíveis com o serviço
text-embedding-ada-002 |
BlobIndexerDataToExtract | |
BlobIndexerImageAction | |
BlobIndexerPDFTextRotationAlgorithm | |
BlobIndexerParsingMode | |
CharFilter |
Contém os casos possíveis para CharFilter. |
CharFilterName |
Define valores para CharFilterName. Valores conhecidos compatíveis com o serviçohtml_strip: um filtro de caractere que tenta remover constructos HTML. Consulte https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html |
CjkBigramTokenFilterScripts |
Define valores para CjkBigramTokenFilterScripts. |
CognitiveServicesAccount |
Contém os casos possíveis para CognitiveServicesAccount. |
ComplexDataType |
Define valores para ComplexDataType. Os valores possíveis incluem: 'Edm.ComplexType', 'Collection(Edm.ComplexType)' |
CountDocumentsOptions |
Opções para executar a operação de contagem no índice. |
CreateDataSourceConnectionOptions |
Opções para criar operação de fonte de dados. |
CreateIndexOptions |
Opções para criar operação de índice. |
CreateIndexerOptions |
Opções para criar operação de indexador. |
CreateSkillsetOptions |
Opções para criar uma operação de conjunto de habilidades. |
CreateSynonymMapOptions |
Opções para criar operação de synonymmap. |
CustomEntityLookupSkillLanguage | |
DataChangeDetectionPolicy |
Contém os casos possíveis para DataChangeDetectionPolicy. |
DataDeletionDetectionPolicy |
Contém os casos possíveis para DataDeletionDetectionPolicy. |
DeleteDocumentsOptions |
Opções para a operação de exclusão de documentos. |
EdgeNGramTokenFilterSide |
Define valores para EdgeNGramTokenFilterSide. |
EntityCategory | |
EntityRecognitionSkillLanguage | |
ExcludedODataTypes | |
ExhaustiveKnnAlgorithmConfiguration |
Contém opções de configuração específicas para o algoritmo KNN exaustivo usado durante a consulta, que executará a pesquisa de força bruta em todo o índice de vetor. |
ExtractDocumentKey | |
GetDataSourceConnectionOptions |
Opções para obter a operação de fonte de dados. |
GetIndexOptions |
Opções para obter a operação de índice. |
GetIndexStatisticsOptions |
Opções para obter a operação de estatísticas de índice. |
GetIndexerOptions |
Opções para obter a operação do indexador. |
GetIndexerStatusOptions |
Opções para obter a operação de status do indexador. |
GetServiceStatisticsOptions |
Opções para obter a operação de estatísticas de serviço. |
GetSkillSetOptions |
Opções para obter a operação do conjunto de habilidades. |
GetSynonymMapsOptions |
Opções para obter a operação de sinônimos. |
HnswAlgorithmConfiguration |
Contém opções de configuração específicas para o algoritmo de vizinho mais próximo aproximado do hnsw usado durante o tempo de indexação. |
ImageAnalysisSkillLanguage | |
ImageDetail | |
IndexActionType |
Define valores para IndexActionType. |
IndexDocumentsAction |
Representa uma ação de índice que opera em um documento. |
IndexIterator |
Um iterador para listar os índices que existem no serviço de Pesquisa. Fará solicitações conforme necessário durante a iteração. Use .byPage() para fazer uma solicitação ao servidor por iteração. |
IndexNameIterator |
Um iterador para listar os índices que existem no serviço de Pesquisa. Fará solicitações conforme necessário durante a iteração. Use .byPage() para fazer uma solicitação ao servidor por iteração. |
IndexProjectionMode |
Define valores para IndexProjectionMode. Valores conhecidos compatíveis com o serviço
skipIndexingParentDocuments: o documento de origem será ignorado da gravação no índice de destino do indexador. |
IndexerExecutionEnvironment | |
IndexerExecutionStatus |
Define valores para IndexerExecutionStatus. |
IndexerStatus |
Define valores para IndexerStatus. |
KeyPhraseExtractionSkillLanguage | |
LexicalAnalyzer |
Contém os casos possíveis para o Analisador. |
LexicalAnalyzerName |
Define valores para LexicalAnalyzerName. Valores conhecidos compatíveis com o serviço
ar.microsoft: Analisador da Microsoft para árabe. |
LexicalTokenizer |
Contém os casos possíveis para o Tokenizer. |
LexicalTokenizerName |
Define valores para LexicalTokenizerName. Valores conhecidos compatíveis com o serviço
clássico: tokenizador baseado em gramática adequado para processar a maioria dos documentos de idioma europeu. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html |
ListDataSourceConnectionsOptions |
Opções para uma operação de fontes de dados de lista. |
ListIndexersOptions |
Opções para uma operação de indexadores de lista. |
ListIndexesOptions |
Opções para uma operação de índices de lista. |
ListSkillsetsOptions |
Opções para uma operação de conjuntos de habilidades de lista. |
ListSynonymMapsOptions |
Opções para uma operação synonymMaps de lista. |
MergeDocumentsOptions |
Opções para a operação de mesclagem de documentos. |
MergeOrUploadDocumentsOptions |
Opções para a operação de mesclagem ou upload de documentos. |
MicrosoftStemmingTokenizerLanguage |
Define valores para MicrosoftStemmingTokenizerLanguage. |
MicrosoftTokenizerLanguage |
Define valores para MicrosoftTokenizerLanguage. |
NarrowedModel |
Restringe o tipo de modelo para incluir apenas os Campos selecionados |
OcrLineEnding |
Define valores para OcrLineEnding. Valores conhecidos compatíveis com o serviço
espaço: as linhas são separadas por um único caractere de espaço. |
OcrSkillLanguage | |
PIIDetectionSkillMaskingMode | |
PhoneticEncoder |
Define valores para PhoneticEncoder. |
QueryAnswer |
Um valor que especifica se as respostas devem ser retornadas como parte da resposta de pesquisa.
Esse parâmetro só será válido se o tipo de consulta for 'semântico'. Se definido como |
QueryCaption |
Um valor que especifica se as legendas devem ser retornadas como parte da resposta de pesquisa. Esse parâmetro só será válido se o tipo de consulta for 'semântico'. Se definida, a consulta retornará legendas extraídas das principais passagens nos documentos mais bem classificados. Quando Legendas são 'extrativas', o realce é habilitado por padrão. O padrão é 'none'. |
QueryType |
Define valores para QueryType. |
RegexFlags | |
ResetIndexerOptions |
Opções para redefinir a operação do indexador. |
RunIndexerOptions |
Opções para executar a operação do indexador. |
ScoringFunction |
Contém os casos possíveis para ScoreFunction. |
ScoringFunctionAggregation |
Define valores para ScoreFunctionAggregation. |
ScoringFunctionInterpolation |
Define valores para ScoreFunctionInterpolation. |
ScoringStatistics |
Define valores para ScoreStatistics. |
SearchField |
Representa um campo em uma definição de índice, que descreve o nome, o tipo de dados e o comportamento de pesquisa de um campo. |
SearchFieldArray |
Se |
SearchFieldDataType |
Define valores para SearchFieldDataType. Valores conhecidos compatíveis com o serviço:Edm.String: indica que um campo contém uma cadeia de caracteres. Edm.Int32: indica que um campo contém um inteiro com sinal de 32 bits. Edm.Int64: indica que um campo contém um inteiro com sinal de 64 bits. Edm.Double: indica que um campo contém um número de ponto flutuante de precisão dupla IEEE. Edm.Boolean: indica que um campo contém um valor booliano (verdadeiro ou falso). Edm.DateTimeOffset: indica que um campo contém um valor de data/hora, incluindo informações de fuso horário. Edm.GeographyPoint: indica que um campo contém uma localização geográfica em termos de longitude e latitude. Edm.ComplexType: indica que um campo contém um ou mais objetos complexos que, por sua vez, têm sub-campos de outros tipos. Edm.Single: indica que um campo contém um número de ponto flutuante de precisão única. Isso só é válido quando usado como parte de um tipo de coleção, ou seja, Collection(Edm.Single). Edm.Half: indica que um campo contém um número de ponto flutuante de meia precisão. Isso só é válido quando usado como parte de um tipo de coleção, ou seja, Collection(Edm.Half). Edm.Int16: indica que um campo contém um inteiro com sinal de 16 bits. Isso só é válido quando usado como parte de um tipo de coleção, ou seja, Collection(Edm.Int16). Edm.SByte: indica que um campo contém um inteiro com sinal de 8 bits. Isso só é válido quando usado como parte de um tipo de coleção, ou seja, Collection(Edm.SByte). Edm.Byte: indica que um campo contém um inteiro sem sinal de 8 bits. Isso só é válido quando usado como parte de um tipo de coleção, ou seja, Collection(Edm.Byte). |
SearchIndexerDataIdentity |
Contém os casos possíveis para SearchIndexerDataIdentity. |
SearchIndexerDataSourceType | |
SearchIndexerSkill |
Contém os casos possíveis para Skill. |
SearchIndexingBufferedSenderDeleteDocumentsOptions |
Opções para SearchIndexingBufferedSenderDeleteDocuments. |
SearchIndexingBufferedSenderFlushDocumentsOptions |
Opções para SearchIndexingBufferedSenderFlushDocuments. |
SearchIndexingBufferedSenderMergeDocumentsOptions |
Opções para SearchIndexingBufferedSenderMergeDocuments. |
SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions |
Opções para SearchIndexingBufferedSenderMergeOrUploadDocuments. |
SearchIndexingBufferedSenderUploadDocumentsOptions |
Opções para SearchIndexingBufferedSenderUploadDocuments. |
SearchIterator |
Um iterador para resultados de pesquisa de uma consulta paticular. Fará solicitações conforme necessário durante a iteração. Use .byPage() para fazer uma solicitação ao servidor por iteração. |
SearchMode |
Define valores para SearchMode. |
SearchOptions |
Opções para confirmar uma solicitação de pesquisa completa. |
SearchPick |
Escolha profundamente os campos de T usando caminhos de $select OData de Pesquisa Cognitiva válidos. |
SearchRequestOptions |
Parâmetros para filtragem, classificação, faceta, paginação e outros comportamentos de consulta de pesquisa. |
SearchRequestQueryTypeOptions | |
SearchResult |
Contém um documento encontrado por uma consulta de pesquisa, além de metadados associados. |
SelectArray |
Se |
SelectFields |
Produz uma união de caminhos de $select OData de Pesquisa Cognitiva válidos para T usando uma passagem pós-ordem da árvore de campo com raiz em T. |
SemanticErrorMode | |
SemanticErrorReason | |
SemanticSearchResultsType | |
SentimentSkillLanguage | |
SimilarityAlgorithm |
Contém os casos possíveis para Similaridade. |
SnowballTokenFilterLanguage |
Define valores para o Bola de NeveTokenFilterLanguage. |
SplitSkillLanguage | |
StemmerTokenFilterLanguage |
Define valores para StemmerTokenFilterLanguage. |
StopwordsList |
Define valores para StopwordsList. |
SuggestNarrowedModel | |
SuggestOptions |
Opções para recuperar sugestões com base no searchText. |
SuggestResult |
Um resultado que contém um documento encontrado por uma consulta de sugestão, além de metadados associados. |
TextSplitMode | |
TextTranslationSkillLanguage | |
TokenCharacterKind |
Define valores para TokenCharacterKind. |
TokenFilter |
Contém os casos possíveis para TokenFilter. |
TokenFilterName |
Define valores para TokenFilterName. Valores conhecidos compatíveis com o serviço
arabic_normalization: um filtro de token que aplica o normalizador árabe para normalizar a orthografia. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html |
UnionToIntersection | |
UploadDocumentsOptions |
Opções para a operação de upload de documentos. |
VectorEncodingFormat |
Define valores para VectorEncodingFormat. Valores conhecidos compatíveis com o serviçopackedBit: formato de codificação que representa bits empacotados em um tipo de dados mais amplo. |
VectorFilterMode | |
VectorQuery |
Os parâmetros de consulta para consultas de pesquisa vetor e híbrida. |
VectorQueryKind | |
VectorSearchAlgorithmConfiguration |
Contém opções de configuração específicas para o algoritmo usado durante a indexação e/ou consulta. |
VectorSearchAlgorithmKind | |
VectorSearchAlgorithmMetric | |
VectorSearchCompression |
Contém opções de configuração específicas para o método de compactação usado durante a indexação ou consulta. |
VectorSearchCompressionKind |
Define valores para VectorSearchCompressionKind. Valores conhecidos compatíveis com o serviço
scalarQuantization: Quantization Escalar, um tipo de método de compactação. Na quantização escalar, os valores de vetores originais são compactados para um tipo mais estreito discretizando e representando cada componente de um vetor usando um conjunto reduzido de valores quantizados, reduzindo assim o tamanho geral dos dados. |
VectorSearchCompressionTarget |
Define valores para VectorSearchCompressionTarget. Valores conhecidos compatíveis com o serviçoint8 |
VectorSearchVectorizer |
Contém opções de configuração sobre como vetorizar consultas de vetor de texto. |
VectorSearchVectorizerKind |
Define valores para VectorSearchVectorizerKind. Valores conhecidos compatíveis com o serviço
azureOpenAI: gerar inserções usando um recurso do Azure OpenAI no momento da consulta. |
VisualFeature |
Enumerações
KnownAnalyzerNames |
Define valores para AnalyzerName. Consulte https://docs.microsoft.com/rest/api/searchservice/Language-support |
KnownAzureOpenAIModelName |
Valores conhecidos de AzureOpenAIModelName que o serviço aceita. |
KnownBlobIndexerDataToExtract |
Valores conhecidos de BlobIndexerDataToExtract que o serviço aceita. |
KnownBlobIndexerImageAction |
Valores conhecidos de BlobIndexerImageAction que o serviço aceita. |
KnownBlobIndexerPDFTextRotationAlgorithm |
Valores conhecidos de BlobIndexerPDFTextRotationAlgorithm que o serviço aceita. |
KnownBlobIndexerParsingMode |
Valores conhecidos de BlobIndexerParsingMode que o serviço aceita. |
KnownCharFilterNames |
Valores conhecidos de CharFilterName que o serviço aceita. |
KnownCustomEntityLookupSkillLanguage |
Valores conhecidos de CustomEntityLookupSkillLanguage que o serviço aceita. |
KnownEntityCategory |
Valores conhecidos de EntityCategory que o serviço aceita. |
KnownEntityRecognitionSkillLanguage |
Valores conhecidos de EntityRecognitionSkillLanguage que o serviço aceita. |
KnownImageAnalysisSkillLanguage |
Valores conhecidos de ImageAnalysisSkillLanguage que o serviço aceita. |
KnownImageDetail |
Valores conhecidos de ImageDetail que o serviço aceita. |
KnownIndexProjectionMode |
Valores conhecidos de IndexProjectionMode que o serviço aceita. |
KnownIndexerExecutionEnvironment |
Valores conhecidos de IndexerExecutionEnvironment que o serviço aceita. |
KnownKeyPhraseExtractionSkillLanguage |
Valores conhecidos de KeyPhraseExtractionSkillLanguage que o serviço aceita. |
KnownOcrLineEnding |
Valores conhecidos de OcrLineEnding que o serviço aceita. |
KnownOcrSkillLanguage |
Valores conhecidos de OcrSkillLanguage que o serviço aceita. |
KnownPIIDetectionSkillMaskingMode |
Valores conhecidos de PIIDetectionSkillMaskingMode que o serviço aceita. |
KnownRegexFlags |
Valores conhecidos de RegexFlags que o serviço aceita. |
KnownSearchAudience |
Valores conhecidos para o Público de Pesquisa |
KnownSearchFieldDataType |
Valores conhecidos de SearchFieldDataType que o serviço aceita. |
KnownSearchIndexerDataSourceType |
Valores conhecidos de SearchIndexerDataSourceType que o serviço aceita. |
KnownSemanticErrorMode |
Valores conhecidos de SemanticErrorMode que o serviço aceita. |
KnownSemanticErrorReason |
Valores conhecidos de SemanticErrorReason que o serviço aceita. |
KnownSemanticSearchResultsType |
Valores conhecidos de SemanticSearchResultsType que o serviço aceita. |
KnownSentimentSkillLanguage |
Valores conhecidos de SentimentSkillLanguage que o serviço aceita. |
KnownSplitSkillLanguage |
Valores conhecidos de SplitSkillLanguage que o serviço aceita. |
KnownTextSplitMode |
Valores conhecidos de TextSplitMode que o serviço aceita. |
KnownTextTranslationSkillLanguage |
Valores conhecidos de TextTranslationSkillLanguage que o serviço aceita. |
KnownTokenFilterNames |
Valores conhecidos de TokenFilterName que o serviço aceita. |
KnownTokenizerNames |
Valores conhecidos de LexicalTokenizerName que o serviço aceita. |
KnownVectorEncodingFormat |
Valores conhecidos de VectorEncodingFormat que o serviço aceita. |
KnownVectorFilterMode |
Valores conhecidos de VectorFilterMode que o serviço aceita. |
KnownVectorQueryKind |
Valores conhecidos de VectorQueryKind que o serviço aceita. |
KnownVectorSearchAlgorithmKind |
Valores conhecidos de VectorSearchAlgorithmKind que o serviço aceita. |
KnownVectorSearchAlgorithmMetric |
Valores conhecidos de VectorSearchAlgorithmMetric que o serviço aceita. |
KnownVectorSearchCompressionKind |
Valores conhecidos de VectorSearchCompressionKind que o serviço aceita. |
KnownVectorSearchCompressionTarget |
Valores conhecidos de VectorSearchCompressionTarget que o serviço aceita. |
KnownVectorSearchVectorizerKind |
Valores conhecidos de VectorSearchVectorizerKind que o serviço aceita. |
KnownVisualFeature |
Valores conhecidos de VisualFeature que o serviço aceita. |
Funções
create |
Método auxiliar para criar um objeto SynonymMap. Este é um método somente NodeJS. |
odata(Template |
Escapa de uma expressão de filtro odata para evitar erros com literais de cadeia de caracteres entre aspas. Uso de exemplo:
Para obter mais informações sobre a sintaxe com suporte, consulte: https://docs.microsoft.com/en-us/azure/search/search-query-odata-filter |
Detalhes da função
createSynonymMapFromFile(string, string)
Método auxiliar para criar um objeto SynonymMap. Este é um método somente NodeJS.
function createSynonymMapFromFile(name: string, filePath: string): Promise<SynonymMap>
Parâmetros
- name
-
string
Nome do SynonymMap.
- filePath
-
string
Caminho do arquivo que contém os sinônimos (semperados por novas linhas)
Retornos
Promise<SynonymMap>
Objeto SynonymMap
odata(TemplateStringsArray, unknown[])
Escapa de uma expressão de filtro odata para evitar erros com literais de cadeia de caracteres entre aspas. Uso de exemplo:
const baseRateMax = 200;
const ratingMin = 4;
const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;
Para obter mais informações sobre a sintaxe com suporte, consulte: https://docs.microsoft.com/en-us/azure/search/search-query-odata-filter
function odata(strings: TemplateStringsArray, values: unknown[]): string
Parâmetros
- strings
-
TemplateStringsArray
Matriz de cadeias de caracteres para a expressão
- values
-
unknown[]
Matriz de valores para a expressão
Retornos
string