@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. |
| KnowledgeRetrievalClient |
Classe usada para realizar operações contra uma base de conhecimento. |
| 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
| AIServices |
Parâmetros para Serviços de IA. |
| AIServicesAccountIdentity |
A conta multi-região de um recurso de serviço de IA do Azure que está vinculado a um conjunto de habilidades. |
| AIServicesAccountKey |
A chave de conta de um recurso de serviço de IA do Azure que está vinculado a um conjunto de habilidades, para ser usado com o subdomínio do recurso. |
| 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. |
| AzureBlobKnowledgeSource |
Configuração para a fonte de conhecimento do Armazenamento de Blobs do Azure. |
| AzureBlobKnowledgeSourceParameters |
Parâmetros para a fonte de conhecimento do Armazenamento de Blobs do Azure. |
| AzureBlobKnowledgeSourceParams |
Especifica parâmetros de runtime para uma fonte de conhecimento de blob do Azure |
| AzureMachineLearningVectorizer |
Especifica um endpoint de Azure Machine Learning implantado via o Fábrica de IA do Azure Model Catalog para gerar a incorporação vetorial de uma string de consulta. |
| AzureOpenAIEmbeddingSkill |
Permite que você gere uma inserção de vetor para uma determinada entrada de texto usando o recurso Azure OpenAI. |
| AzureOpenAIParameters |
Especifica os parâmetros para se conectar ao recurso do Azure OpenAI. |
| 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'). |
| BaseAzureMachineLearningVectorizerParameters |
Especifica as propriedades comuns entre todos os tipos de autenticação de vetorizador AML. |
| 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. |
| BaseKnowledgeBaseActivityRecord |
Tipo base para registros de atividade. Acompanha detalhes de execução, timing e erros para operações de base de conhecimento. |
| BaseKnowledgeBaseMessageContent |
Especifica o tipo de conteúdo da mensagem. |
| BaseKnowledgeBaseModel |
Especifica os parâmetros de conexão para o modelo a ser usado para o planejamento de consultas. |
| BaseKnowledgeBaseReference |
Tipo de base para referências. |
| BaseKnowledgeRetrievalReasoningEffort |
Tipo base para esforço de raciocínio. |
| BaseKnowledgeSource |
Representa uma definição de fonte de conhecimento. |
| BaseKnowledgeSourceParams |
Tipo base para parâmetros de runtime da fonte de conhecimento. |
| BaseKnowledgeSourceVectorizer |
Especifica o método de vetorização a ser usado para o modelo de imersão de fonte de conhecimento. |
| BaseLexicalAnalyzer |
Tipo base para analisadores. |
| BaseLexicalNormalizer |
Tipo base para normalizadores. |
| 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. |
| BaseSimilarityAlgorithm |
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. |
| 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. |
| ChatCompletionResponseFormat |
Determina como a resposta do modelo de linguagem deve ser serializada. O padrão é 'text'. |
| ChatCompletionResponseFormatJsonSchemaProperties |
Propriedades para o formato de resposta de esquema JSON. |
| ChatCompletionSchema |
Objeto que define o esquema personalizado que o modelo usará para estruturar sua saída. |
| ChatCompletionSkill |
Uma habilidade que chama um modelo de linguagem via o endpoint Chat Completions do Fábrica de IA do Azure. |
| 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. |
| CommonModelParameters |
Parâmetros de modelo de linguagem comum para conclusões de chat. Se omitido, os valores padrão serão usados. |
| CompletedSynchronizationState |
Representa o estado concluído da última sincronização. |
| 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. |
| ContentUnderstandingSkill |
Uma habilidade que aproveita o Azure AI Content Understanding para processar e extrair insights estruturados de documentos, possibilitando conteúdo enriquecido e pesquisável para uma indexação e recuperação aprimorada de documentos. |
| ContentUnderstandingSkillChunkingProperties |
Controla a cardinalidade para dividir o conteúdo. |
| CorsOptions |
Define opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para um índice. |
| CreateKnowledgeBaseOptions | |
| CreateKnowledgeSourceOptions | |
| CreateOrUpdateAliasOptions |
Opções para criar ou atualizar a operação de alias. |
| CreateOrUpdateIndexOptions |
Opções para criar/atualizar a operação de índice. |
| CreateOrUpdateKnowledgeBaseOptions | |
| CreateOrUpdateKnowledgeSourceOptions | |
| 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. |
| CustomLexicalNormalizer |
Permite que você configure a normalização para campos filtrados, classificáveis e facetáveis, que, por padrão, operam com correspondência estrita. Essa é uma configuração definida pelo usuário que consiste em pelo menos um ou mais filtros, que modificam o token armazenado. |
| DefaultCognitiveServicesAccount |
Um objeto vazio que representa o recurso de serviço de IA do Azure padrão para um conjunto de habilidades. |
| DeleteAliasOptions |
Opções para excluir a operação de alias. |
| 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. |
| DeleteKnowledgeBaseOptions | |
| DeleteKnowledgeSourceOptions | |
| 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. |
| DocumentDebugInfo |
Contém informações de depuração que podem ser usadas para explorar ainda mais os resultados da pesquisa. |
| DocumentExtractionSkill |
Uma habilidade que extrai conteúdo de um arquivo dentro do pipeline de enriquecimento. |
| DocumentIntelligenceLayoutSkill |
Uma habilidade que extrai informações de conteúdo e layout (como markdown), por meio dos Serviços de IA do Azure, de arquivos dentro do pipeline de enriquecimento. |
| DocumentIntelligenceLayoutSkillChunkingProperties |
Controla a cardinalidade para dividir o conteúdo. |
| 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. |
| GenerativeQueryRewrites |
Gere termos de consulta alternativos para aumentar o recall de uma solicitação de pesquisa. |
| GetDocumentOptions |
Opções para recuperar um único documento. |
| GetKnowledgeBaseOptions | |
| GetKnowledgeSourceOptions | |
| GetKnowledgeSourceStatusOptions | |
| 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. |
| IndexedOneLakeKnowledgeSource |
Configuração para a fonte de conhecimento do OneLake. |
| IndexedOneLakeKnowledgeSourceParameters |
Parâmetros para a fonte de conhecimento do OneLake. |
| IndexedOneLakeKnowledgeSourceParams |
Especifica parâmetros de runtime para uma fonte de conhecimento indexada do OneLake |
| 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. |
| KeyAuthAzureMachineLearningVectorizerParameters |
Especifica as propriedades para se conectar a um vetorizador AML com uma chave de autenticação. |
| 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. |
| KnowledgeBase | |
| KnowledgeBaseAgenticReasoningActivityRecord |
Representa um registro de atividade de raciocínio agente. |
| KnowledgeBaseAzureBlobReference |
Representa uma referência de documento do Armazenamento de Blobs do Azure. |
| KnowledgeBaseAzureOpenAIModel |
Especifica o recurso OpenAI do Azure usado para fazer o planejamento de consulta. |
| KnowledgeBaseErrorAdditionalInfo |
As informações adicionais do erro de gerenciamento de recursos. |
| KnowledgeBaseErrorDetail |
Os detalhes do erro. |
| KnowledgeBaseIndexedOneLakeReference |
Representa uma referência indexada de documento OneLake. |
| KnowledgeBaseMessage |
O objeto de estilo de mensagem de linguagem natural. |
| KnowledgeBaseMessageImageContent |
Tipo de mensagem de imagem. |
| KnowledgeBaseMessageImageContentImage |
Conteúdo de imagens. |
| KnowledgeBaseMessageTextContent |
Tipo de mensagem de texto. |
| KnowledgeBaseModelWebSummarizationActivityRecord |
Representa um registro de atividade de resumo web de LLM. |
| KnowledgeBaseRetrievalRequest |
O contrato de entrada para a solicitação de recuperação. |
| KnowledgeBaseRetrievalResponse |
O contrato de saída para a resposta de recuperação. |
| KnowledgeBaseSearchIndexReference |
Representa uma referência de documento do Azure Search. |
| KnowledgeBaseWebReference |
Representa uma referência de documento da Web. |
| KnowledgeRetrievalClientOptions |
Opções de cliente usadas para configurar solicitações de API de Pesquisa Cognitiva. |
| KnowledgeRetrievalIntent |
Uma consulta destinada a ser executada sem planejamento de consulta de modelo. |
| KnowledgeRetrievalMinimalReasoningEffort |
Execute a recuperação de conhecimento com o mínimo de esforço de raciocínio. |
| KnowledgeRetrievalSemanticIntent |
Uma intenção de consulta semântica. |
| KnowledgeSourceAzureOpenAIVectorizer |
Especifica o recurso OpenAI do Azure usado para vetorizar uma cadeia de caracteres de consulta. |
| KnowledgeSourceIngestionParameters |
Consolida todas as configurações gerais de ingestão para fontes de conhecimento. |
| KnowledgeSourceReference |
Referência a uma fonte de conhecimento. |
| KnowledgeSourceStatistics |
Informações estatísticas sobre o histórico de sincronização da fonte de conhecimento. |
| KnowledgeSourceStatus |
Representa o status e o histórico de sincronização de uma fonte de conhecimento. |
| KnowledgeSourceSynchronizationError |
Representa um erro de indexação em nível de documento encontrado durante uma execução de sincronização de fonte de conhecimento. |
| 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. |
| ListKnowledgeBasesOptions | |
| ListKnowledgeSourcesOptions | |
| 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. |
| NativeBlobSoftDeleteDeletionDetectionPolicy |
Define uma política de detecção de exclusão de dados utilizando o recurso de exclusão reversível nativo do Armazenamento de Blobs do Azure para detecção de exclusão. |
| NoAuthAzureMachineLearningVectorizerParameters |
Especifica as propriedades para se conectar a um vetor AML sem autenticação. |
| 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. |
| PageSettings |
Opções para o método byPage |
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página. |
| 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 |
| QueryResultDocumentSemanticField |
Descrição dos campos que foram enviados para o processo de enriquecimento semântico, bem como como eles foram usados |
| QueryResultDocumentSubscores |
A divisão de subscores entre os componentes de consulta de texto e vetor da consulta de pesquisa para este documento. Cada consulta de vetor é mostrada como um objeto separado na mesma ordem em que foram recebidos. |
| RescoringOptions |
Contém as opções de recortação. |
| ResourceCounter |
Representa o uso e a cota de um recurso. |
| RetrieveOptions | |
| 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. |
| SearchAlias |
Representa um alias de índice, que descreve um mapeamento do nome do alias para um índice. O nome do alias pode ser usado no lugar do nome do índice para operações com suporte. |
| SearchClientOptions |
Opções do cliente usadas para configurar solicitações de API do AI Search. |
| 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 do cliente usadas para configurar solicitações de API do AI Search. |
| SearchIndexFieldReference |
Referência de campo para um índice de busca. |
| SearchIndexKnowledgeSource |
Fonte de conhecimento direcionada a um índice de pesquisa. |
| SearchIndexKnowledgeSourceParameters |
Parâmetros para a fonte de conhecimento do índice de pesquisa. |
| SearchIndexKnowledgeSourceParams |
Especifica parâmetros de tempo de execução para uma fonte de conhecimento de índice de pesquisa |
| 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 do cliente usadas para configurar solicitações de API do AI Search. |
| 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 |
Representa os limites que podem ser aplicados a um indexador. |
| 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 Pesquisa de IA do Azure , 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. |
| SemanticConfiguration |
Define uma configuração específica a ser usada no contexto de funcionalidades semânticas. |
| SemanticDebugInfo |
Opções de depuração para consultas de pesquisa semântica. |
| 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. |
| 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. |
| SingleVectorFieldResult |
Um único resultado de campo de vetor. Ambos |
| 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. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html |
| StemmerTokenFilter |
Filtro de lematização específico da linguagem. Esse filtro de token é implementado usando o Apache Lucene. Consulte https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters |
| 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. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html |
| 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. |
| Suggester |
Define como a API de Sugestão deve se aplicar a um grupo de campos no índice. |
| SynchronizationState |
Representa o estado atual de uma sincronização contínua que abrange várias execuções do indexador. |
| 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. |
| TextResult |
A pontuação BM25 ou Classic para a parte de texto da consulta. |
| 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. |
| TokenAuthAzureMachineLearningVectorizerParameters |
Especifica as propriedades para se conectar a um vetor AML com uma identidade gerenciada. |
| 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. |
| VectorizableImageBinaryQuery |
Os parâmetros de consulta a serem usados para pesquisa de vetor quando um binário codificado em base 64 de uma imagem que precisa ser vetorizada é fornecido. |
| VectorizableImageUrlQuery |
Os parâmetros de consulta a serem usados para pesquisa de vetor quando uma URL que representa um valor de imagem que precisa ser vetorizado é fornecida. |
| 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. |
| VectorsDebugInfo |
"Contém informações de depuração específicas para busca vetorial e híbrida.") |
| 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. |
| WebKnowledgeSource |
Fonte de conhecimento direcionando resultados da Web. |
| WebKnowledgeSourceDomain |
Configuração para domínio de fonte de conhecimento da Web. |
| WebKnowledgeSourceDomains |
Configuração de permissão/bloqueio de domínio para fonte de conhecimento da Web. |
| WebKnowledgeSourceParameters |
Parâmetros para fonte de conhecimento da Web. |
| WebKnowledgeSourceParams |
Especifica parâmetros de tempo de execução para uma fonte de conhecimento da Web |
| 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
| AIFoundryModelCatalogName |
O nome do modelo de embedding do Fábrica de IA do Azure Catalog que será chamado. Valores conhecidos compatíveis com o serviço
OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32: OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32 |
| AliasIterator |
Um iterador para listar os aliases que existem no serviço de Pesquisa. Isso fará solicitações conforme necessário durante a iteração. Use .byPage() para fazer uma solicitação ao servidor por iteração. |
| AnalyzeTextOptions |
Opções para analisar a operação de texto. |
| AutocompleteMode |
Especifica o modo de preenchimento automático. O padrão é 'oneTerm'. Use 'twoTerms' para obter shingles e 'oneTermWithContext' para usar o contexto atual na produção de termos de preenchimento automático. |
| AutocompleteOptions |
Opções para recuperar o texto de conclusão de um searchText parcial. |
| AzureMachineLearningVectorizerParameters |
Especifica as propriedades para se conectar a um vetorizador AML. |
| AzureOpenAIModelName |
O nome do modelo do Azure Open AI que será chamado. Valores conhecidos compatíveis com o serviço
text-embedding-ada-002: modelo TextEmbeddingAda002. |
| BaseKnowledgeRetrievalIntent |
Alias para KnowledgeRetrievalIntentUnion |
| BlobIndexerDataToExtract | |
| BlobIndexerImageAction | |
| BlobIndexerPDFTextRotationAlgorithm | |
| BlobIndexerParsingMode | |
| CharFilter |
Contém os casos possíveis para CharFilter. |
| CharFilterName |
Define os nomes de todos os filtros de caracteres suportados pelo mecanismo de pesquisa. 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 |
| ChatCompletionExtraParametersBehavior |
Especifica como os 'extraParameters' devem ser tratados pelo Fábrica de IA do Azure. O padrão é 'error'. Valores conhecidos compatíveis com o serviço
passThrough: Passa todos os parâmetros extras diretamente para o modelo. |
| ChatCompletionResponseFormatType |
Especifica como o LLM deve formatar a resposta. Valores conhecidos compatíveis com o serviço
texto: Formato de resposta em texto simples. |
| CjkBigramTokenFilterScripts |
Scripts que podem ser ignorados por CjkBigramTokenFilter. |
| CognitiveServicesAccount |
Contém os casos possíveis para CognitiveServicesAccount. |
| ComplexDataType |
Define valores para ComplexDataType. Os valores possíveis incluem: 'Edm.ComplexType', 'Collection(Edm.ComplexType)' |
| ContentUnderstandingSkillChunkingUnit |
Controla a cardinalidade da unidade da parte. O padrão é 'personagens' Valores conhecidos compatíveis com o serviçocaracteres: Especifica o pedaço por caracteres. |
| ContentUnderstandingSkillExtractionOptions |
Controla a cardinalidade do conteúdo extraído do documento pela habilidade. Valores conhecidos compatíveis com o serviço
images: especifique que o conteúdo da imagem deve ser extraído do documento. |
| ContinuablePage |
Uma interface que descreve uma página de resultados. |
| CountDocumentsOptions |
Opções para executar a operação de contagem no índice. |
| CreateAliasOptions |
Opções para criar operação de alias. |
| 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. |
| DocumentIntelligenceLayoutSkillChunkingUnit |
Controla a cardinalidade da unidade da parte. O padrão é 'personagens' Valores conhecidos compatíveis com o serviçocaracteres: Especifica o pedaço por caracteres. |
| DocumentIntelligenceLayoutSkillExtractionOptions |
Controla a cardinalidade do conteúdo extraído do documento pela habilidade. Valores conhecidos compatíveis com o serviço
images: especifique que o conteúdo da imagem deve ser extraído do documento. |
| DocumentIntelligenceLayoutSkillMarkdownHeaderDepth |
A profundidade dos cabeçalhos na saída de markdown. O padrão é h6. Valores conhecidos compatíveis com o serviço
h1: Cabeçalho nível 1. |
| DocumentIntelligenceLayoutSkillOutputFormat |
Controla a cardinalidade do formato de saída. O padrão é 'markdown'. Valores conhecidos compatíveis com o serviço
text: especifique o formato da saída como texto. |
| DocumentIntelligenceLayoutSkillOutputMode |
Controla a cardinalidade da saída produzida pela habilidade. O padrão é 'oneToMany'. Valores conhecidos compatíveis com o serviçooneToMany: especifique que a saída deve ser analisada como 'oneToMany'. |
| EdgeNGramTokenFilterSide |
Especifica de qual lado da entrada um n-grama deve ser gerado. |
| EntityCategory |
Uma cadeia de caracteres que indica quais categorias de entidade retornar. Valores conhecidos compatíveis com o serviço
localização: Entidades que descrevem uma localização física. |
| EntityRecognitionSkillLanguage |
Os códigos de idioma com suporte para texto de entrada por EntityRecognitionSkill. Valores conhecidos compatíveis com o serviço
ar: árabe |
| 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 | |
| GetAliasOptions |
Opções para obter a operação de alias. |
| 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 |
A operação a ser executada em um documento em um lote de indexação. |
| 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 o comportamento das projeções de índice em relação ao restante do indexador. 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 |
Representa o status de uma execução de indexador individual. |
| IndexerResyncOption |
Opções com vários tipos de dados de permissão para indexar. Valores conhecidos compatíveis com o serviçopermissions: indexador para realimentar dados de permissões pré-selecionados da fonte de dados para o índice. |
| IndexerStatus |
Representa o status geral do indexador. |
| KeyPhraseExtractionSkillLanguage | |
| KnowledgeBaseActivityRecord |
Alias-se para KnowledgeBaseActivityRecordUnion |
| KnowledgeBaseActivityRecordType |
O tipo de registro de atividade. Valores conhecidos compatíveis com o serviço
searchIndex: Atividade de recuperação de busca do índice. |
| KnowledgeBaseIterator |
Um iterador para listar as bases de conhecimento existentes no serviço de Busca. Fará solicitações conforme necessário durante a iteração. Use .byPage() para fazer uma solicitação ao servidor por iteração. |
| KnowledgeBaseMessageContent |
Alias para KnowledgeBaseMessageContentUnion |
| KnowledgeBaseMessageContentType |
O tipo de conteúdo da mensagem. Valores conhecidos compatíveis com o serviço
texto: Conteúdo por mensagem de texto. |
| KnowledgeBaseModel | |
| KnowledgeBaseModelKind |
O modelo de IA a ser usado para planejamento de consulta. Valores conhecidos compatíveis com o serviçoazureOpenAI: Use Azure modelos de IA aberta para planejamento de consultas. |
| KnowledgeBaseReference |
Alias para KnowledgeBaseReferenceUnion |
| KnowledgeBaseReferenceType |
O tipo de referência. Valores conhecidos compatíveis com o serviço
searchIndex: Pesquisa índice de referência de documento. |
| KnowledgeRetrievalIntentType |
O tipo de configuração da base de dados de conhecimento a ser usada. Valores conhecidos compatíveis com o serviçosemântica: Uma intenção semântica de consulta em linguagem natural. |
| KnowledgeRetrievalReasoningEffortKind |
A quantidade de esforço a ser usado durante a recuperação. Valores conhecidos compatíveis com o serviçominimal: Não realiza nenhuma seleção de fonte, planejamento de consultas ou busca iterativa. |
| KnowledgeRetrievalReasoningEffortUnion |
Alias para RecuperaçãoRaciocínioEsforçoUnião |
| KnowledgeSource | |
| KnowledgeSourceContentExtractionMode |
Modo de extração de conteúdo opcional. O padrão é 'mínimo'. Valores conhecidos compatíveis com o serviço
mínimo: extrai apenas metadados essenciais enquanto adia a maior parte do processamento de conteúdo. |
| KnowledgeSourceIterator |
Um iterador para listar as fontes de conhecimento que existem no serviço de Busca. Fará solicitações conforme necessário durante a iteração. Use .byPage() para fazer uma solicitação ao servidor por iteração. |
| KnowledgeSourceKind |
O tipo de fonte de conhecimento. Valores conhecidos compatíveis com o serviço
searchIndex: uma fonte de conhecimento que lê dados de um índice de pesquisa. |
| KnowledgeSourceParams |
Alias para KnowledgeSourceParamsUnion |
| KnowledgeSourceSynchronizationStatus |
O status de sincronização atual da fonte de conhecimento. Valores conhecidos compatíveis com o serviço
criação: A fonte de conhecimento está sendo provisionada. |
| KnowledgeSourceVectorizer | |
| LexicalAnalyzer |
Contém os casos possíveis para o Analisador. |
| LexicalAnalyzerName |
Define os nomes de todos os analisadores de texto suportados pelo mecanismo de pesquisa. Valores conhecidos compatíveis com o serviço
ar.microsoft: Analisador da Microsoft para árabe. |
| LexicalNormalizer |
Contém os casos possíveis para LexicalNormalizer. |
| LexicalNormalizerName |
Define os nomes de todos os normalizadores de texto suportados pelo mecanismo de pesquisa. Valores conhecidos compatíveis com o serviço
asciifolding: 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. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html |
| LexicalTokenizer |
Contém os casos possíveis para o Tokenizer. |
| LexicalTokenizerName |
Define os nomes de todos os tokenizadores suportados pelo mecanismo de pesquisa. 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 |
| ListAliasesOptions |
Opções para a operação de aliases de lista. |
| 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. |
| MarkdownHeaderDepth |
Especifica a profundidade máxima do cabeçalho que será considerada ao agrupar o conteúdo de markdown. O padrão é Valores conhecidos compatíveis com o serviço
h1: indica que cabeçalhos até um nível de h1 serão considerados ao agrupar o conteúdo de markdown. |
| MarkdownParsingSubmode |
Especifica o submodo que determinará se um arquivo markdown será analisado em exatamente um documento de pesquisa ou em vários documentos de pesquisa. O padrão é Valores conhecidos compatíveis com o serviço
oneToMany: indica que cada seção do arquivo markdown (até uma profundidade especificada) será analisada em documentos de pesquisa individuais. Isso pode resultar em um único arquivo markdown produzindo vários documentos de pesquisa. Esse é o sub-modo padrão. |
| 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 |
Lista as linguagens suportadas pelo tokenizador de stemming da Microsoft. |
| MicrosoftTokenizerLanguage |
Lista as linguagens suportadas pelo tokenizador de idiomas da Microsoft. |
| NarrowedModel |
Restringe o tipo de modelo para incluir apenas os Campos selecionados |
| OcrLineEnding |
Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade de OCR. O valor padrão é "espaço". 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 |
Identifica o tipo de codificador fonético a ser usado com um PhoneticTokenFilter. |
| 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'. |
| QueryDebugMode |
Habilita uma ferramenta de depuração que pode ser usada para explorar ainda mais os resultados da pesquisa. Você pode habilitar vários modos de depuração simultaneamente, separando-os com um | caractere, por exemplo: semantic|queryRewrites. Valores conhecidos compatíveis com o serviço
desabilitado: nenhuma informação de depuração de consulta será retornada. |
| QueryRewrites |
Define opções para regravações de consulta. |
| QueryType |
Especifica a sintaxe da consulta de pesquisa. O padrão é "simples". Use 'full' se sua consulta usar a sintaxe de consulta Lucene e 'semântica' se a sintaxe de consulta não for necessária. Valores conhecidos compatíveis com o serviço
simples: Usa a sintaxe de consulta simples para buscas. O texto de pesquisa é interpretado usando uma linguagem de consulta simples que permite símbolos como +, * e "". As consultas são avaliadas em todos os campos pesquisáveis por padrão, a menos que o parâmetro searchFields seja especificado. |
| RankingOrder |
Representa a pontuação a ser usada para a ordem de classificação dos documentos. Valores conhecidos compatíveis com o serviço
BoostedRerankerScore: Define a ordem de classificação como BoostedRerankerScore |
| 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 a função de agregação usada para combinar os resultados de todas as funções de pontuação em um perfil de pontuação. |
| ScoringFunctionInterpolation |
Define a função usada para interpolar o aumento de pontuação em um intervalo de documentos. |
| ScoringStatistics |
Um valor que especifica se queremos calcular estatísticas de pontuação (como frequência de documento) globalmente para pontuação mais consistente ou localmente, para menor latência. O padrão é 'local'. Use 'global' para agregar estatísticas de pontuação globalmente antes de pontuar. O uso de estatísticas de pontuação global pode aumentar a latência das consultas de pesquisa. |
| 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). |
| SearchIndexAlias |
Objeto Alias de pesquisa. |
| 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 |
Especifica se algum ou todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência. |
| 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 de IA 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. |
| SelectFields |
Produz uma união de caminhos de OData de pesquisa de IA válidos $select para T usando uma passagem pós-ordem da árvore de campo enraizada em T. |
| SemanticErrorMode | |
| SemanticErrorReason | |
| SemanticSearchResultsType |
Tipo de resposta parcial que foi retornada para uma solicitação de classificação semântica. Valores conhecidos compatíveis com o serviço
baseResults: Resultados sem qualquer enriquecimento semântico ou reclassificação. |
| SentimentSkillLanguage |
Os códigos de idioma com suporte para texto de entrada por SentimentSkill. Valores conhecidos compatíveis com o serviço
da: dinamarquês |
| Similarity |
Alias para SimilarityAlgorithmUnion |
| SimilarityAlgorithm |
Contém os casos possíveis para Similaridade. |
| SnowballTokenFilterLanguage |
O idioma a ser usado para um filtro de token do Snowball. |
| SplitSkillLanguage | |
| StemmerTokenFilterLanguage |
O idioma a ser usado para um filtro de token de lematizador. |
| StopwordsList |
Identifica uma lista predefinida de palavras irrelevantes específicas do idioma. |
| 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 |
Representa classes de caracteres nas quais um filtro de token pode operar. |
| TokenFilter |
Contém os casos possíveis para TokenFilter. |
| TokenFilterName |
Define os nomes de todos os filtros de token suportados pelo mecanismo de pesquisa. 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 |
O formato de codificação para interpretar o conteúdo do campo vetorial. 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 |
O método de compactação usado para indexação e consulta. 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. |
| VectorSearchCompressionRescoreStorageMethod |
O método de armazenamento para os vetores originais de precisão total usados para operações de repontuação e índice interno. Valores conhecidos compatíveis com o serviço
preserveOriginals: Esta opção preserva os vetores originais de precisão total. Escolha essa opção para obter a máxima flexibilidade e a mais alta qualidade dos resultados da pesquisa compactada. Isso consome mais armazenamento, mas permite a recorção e a sobrecarga. |
| VectorSearchCompressionTarget |
O tipo de dados quantizados de valores vetoriais compactados. Valores conhecidos compatíveis com o serviçoint8: inteiro assinado de 8 bits. |
| VectorSearchVectorizer |
Contém opções de configuração sobre como vetorizar consultas de vetor de texto. |
| VectorSearchVectorizerKind |
O método de vetorização a ser usado durante o tempo de consulta. Valores conhecidos compatíveis com o serviço
azureOpenAI: gerar inserções usando um recurso do Azure OpenAI no momento da consulta. |
| VisualFeature | |
| WebApiSkills | |
Enumerações
| KnownAIFoundryModelCatalogName |
O nome do modelo de embedding do Fábrica de IA do Azure Catalog que será chamado. |
| KnownAnalyzerNames |
Define valores para AnalyzerName. Consulte https://learn.microsoft.com/rest/api/searchservice/Language-support |
| KnownAzureOpenAIModelName |
O nome do modelo do Azure Open AI que será chamado. |
| KnownBlobIndexerDataToExtract |
Especifica os dados a serem extraídos do armazenamento de blobs do Azure e informa ao indexador quais dados extrair do conteúdo da imagem quando "imageAction" é definido como um valor diferente de "none". Isso se aplica ao conteúdo de imagem inserido em um .PDF ou outro aplicativo, ou a arquivos de imagem, como .jpg e .png, em blobs do Azure. |
| KnownBlobIndexerImageAction |
Determina como processar imagens inseridas e arquivos de imagem no armazenamento de blobs do Azure. Definir a configuração "imageAction" como qualquer valor diferente de "none" requer que um conjunto de habilidades também seja anexado a esse indexador. |
| KnownBlobIndexerPDFTextRotationAlgorithm |
Determina o algoritmo para extração de texto de arquivos PDF no armazenamento de blobs do Azure. |
| KnownBlobIndexerParsingMode |
Representa o modo de análise para indexação de uma fonte de dados de blob do Azure. |
| KnownCharFilterNames |
Define valores para CharFilterName. |
| KnownChatCompletionExtraParametersBehavior |
Especifica como os 'extraParameters' devem ser tratados pelo Fábrica de IA do Azure. O padrão é 'error'. |
| KnownChatCompletionResponseFormatType |
Especifica como o LLM deve formatar a resposta. |
| KnownContentUnderstandingSkillChunkingUnit |
Controla a cardinalidade da unidade da parte. O padrão é 'caracteres' |
| KnownContentUnderstandingSkillExtractionOptions |
Controla a cardinalidade do conteúdo extraído do documento pela habilidade. |
| KnownCustomEntityLookupSkillLanguage |
Os códigos de idioma com suporte para texto de entrada por CustomEntityLookupSkill. |
| KnownDocumentIntelligenceLayoutSkillChunkingUnit |
Controla a cardinalidade da unidade da parte. O padrão é 'caracteres' |
| KnownDocumentIntelligenceLayoutSkillExtractionOptions |
Controla a cardinalidade do conteúdo extraído do documento pela habilidade. |
| KnownDocumentIntelligenceLayoutSkillMarkdownHeaderDepth |
A profundidade dos cabeçalhos na saída de markdown. O padrão é h6. |
| KnownDocumentIntelligenceLayoutSkillOutputFormat |
Controla a cardinalidade do formato de saída. O padrão é 'markdown'. |
| KnownDocumentIntelligenceLayoutSkillOutputMode |
Controla a cardinalidade da saída produzida pela habilidade. O padrão é 'oneToMany'. |
| KnownEntityCategory |
Uma cadeia de caracteres que indica quais categorias de entidade retornar. |
| KnownEntityRecognitionSkillLanguage |
Os códigos de idioma com suporte para texto de entrada por EntityRecognitionSkill. |
| KnownImageAnalysisSkillLanguage |
Os códigos de idioma com suporte para entrada por ImageAnalysisSkill. |
| KnownImageDetail |
Uma cadeia de caracteres que indica quais detalhes específicos do domínio devem ser retornados. |
| KnownIndexProjectionMode |
Define o comportamento das projeções de índice em relação ao restante do indexador. |
| KnownIndexerExecutionEnvironment |
Especifica o ambiente no qual o indexador deve ser executado. |
| KnownIndexerResyncOption |
Opções com vários tipos de dados de permissão para indexar. |
| KnownKeyPhraseExtractionSkillLanguage |
Os códigos de idioma com suporte para texto de entrada por KeyPhraseExtractionSkill. |
| KnownKnowledgeBaseModelKind |
O modelo de IA a ser usado para planejamento de consulta. |
| KnownKnowledgeSourceKind |
O tipo de fonte de conhecimento. |
| KnownLexicalAnalyzerName |
Define os nomes de todos os analisadores de texto suportados pelo mecanismo de pesquisa. |
| KnownLexicalNormalizerName |
Define os nomes de todos os normalizadores de texto suportados pelo mecanismo de pesquisa. |
| KnownMarkdownHeaderDepth |
Especifica a profundidade máxima do cabeçalho que será considerada ao agrupar o conteúdo de markdown. O padrão é |
| KnownMarkdownParsingSubmode |
Especifica o submodo que determinará se um arquivo markdown será analisado em exatamente um documento de pesquisa ou em vários documentos de pesquisa. O padrão é |
| KnownOcrLineEnding |
Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade de OCR. O valor padrão é "espaço". |
| KnownOcrSkillLanguage |
Os códigos de idioma suportados para entrada pelo OcrSkill. |
| KnownPIIDetectionSkillMaskingMode |
Uma cadeia de caracteres que indica qual maskingMode usar para mascarar as informações pessoais detectadas no texto de entrada. |
| KnownQueryDebugMode |
Habilita uma ferramenta de depuração que pode ser usada para explorar ainda mais os resultados da pesquisa. Você pode habilitar vários modos de depuração simultaneamente, separando-os com um | caractere, por exemplo: semantic|queryRewrites. |
| KnownRankingOrder |
Representa a pontuação a ser usada para a ordem de classificação dos documentos. |
| KnownRegexFlags |
Define uma flag de expressão regular que pode ser usada no analisador de padrões e no tokenizador de padrão. |
| KnownSearchAudience |
Valores conhecidos para o Público de Pesquisa |
| KnownSearchFieldDataType |
Define o tipo de dados de um campo em um índice de pesquisa. |
| KnownSearchIndexerDataSourceType |
Define o tipo de uma fonte de dados. |
| KnownSemanticErrorMode |
Permite ao usuário escolher se uma chamada semântica deve falhar completamente ou devolver resultados parciais. |
| KnownSemanticErrorReason |
Motivo pelo qual uma resposta parcial foi retornada para uma solicitação de classificação semântica. |
| KnownSemanticSearchResultsType |
Tipo de resposta parcial que foi retornada para uma solicitação de classificação semântica. |
| KnownSentimentSkillLanguage |
Os códigos de idioma com suporte para texto de entrada por SentimentSkill. |
| KnownSplitSkillLanguage |
Os códigos de idioma com suporte para texto de entrada por SplitSkill. |
| KnownTextSplitMode |
Um valor que indica qual modo de divisão executar. |
| KnownTextTranslationSkillLanguage |
Os códigos de idioma com suporte para texto de entrada por TextTranslationSkill. |
| KnownTokenFilterNames |
Define valores para TokenFilterName. |
| KnownTokenizerNames |
Define valores para TokenizerName. |
| KnownVectorEncodingFormat |
O formato de codificação para interpretar o conteúdo do campo vetorial. |
| KnownVectorFilterMode |
Determina se os filtros são aplicados antes ou depois da execução da pesquisa vetorial. |
| KnownVectorQueryKind |
O tipo de consulta vetorial que está sendo executada. |
| KnownVectorSearchAlgorithmKind |
O algoritmo usado para indexação e consulta. |
| KnownVectorSearchAlgorithmMetric |
A métrica de similaridade a ser usada para comparações vetoriais. É recomendável escolher a mesma métrica de similaridade na qual o modelo de inserção foi treinado. |
| KnownVectorSearchCompressionKind |
O método de compactação usado para indexação e consulta. |
| KnownVectorSearchCompressionRescoreStorageMethod |
O método de armazenamento para os vetores originais de precisão total usados para operações de repontuação e índice interno. |
| KnownVectorSearchCompressionTarget |
O tipo de dados quantizados de valores vetoriais compactados. |
| KnownVectorSearchVectorizerKind |
O método de vetorização a ser usado durante o tempo de consulta. |
| KnownVisualFeature |
As cadeias de caracteres que indicam quais tipos de recursos visuais retornar. |
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://learn.microsoft.com/azure/search/search-query-odata-filter |
Variáveis
| DEFAULT_BATCH_SIZE | Tamanho padrão do lote |
| DEFAULT_FLUSH_WINDOW | Intervalo padrão de flush da janela |
| DEFAULT_RETRY_COUNT | Número padrão de vezes para tentar novamente. |
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:
import { odata } from "@azure/search-documents";
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://learn.microsoft.com/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
Detalhes da variável
DEFAULT_BATCH_SIZE
Tamanho padrão do lote
DEFAULT_BATCH_SIZE: number
Tipo
number
DEFAULT_FLUSH_WINDOW
Intervalo padrão de flush da janela
DEFAULT_FLUSH_WINDOW: number
Tipo
number
DEFAULT_RETRY_COUNT
Número padrão de vezes para tentar novamente.
DEFAULT_RETRY_COUNT: number
Tipo
number