Indexes - Create

Cria um novo índice de pesquisa.

POST {endpoint}/indexes?api-version=2026-04-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string (uri)

A URL do ponto de extremidade do serviço de pesquisa.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Accept

Accept

O cabeçalho Aceitar.

x-ms-client-request-id

string (uuid)

Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Corpo da solicitação

Nome Obrigatório Tipo Description
fields True

SearchField[]

Os campos do índice.

name True

string

O nome do índice.

@odata.etag

string

A ETag do índice.

analyzers LexicalAnalyzer[]:

Os analisadores do índice.

charFilters CharFilter[]:

Os filtros de caractere para o índice.

corsOptions

CorsOptions

Opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para o índice.

defaultScoringProfile

string

O nome do perfil de pontuação a ser usado se nenhum for especificado na consulta. Se essa propriedade não estiver definida e nenhum perfil de pontuação for especificado na consulta, a pontuação padrão (tf-idf) será usada.

description

string

A descrição do índice.

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para seus dados quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografar seus dados. Depois de criptografar seus dados, eles sempre permanecerão criptografados. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Seus dados não serão afetados. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.

normalizers LexicalNormalizer[]:

CustomNormalizer[]

Os normalizadores do índice.

scoringProfiles

ScoringProfile[]

Os perfis de pontuação do índice.

semantic

SemanticSearch

Define parâmetros para um índice de pesquisa que influenciam as funcionalidades semânticas.

similarity SimilarityAlgorithm:

O tipo de algoritmo de similaridade a ser usado ao pontuar e classificar os documentos correspondentes a uma consulta de pesquisa. O algoritmo de similaridade só pode ser definido no momento da criação do índice e não pode ser modificado em índices existentes. Se nulo, o algoritmo ClassicSimilarity será usado.

suggesters

SearchSuggester[]

Os sugestores para o índice.

tokenFilters TokenFilter[]:

Os filtros de token para o índice.

tokenizers LexicalTokenizer[]:

Os tokenizadores do índice.

vectorSearch

VectorSearch

Contém opções de configuração relacionadas à pesquisa de vetor.

Respostas

Nome Tipo Description
201 Created

SearchIndex

A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome Description
https://search.azure.com/.default

Exemplos

SearchServiceCreateIndex

Solicitação de exemplo

POST https://exampleservice.search.windows.net/indexes?api-version=2026-04-01


{
  "name": "temp-example-index",
  "description": "description",
  "fields": [
    {
      "name": "id",
      "type": "Edm.String",
      "key": true,
      "sortable": true
    },
    {
      "name": "vector1",
      "type": "Collection(Edm.Single)",
      "retrievable": true,
      "searchable": true,
      "dimensions": 20,
      "vectorSearchProfile": "config1"
    },
    {
      "name": "vector1b",
      "type": "Collection(Edm.Single)",
      "retrievable": true,
      "searchable": true,
      "dimensions": 10,
      "vectorSearchProfile": "config2"
    },
    {
      "name": "vector2",
      "type": "Collection(Edm.Single)",
      "retrievable": true,
      "searchable": true,
      "dimensions": 5,
      "vectorSearchProfile": "config3"
    },
    {
      "name": "vector3",
      "type": "Collection(Edm.Single)",
      "retrievable": true,
      "searchable": true,
      "dimensions": 5,
      "vectorSearchProfile": "config3"
    },
    {
      "name": "vector22",
      "type": "Collection(Edm.Single)",
      "retrievable": true,
      "searchable": true,
      "dimensions": 10,
      "vectorSearchProfile": "config2"
    },
    {
      "name": "vector4",
      "type": "Collection(Edm.Single)",
      "retrievable": true,
      "searchable": true,
      "dimensions": 32,
      "vectorSearchProfile": "config4"
    },
    {
      "name": "name",
      "type": "Edm.String",
      "retrievable": true,
      "searchable": true,
      "filterable": true,
      "sortable": true,
      "facetable": true,
      "analyzer": "en.lucene"
    },
    {
      "name": "description",
      "type": "Edm.String",
      "retrievable": true,
      "searchable": true,
      "filterable": true,
      "sortable": true,
      "facetable": true,
      "analyzer": "standard.lucene"
    },
    {
      "name": "category",
      "type": "Edm.String",
      "retrievable": true,
      "searchable": true,
      "filterable": true,
      "sortable": true,
      "facetable": true,
      "analyzer": "en.lucene"
    },
    {
      "name": "ownerId",
      "type": "Edm.String",
      "retrievable": true,
      "searchable": true,
      "filterable": true,
      "sortable": true,
      "facetable": true,
      "analyzer": "en.lucene"
    },
    {
      "name": "price",
      "type": "Edm.Double",
      "retrievable": true,
      "filterable": true,
      "sortable": true,
      "facetable": true
    }
  ],
  "scoringProfiles": [
    {
      "name": "stringFieldBoost",
      "text": {
        "weights": {
          "name": 3,
          "description": 1,
          "category": 2,
          "ownerId": 1
        }
      },
      "functions": [
        {
          "tag": {
            "tagsParameter": "categoryTag"
          },
          "type": "tag",
          "fieldName": "category",
          "boost": 2
        }
      ]
    }
  ],
  "defaultScoringProfile": "stringFieldBoost",
  "corsOptions": {
    "allowedOrigins": [
      "https://www.example.com/foo"
    ],
    "maxAgeInSeconds": 10
  },
  "suggesters": [
    {
      "name": "sg",
      "searchMode": "analyzingInfixMatching",
      "sourceFields": [
        "category",
        "ownerId"
      ]
    }
  ],
  "analyzers": [
    {
      "tokenizer": "standard_v2",
      "tokenFilters": [
        "common_grams"
      ],
      "charFilters": [
        "html_strip"
      ],
      "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer",
      "name": "tagsAnalyzer"
    }
  ],
  "tokenizers": [
    {
      "maxTokenLength": 100,
      "@odata.type": "#Microsoft.Azure.Search.StandardTokenizerV2",
      "name": "my_tokenizer"
    }
  ],
  "tokenFilters": [
    {
      "preserveOriginal": false,
      "@odata.type": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter",
      "name": "my_tokenFilter"
    }
  ],
  "charFilters": [
    {
      "mappings": [
        ".=>,",
        "_=>-"
      ],
      "@odata.type": "#Microsoft.Azure.Search.MappingCharFilter",
      "name": "my_mapping"
    }
  ],
  "normalizers": [
    {
      "tokenFilters": [
        "my_tokenFilter"
      ],
      "charFilters": [
        "my_mapping"
      ],
      "@odata.type": "#Microsoft.Azure.Search.CustomNormalizer",
      "name": "my_normalizer"
    }
  ],
  "similarity": {
    "k1": 10,
    "b": 0.1,
    "@odata.type": "#Microsoft.Azure.Search.BM25Similarity"
  },
  "semantic": {
    "defaultConfiguration": "testconfig",
    "configurations": [
      {
        "name": "testconfig",
        "prioritizedFields": {
          "titleField": {
            "fieldName": "category"
          },
          "prioritizedContentFields": [
            {
              "fieldName": "description"
            }
          ],
          "prioritizedKeywordsFields": [
            {
              "fieldName": "ownerId"
            }
          ]
        },
        "rankingOrder": "BoostedRerankerScore"
      }
    ]
  },
  "vectorSearch": {
    "profiles": [
      {
        "name": "config1",
        "algorithm": "cosine",
        "vectorizer": "openai",
        "compression": "mySQ8"
      },
      {
        "name": "config2",
        "algorithm": "euclidean",
        "vectorizer": "custom-web-api",
        "compression": "mySQ8"
      },
      {
        "name": "config3",
        "algorithm": "dotProduct",
        "vectorizer": "custom-web-api",
        "compression": "myBQC"
      },
      {
        "name": "config4",
        "algorithm": "dotProduct",
        "vectorizer": "custom-web-api",
        "compression": "myBQWithoutOriginals"
      }
    ],
    "algorithms": [
      {
        "hnswParameters": {
          "metric": "cosine"
        },
        "name": "cosine",
        "kind": "hnsw"
      },
      {
        "hnswParameters": {
          "metric": "euclidean"
        },
        "name": "euclidean",
        "kind": "hnsw"
      },
      {
        "hnswParameters": {
          "metric": "dotProduct"
        },
        "name": "dotProduct",
        "kind": "hnsw"
      }
    ],
    "vectorizers": [
      {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "name": "openai",
        "kind": "azureOpenAI"
      },
      {
        "customWebApiParameters": {
          "uri": "https://my-custom-endpoint.org/",
          "httpHeaders": {
            "header1": "value1",
            "header2": "value2"
          },
          "httpMethod": "POST",
          "timeout": "PT1M",
          "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b",
          "authIdentity": {
            "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
          }
        },
        "name": "custom-web-api",
        "kind": "customWebApi"
      },
      {
        "amlParameters": {
          "uri": "https://my-custom-endpoint.org/",
          "resourceId": "aml resource id",
          "timeout": "PT1M",
          "region": "aml region",
          "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32"
        },
        "name": "aml",
        "kind": "aml"
      },
      {
        "amlParameters": {
          "uri": "https://my-custom-endpoint.org/",
          "resourceId": "aml resource id",
          "timeout": "PT1M",
          "region": "aml region",
          "modelName": "Cohere-embed-v4"
        },
        "name": "aml-cohere",
        "kind": "aml"
      }
    ],
    "compressions": [
      {
        "scalarQuantizationParameters": {
          "quantizedDataType": "int8"
        },
        "name": "mySQ8",
        "kind": "scalarQuantization",
        "rescoringOptions": {
          "enableRescoring": true,
          "defaultOversampling": 10,
          "rescoreStorageMethod": "preserveOriginals"
        },
        "truncationDimension": 2
      },
      {
        "name": "myBQC",
        "kind": "binaryQuantization",
        "rescoringOptions": {
          "enableRescoring": true,
          "defaultOversampling": 10,
          "rescoreStorageMethod": "preserveOriginals"
        },
        "truncationDimension": 2
      },
      {
        "name": "myBQWithoutOriginals",
        "kind": "binaryQuantization",
        "rescoringOptions": {
          "enableRescoring": true,
          "defaultOversampling": 10,
          "rescoreStorageMethod": "discardOriginals"
        },
        "truncationDimension": 2
      }
    ]
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

Resposta de exemplo

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "temp-example-index",
  "description": "description",
  "defaultScoringProfile": "stringFieldBoost",
  "fields": [
    {
      "name": "id",
      "type": "Edm.String",
      "searchable": true,
      "filterable": true,
      "retrievable": true,
      "stored": true,
      "sortable": true,
      "facetable": true,
      "key": true,
      "synonymMaps": []
    },
    {
      "name": "vector1",
      "type": "Collection(Edm.Single)",
      "searchable": true,
      "filterable": false,
      "retrievable": true,
      "stored": true,
      "sortable": false,
      "facetable": false,
      "key": false,
      "dimensions": 20,
      "vectorSearchProfile": "config1",
      "synonymMaps": []
    },
    {
      "name": "vector1b",
      "type": "Collection(Edm.Single)",
      "searchable": true,
      "filterable": false,
      "retrievable": true,
      "stored": true,
      "sortable": false,
      "facetable": false,
      "key": false,
      "dimensions": 10,
      "vectorSearchProfile": "config2",
      "synonymMaps": []
    },
    {
      "name": "vector2",
      "type": "Collection(Edm.Single)",
      "searchable": true,
      "filterable": false,
      "retrievable": true,
      "stored": true,
      "sortable": false,
      "facetable": false,
      "key": false,
      "dimensions": 5,
      "vectorSearchProfile": "config3",
      "synonymMaps": []
    },
    {
      "name": "vector3",
      "type": "Collection(Edm.Single)",
      "searchable": true,
      "filterable": false,
      "retrievable": true,
      "stored": true,
      "sortable": false,
      "facetable": false,
      "key": false,
      "dimensions": 5,
      "vectorSearchProfile": "config3",
      "synonymMaps": []
    },
    {
      "name": "vector22",
      "type": "Collection(Edm.Single)",
      "searchable": true,
      "filterable": false,
      "retrievable": true,
      "stored": true,
      "sortable": false,
      "facetable": false,
      "key": false,
      "dimensions": 10,
      "vectorSearchProfile": "config2",
      "synonymMaps": []
    },
    {
      "name": "vector4",
      "type": "Collection(Edm.Single)",
      "searchable": true,
      "filterable": false,
      "retrievable": true,
      "stored": true,
      "sortable": false,
      "facetable": false,
      "key": false,
      "dimensions": 32,
      "vectorSearchProfile": "config4",
      "synonymMaps": []
    },
    {
      "name": "name",
      "type": "Edm.String",
      "searchable": true,
      "filterable": true,
      "retrievable": true,
      "stored": true,
      "sortable": true,
      "facetable": true,
      "key": false,
      "analyzer": "en.lucene",
      "synonymMaps": []
    },
    {
      "name": "description",
      "type": "Edm.String",
      "searchable": true,
      "filterable": true,
      "retrievable": true,
      "stored": true,
      "sortable": true,
      "facetable": true,
      "key": false,
      "analyzer": "standard.lucene",
      "synonymMaps": []
    },
    {
      "name": "category",
      "type": "Edm.String",
      "searchable": true,
      "filterable": true,
      "retrievable": true,
      "stored": true,
      "sortable": true,
      "facetable": true,
      "key": false,
      "analyzer": "en.lucene",
      "synonymMaps": []
    },
    {
      "name": "ownerId",
      "type": "Edm.String",
      "searchable": true,
      "filterable": true,
      "retrievable": true,
      "stored": true,
      "sortable": true,
      "facetable": true,
      "key": false,
      "analyzer": "en.lucene",
      "synonymMaps": []
    },
    {
      "name": "price",
      "type": "Edm.Double",
      "searchable": false,
      "filterable": true,
      "retrievable": true,
      "stored": true,
      "sortable": true,
      "facetable": true,
      "key": false,
      "synonymMaps": []
    }
  ],
  "scoringProfiles": [
    {
      "name": "stringFieldBoost",
      "functionAggregation": "sum",
      "text": {
        "weights": {
          "name": 3,
          "description": 1,
          "category": 2,
          "ownerId": 1
        }
      },
      "functions": [
        {
          "fieldName": "category",
          "interpolation": "linear",
          "type": "tag",
          "boost": 2,
          "tag": {
            "tagsParameter": "categoryTag"
          }
        }
      ]
    }
  ],
  "corsOptions": {
    "allowedOrigins": [
      "https://www.example.com/foo"
    ],
    "maxAgeInSeconds": 10
  },
  "suggesters": [
    {
      "name": "sg",
      "searchMode": "analyzingInfixMatching",
      "sourceFields": [
        "category",
        "ownerId"
      ]
    }
  ],
  "analyzers": [
    {
      "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer",
      "name": "tagsAnalyzer",
      "tokenizer": "standard_v2",
      "tokenFilters": [
        "common_grams"
      ],
      "charFilters": [
        "html_strip"
      ]
    }
  ],
  "normalizers": [
    {
      "@odata.type": "#Microsoft.Azure.Search.CustomNormalizer",
      "name": "my_normalizer",
      "tokenFilters": [
        "my_tokenFilter"
      ],
      "charFilters": [
        "my_mapping"
      ]
    }
  ],
  "tokenizers": [
    {
      "@odata.type": "#Microsoft.Azure.Search.StandardTokenizerV2",
      "name": "my_tokenizer",
      "maxTokenLength": 100
    }
  ],
  "tokenFilters": [
    {
      "@odata.type": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter",
      "name": "my_tokenFilter",
      "preserveOriginal": false
    }
  ],
  "charFilters": [
    {
      "@odata.type": "#Microsoft.Azure.Search.MappingCharFilter",
      "name": "my_mapping",
      "mappings": [
        ".=>,",
        "_=>-"
      ]
    }
  ],
  "similarity": {
    "@odata.type": "#Microsoft.Azure.Search.BM25Similarity",
    "k1": 10,
    "b": 0.1
  },
  "semantic": {
    "defaultConfiguration": "testconfig",
    "configurations": [
      {
        "name": "testconfig",
        "rankingOrder": "BoostedRerankerScore",
        "prioritizedFields": {
          "titleField": {
            "fieldName": "category"
          },
          "prioritizedContentFields": [
            {
              "fieldName": "description"
            }
          ],
          "prioritizedKeywordsFields": [
            {
              "fieldName": "ownerId"
            }
          ]
        }
      }
    ]
  },
  "vectorSearch": {
    "algorithms": [
      {
        "name": "cosine",
        "kind": "hnsw",
        "hnswParameters": {
          "metric": "cosine",
          "m": 4,
          "efConstruction": 400,
          "efSearch": 500
        }
      },
      {
        "name": "euclidean",
        "kind": "hnsw",
        "hnswParameters": {
          "metric": "euclidean",
          "m": 4,
          "efConstruction": 400,
          "efSearch": 500
        }
      },
      {
        "name": "dotProduct",
        "kind": "hnsw",
        "hnswParameters": {
          "metric": "dotProduct",
          "m": 4,
          "efConstruction": 400,
          "efSearch": 500
        }
      }
    ],
    "profiles": [
      {
        "name": "config1",
        "algorithm": "cosine",
        "vectorizer": "openai",
        "compression": "mySQ8"
      },
      {
        "name": "config2",
        "algorithm": "euclidean",
        "vectorizer": "custom-web-api",
        "compression": "mySQ8"
      },
      {
        "name": "config3",
        "algorithm": "dotProduct",
        "vectorizer": "custom-web-api",
        "compression": "myBQC"
      },
      {
        "name": "config4",
        "algorithm": "dotProduct",
        "vectorizer": "custom-web-api",
        "compression": "myBQWithoutOriginals"
      }
    ],
    "vectorizers": [
      {
        "name": "openai",
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      {
        "name": "custom-web-api",
        "kind": "customWebApi",
        "customWebApiParameters": {
          "httpMethod": "POST",
          "uri": "https://my-custom-endpoint.org/",
          "timeout": "PT1M",
          "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b",
          "httpHeaders": {
            "header1": "value1",
            "header2": "value2"
          },
          "authIdentity": {
            "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
          }
        }
      },
      {
        "name": "aml",
        "kind": "aml",
        "amlParameters": {
          "resourceId": "aml resource id",
          "region": "aml region",
          "uri": "https://my-custom-endpoint.org/",
          "timeout": "PT1M",
          "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32"
        }
      },
      {
        "name": "aml-cohere",
        "kind": "aml",
        "amlParameters": {
          "resourceId": "aml resource id",
          "region": "aml region",
          "uri": "https://my-custom-endpoint.org/",
          "timeout": "PT1M",
          "modelName": "Cohere-embed-v4"
        }
      }
    ],
    "compressions": [
      {
        "name": "mySQ8",
        "kind": "scalarQuantization",
        "truncationDimension": 2,
        "scalarQuantizationParameters": {
          "quantizedDataType": "int8"
        },
        "rescoringOptions": {
          "enableRescoring": true,
          "defaultOversampling": 10,
          "rescoreStorageMethod": "preserveOriginals"
        }
      },
      {
        "name": "myBQC",
        "kind": "binaryQuantization",
        "truncationDimension": 2,
        "rescoringOptions": {
          "enableRescoring": true,
          "defaultOversampling": 10,
          "rescoreStorageMethod": "preserveOriginals"
        }
      },
      {
        "name": "myBQWithoutOriginals",
        "kind": "binaryQuantization",
        "truncationDimension": 2,
        "rescoringOptions": {
          "enableRescoring": true,
          "defaultOversampling": 10,
          "rescoreStorageMethod": "discardOriginals"
        }
      }
    ]
  }
}

Definições

Nome Description
Accept

O cabeçalho Aceitar.

AIFoundryModelCatalogName

O nome do modelo de embedding do Fábrica de IA do Azure Catalog que será chamado.

AMLParameters

Especifica as propriedades para se conectar a um vetorizador AML.

AMLVectorizer

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.

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.

AzureOpenAIModelName

O nome do modelo do Azure Open AI que será chamado.

AzureOpenAIVectorizer

Especifica o recurso OpenAI do Azure usado para vetorizar uma cadeia de caracteres de consulta.

AzureOpenAIVectorizerParameters

Especifica os parâmetros para se conectar ao recurso do Azure OpenAI.

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.

BM25SimilarityAlgorithm

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').

CharFilterName

Define os nomes de todos os filtros de caracteres suportados pelo mecanismo de pesquisa.

CjkBigramTokenFilter

Forma bigrams de termos CJK gerados a partir do tokenizador padrão. Esse filtro de token é implementado usando o Apache Lucene.

CjkBigramTokenFilterScripts

Scripts que podem ser ignorados por CjkBigramTokenFilter.

ClassicSimilarityAlgorithm

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.

CommonGramTokenFilter

Construa bigramas para termos que ocorrem com frequência durante a indexação. Termos únicos ainda são indexados também, com bigramas sobrepostos. Esse filtro de token é implementado usando o Apache Lucene.

CorsOptions

Define opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para um índice.

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.

CustomNormalizer

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.

DictionaryDecompounderTokenFilter

Decompõe palavras compostas encontradas em muitos idiomas germânicos. 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.

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.

EdgeNGramTokenFilterSide

Especifica de qual lado da entrada um n-grama deve ser gerado.

EdgeNGramTokenFilterV2

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.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).

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.

ExhaustiveKnnParameters

Contém os parâmetros específicos para o algoritmo KNN exaustivo.

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.

HnswAlgorithmConfiguration

Contém opções de configuração específicas para o algoritmo de vizinhos mais próximos aproximados do HNSW usado durante a indexação e a consulta. O algoritmo HNSW oferece uma compensação ajustável entre velocidade e precisão de pesquisa.

HnswParameters

Contém os parâmetros específicos do algoritmo HNSW.

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.

KeywordMarkerTokenFilter

Marca termos como palavras-chave. Esse filtro de token é implementado usando o Apache Lucene.

KeywordTokenizer

Emite a entrada inteira como um único token. Esse tokenizador é implementado usando o Apache Lucene.

KeywordTokenizerV2

Emite a entrada inteira como um único token. Esse tokenizador é implementado usando o Apache Lucene.

LengthTokenFilter

Remove palavras muito longas ou muito curtas. Esse filtro de token é implementado usando o Apache Lucene.

LexicalAnalyzerName

Define os nomes de todos os analisadores de texto suportados pelo mecanismo de pesquisa.

LexicalNormalizerName

Define os nomes de todos os normalizadores de texto suportados pelo mecanismo de pesquisa.

LexicalTokenizerName

Define os nomes de todos os tokenizadores suportados pelo mecanismo de pesquisa.

LimitTokenFilter

Limita o número de tokens durante a indexação. Esse filtro de token é implementado usando o Apache Lucene.

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.

LuceneStandardTokenizerV2

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 é permitida como a cadeia de caracteres vazia. Esse filtro de caractere é implementado usando o Apache Lucene.

MicrosoftLanguageStemmingTokenizer

Divide o texto usando regras específicas de idioma e reduz palavras às suas formas base.

MicrosoftLanguageTokenizer

Divide o texto usando regras específicas de idioma.

MicrosoftStemmingTokenizerLanguage

Lista as linguagens suportadas pelo tokenizador de stemming da Microsoft.

MicrosoftTokenizerLanguage

Lista as linguagens suportadas pelo tokenizador de idiomas da Microsoft.

NGramTokenFilter

Gera n-gramas dos tamanhos determinados. Esse filtro de token é implementado usando o Apache Lucene.

NGramTokenFilterV2

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.

PathHierarchyTokenizerV2

Tokenizador para hierarquias semelhantes a caminhos. Esse tokenizador é implementado usando o Apache Lucene.

PatternAnalyzer

Separa texto em termos de forma flexível 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 para substituir. 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 para substituir. 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.

PhoneticEncoder

Identifica o tipo de codificador fonético a ser usado com um PhoneticTokenFilter.

PhoneticTokenFilter

Crie tokens para correspondências fonéticas. Esse filtro de token é implementado usando o Apache Lucene.

RankingOrder

Representa a pontuação a ser usada para a ordem de classificação dos documentos.

RescoringOptions

Contém as opções de recortação.

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.

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.

ScoringProfile

Define parâmetros para um índice de pesquisa que influenciam a pontuação em 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.

SearchFieldDataType

Define o tipo de dados de um campo em um índice de pesquisa.

SearchIndex

Representa uma definição de índice de pesquisa, que descreve os campos e o comportamento de pesquisa de um índice.

SearchIndexerDataNoneIdentity

Limpa a propriedade de identidade de uma fonte de dados.

SearchIndexerDataUserAssignedIdentity

Especifica a identidade de uma fonte de dados a ser usada.

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, como índices e mapas de sinônimos.

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.

ShingleTokenFilter

Cria combinações de tokens como um único token. Esse filtro de token é implementado usando o Apache Lucene.

SnowballTokenFilter

Um filtro que resulta em palavras usando um lematizador gerado por Bola de Neve. Esse filtro de token é implementado usando o Apache Lucene.

SnowballTokenFilterLanguage

O idioma a ser usado para um filtro de token do Snowball.

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 lematizaçã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

StemmerTokenFilterLanguage

O idioma a ser usado para um filtro de token de lematizador.

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.

StopwordsList

Identifica uma lista predefinida de palavras irrelevantes específicas do idioma.

StopwordsTokenFilter

Remove palavras irrelevantes de um fluxo de tokens. 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

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.

TextWeights

Define os pesos nos campos de índice para os quais as correspondências devem aumentar a pontuação em consultas de pesquisa.

TokenCharacterKind

Representa classes de caracteres nas quais um filtro de token pode operar.

TokenFilterName

Define os nomes de todos os filtros de token suportados pelo mecanismo de pesquisa.

TruncateTokenFilter

Trunca os termos para um comprimento específico. Esse filtro de token é implementado usando o Apache Lucene.

UaxUrlEmailTokenizer

Tokeniza URLs e e-mails como um único token. Esse tokenizador é implementado usando o Apache Lucene.

UniqueTokenFilter

Filtra os tokens com o mesmo texto como o token anterior. Esse filtro de token é implementado usando o Apache Lucene.

VectorEncodingFormat

O formato de codificação para interpretar o conteúdo do campo vetorial.

VectorSearch

Contém opções de configuração relacionadas à pesquisa de vetor.

VectorSearchAlgorithmKind

O algoritmo usado para indexação e consulta.

VectorSearchAlgorithmMetric

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.

VectorSearchCompressionKind

O método de compactação usado para indexação e consulta.

VectorSearchCompressionTarget

O tipo de dados quantizados de valores vetoriais compactados.

VectorSearchProfile

Define uma combinação de configurações a serem usadas com a pesquisa de vetor.

VectorSearchVectorizerKind

O método de vetorização a ser usado durante o tempo de consulta.

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.

WebApiVectorizerParameters

Especifica as propriedades para se conectar a um vetor definido pelo usuário.

WordDelimiterTokenFilter

Divide as palavras em subpalavras e realiza transformações opcionais em grupos de subpalavras. Esse filtro de token é implementado usando o Apache Lucene.

Accept

O cabeçalho Aceitar.

Valor Description
application/json;odata.metadata=minimal

AIFoundryModelCatalogName

O nome do modelo de embedding do Fábrica de IA do Azure Catalog que será chamado.

Valor Description
OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32

OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32

OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336

OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336

Facebook-DinoV2-Image-Embeddings-ViT-Base

Facebook-DinoV2-Image-Embeddings-ViT-Base

Facebook-DinoV2-Image-Embeddings-ViT-Giant

Facebook-DinoV2-Image-Embeddings-ViT-Giant

Cohere-embed-v3-english

Cohere-embed-v3-english

Cohere-embed-v3-multilingual

Cohere-embed-v3-multilingual

Cohere-embed-v4

Modelo Cohere embed v4 para gerar incorporações de texto e imagens.

AMLParameters

Especifica as propriedades para se conectar a um vetorizador AML.

Nome Tipo Description
key

string

(Necessário para autenticação de chave) A chave do serviço AML.

modelName

AIFoundryModelCatalogName

O nome do modelo de embedding do Fábrica de IA do Azure Catalog que é implantado no endpoint fornecido.

region

string

(Opcional para autenticação de token). A região em que o serviço AML é implantado.

resourceId

string

(Necessário para autenticação de token). O ID de recurso do Azure Resource Manager do serviço AML. Deve estar no formato subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft. MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.

timeout

string (duration)

(Opcional) Quando especificado, indica o tempo limite para o cliente http que fez a chamada à API.

uri

string (uri)

(Necessário para nenhuma autenticação ou autenticação de chave) O URI de pontuação do serviço AML para o qual o conteúdo JSON será enviado. Somente o esquema de URI https é permitido.

AMLVectorizer

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.

Nome Tipo Description
amlParameters

AMLParameters

Especifica as propriedades do vetorizador AML.

kind string:

aml

Tipo de VetorizadorBusca.

name

string

O nome a ser associado a esse método de vetorização específico.

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.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.AsciiFoldingTokenFilter

O discriminador para tipos derivados.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

preserveOriginal

boolean

False

Um valor que indica se o token original será mantido. O padrão é false.

AzureOpenAIModelName

O nome do modelo do Azure Open AI que será chamado.

Valor Description
text-embedding-ada-002

TextEmbeddingAda002 modelo.

text-embedding-3-large

TextEmbedding3 Modelo grande.

text-embedding-3-small

TextEmbedding3Small modelo.

gpt-5-mini

Modelo Gpt5Mini.

gpt-5-nano

Modelo Gpt5Nano.

gpt-5.4-mini

Modelo Gpt54Mini.

gpt-5.4-nano

Modelo Gpt54Nano.

AzureOpenAIVectorizer

Especifica o recurso OpenAI do Azure usado para vetorizar uma cadeia de caracteres de consulta.

Nome Tipo Description
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Contém os parâmetros específicos para a vetorização de inserção do OpenAI do Azure.

kind string:

azureOpenAI

Tipo de VetorizadorBusca.

name

string

O nome a ser associado a esse método de vetorização específico.

AzureOpenAIVectorizerParameters

Especifica os parâmetros para se conectar ao recurso do Azure OpenAI.

Nome Tipo Description
apiKey

string

Chave de API do recurso Azure OpenAI designado.

authIdentity SearchIndexerDataIdentity:

A identidade gerenciada atribuída pelo usuário usada para conexões de saída.

deploymentId

string

ID da implantação de modelo do Azure OpenAI no recurso designado.

modelName

AzureOpenAIModelName

O nome do modelo de inserção implantado no caminho deploymentId fornecido.

resourceUri

string (uri)

O URI do recurso do Azure OpenAI.

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.

Nome Tipo Description
kind string:

binaryQuantization

Tipo de BuscaVectorCompressão.

name

string

O nome a ser associado a essa configuração específica.

rescoringOptions

RescoringOptions

Contém as opções de recortação.

truncationDimension

integer (int32)

O número de dimensões para as qual truncar os vetores. Truncar os vetores reduz o tamanho dos vetores e a quantidade de dados que precisam ser transferidos durante a pesquisa. Isso pode economizar o custo de armazenamento e melhorar o desempenho da pesquisa em detrimento do recall. Ele deve ser usado apenas para inserções treinadas com o MRL (Matryoshka Representation Learning), como OpenAI text-embedding-3-large (pequeno). O valor padrão é nulo, o que significa que não há truncamento.

BM25SimilarityAlgorithm

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').

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.BM25Similarity

O discriminador para tipos derivados.

b

number (double)

Essa propriedade controla como o comprimento de um documento afeta a pontuação de relevância. Por padrão, um valor de 0,75 é usado. Um valor de 0,0 significa que nenhuma normalização de comprimento é aplicada, enquanto um valor de 1,0 significa que a pontuação é totalmente normalizada pelo comprimento do documento.

k1

number (double)

Essa propriedade controla a função de dimensionamento entre a frequência de termos de cada termos correspondentes e a pontuação de relevância final de um par de consultas de documento. Por padrão, um valor de 1.2 é usado. Um valor de 0,0 significa que a pontuação não é dimensionada com um aumento na frequência do termo.

CharFilterName

Define os nomes de todos os filtros de caracteres suportados pelo mecanismo de pesquisa.

Valor Description
html_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

CjkBigramTokenFilter

Forma bigrams de termos CJK gerados a partir do tokenizador padrão. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.CjkBigramTokenFilter

O discriminador para tipos derivados.

ignoreScripts

CjkBigramTokenFilterScripts[]

Os scripts a serem ignorados.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

outputUnigrams

boolean

False

Um valor que indica se os unigramas e bigrams devem ser gerados (se verdadeiros) ou apenas bigrams (se false). O padrão é false.

CjkBigramTokenFilterScripts

Scripts que podem ser ignorados por CjkBigramTokenFilter.

Valor Description
han

Ignore o script Han ao formar bigramas de termos CJK.

hiragana

Ignore a escrita Hiragana ao formar bigramas de termos CJK.

katakana

Ignore o script Katakana ao formar bigramas de termos CJK.

hangul

Ignore a escrita Hangul ao formar bigramas de termos CJK.

ClassicSimilarityAlgorithm

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.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.ClassicSimilarity

O discriminador para tipos derivados.

ClassicTokenizer

Tokenizador baseado em gramática adequado para processar a maioria dos documentos em idioma europeu. Esse tokenizador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.ClassicTokenizer

O discriminador para tipos derivados.

maxTokenLength

integer (int32)

maximum: 300
255

O comprimento máximo do token. O padrão é 255. Tokens mais longos do que o comprimento máximo são divididos. O comprimento máximo do token que pode ser usado é de 300 caracteres.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

CommonGramTokenFilter

Construa bigramas para termos que ocorrem com frequência durante a indexação. Termos únicos ainda são indexados também, com bigramas sobrepostos. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.CommonGramTokenFilter

O discriminador para tipos derivados.

commonWords

string[]

O conjunto de palavras comuns.

ignoreCase

boolean

False

Um valor que indica se a correspondência de palavras comuns não diferencia maiúsculas de minúsculas. O padrão é false.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

queryMode

boolean

False

Um valor que indica se o filtro de token está no modo de consulta. Quando no modo de consulta, o filtro de token gera bigrams e, em seguida, remove palavras comuns e termos únicos seguidos por uma palavra comum. O padrão é false.

CorsOptions

Define opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para um índice.

Nome Tipo Description
allowedOrigins

string[]

A lista de origens das quais o código JavaScript terá acesso ao índice. Pode conter uma lista de hosts no formato {protocol}://{fully-qualified-domain-name}[:{port#}] ou um único '*' para permitir todas as origens (não recomendado).

maxAgeInSeconds

integer (int64)

A duração pela qual os navegadores devem armazenar em cache as respostas de comprovação do CORS. O padrão é 5 minutos.

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.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.CustomAnalyzer

O discriminador para tipos derivados.

charFilters

CharFilterName[]

Uma lista de filtros de caracteres usados para preparar o texto de entrada antes de ser processado pelo criador de tokens. Por exemplo, eles podem substituir determinados caracteres ou símbolos. Os filtros são executados na ordem em que estão listados.

name

string

O nome do analisador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

tokenFilters

TokenFilterName[]

Uma lista de filtros de token usados para filtrar ou modificar os tokens gerados por um criador de token. Por exemplo, você pode especificar um filtro de minúsculas que converte todos os caracteres em letras minúsculas. Os filtros são executados na ordem em que estão listados.

tokenizer

LexicalTokenizerName

O nome do tokenizer a ser usado para dividir o texto contínuo em uma sequência de tokens, como dividir uma frase em palavras.

CustomNormalizer

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.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.CustomNormalizer

O discriminador para tipos derivados.

charFilters

CharFilterName[]

Uma lista de filtros de caracteres usados para preparar o texto de entrada antes de ser processado. Por exemplo, eles podem substituir determinados caracteres ou símbolos. Os filtros são executados na ordem em que estão listados.

name

string

O nome do filtro de caracteres. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

tokenFilters

TokenFilterName[]

Uma lista de filtros de token usados para filtrar ou modificar o token de entrada. Por exemplo, você pode especificar um filtro de minúsculas que converte todos os caracteres em letras minúsculas. Os filtros são executados na ordem em que estão listados.

DictionaryDecompounderTokenFilter

Decompõe palavras compostas encontradas em muitos idiomas germânicos. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter

O discriminador para tipos derivados.

maxSubwordSize

integer (int32)

maximum: 300
15

O tamanho máximo da sub-palavra. Somente sub-palavras mais curtas do que essa são geradas. O padrão é 15. O máximo é 300.

minSubwordSize

integer (int32)

maximum: 300
2

O tamanho mínimo da sub-palavra. Somente as sub palavras mais longas do que isso são geradas. O padrão é 2. O máximo é 300.

minWordSize

integer (int32)

maximum: 300
5

O tamanho mínimo da palavra. Somente palavras mais longas do que isso são processadas. O padrão é 5. O máximo é 300.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

onlyLongestMatch

boolean

False

Um valor que indica se deve adicionar apenas a sub palavra correspondente mais longa à saída. O padrão é false.

wordList

string[]

A lista de palavras que serão correspondentes.

DistanceScoringFunction

Define uma função que aumenta as pontuações com base na distância de uma localização geográfica.

Nome Tipo Description
boost

number (double)

Um multiplicador para a pontuação bruta. Deve ser um número positivo não igual a 1,0.

distance

DistanceScoringParameters

Valores de parâmetro para a função de pontuação de distância.

fieldName

string

O nome do campo usado como entrada para a função de pontuação.

interpolation

ScoringFunctionInterpolation

Um valor que indica como o aumento será interpolado entre as pontuações do documento; o padrão é "Linear".

type string:

distance

Tipo de Função de Pontuação.

DistanceScoringParameters

Fornece valores de parâmetro para uma função de pontuação de distância.

Nome Tipo Description
boostingDistance

number (double)

A distância em quilômetros do local de referência onde termina o alcance de impulso.

referencePointParameter

string

O nome do parâmetro passado em consultas de pesquisa para especificar o local de referência.

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.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.EdgeNGramTokenFilter

O discriminador para tipos derivados.

maxGram

integer (int32)

2

O comprimento máximo de n-grama. O padrão é 2.

minGram

integer (int32)

1

O comprimento mínimo de n-grama. O padrão é 1. Deve ser menor que o valor de maxGram.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

side

EdgeNGramTokenFilterSide

front

Especifica de qual lado da entrada o n-gram deve ser gerado. O padrão é "front".

EdgeNGramTokenFilterSide

Especifica de qual lado da entrada um n-grama deve ser gerado.

Valor Description
front

Especifica que o n-grama deve ser gerado a partir da frente da entrada.

back

Especifica que o n-grama deve ser gerado a partir da parte de trás da entrada.

EdgeNGramTokenFilterV2

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.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.EdgeNGramTokenFilterV2

O discriminador para tipos derivados.

maxGram

integer (int32)

maximum: 300
2

O comprimento máximo de n-grama. O padrão é 2. O máximo é 300.

minGram

integer (int32)

maximum: 300
1

O comprimento mínimo de n-grama. O padrão é 1. O máximo é 300. Deve ser menor que o valor de maxGram.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

side

EdgeNGramTokenFilterSide

front

Especifica de qual lado da entrada o n-gram deve ser gerado. O padrão é "front".

EdgeNGramTokenizer

Tokeniza a entrada de uma borda em n-gramas dos tamanhos fornecidos. Esse tokenizador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.EdgeNGramTokenizer

O discriminador para tipos derivados.

maxGram

integer (int32)

maximum: 300
2

O comprimento máximo de n-grama. O padrão é 2. O máximo é 300.

minGram

integer (int32)

maximum: 300
1

O comprimento mínimo de n-grama. O padrão é 1. O máximo é 300. Deve ser menor que o valor de maxGram.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

tokenChars

TokenCharacterKind[]

Classes de caractere a serem mantidas nos tokens.

ElisionTokenFilter

Remove elisões. Por exemplo, "l'avion" (o plano) será convertido em "avion" (plano). Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.ElisionTokenFilter

O discriminador para tipos derivados.

articles

string[]

O conjunto de artigos a serem removidos.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

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.

Nome Tipo Description
exhaustiveKnnParameters

ExhaustiveKnnParameters

Contém os parâmetros específicos para o algoritmo KNN exaustivo.

kind string:

exhaustiveKnn

Tipo de AlgoritmoBuscaVectorConfiguração.

name

string

O nome a ser associado a essa configuração específica.

ExhaustiveKnnParameters

Contém os parâmetros específicos para o algoritmo KNN exaustivo.

Nome Tipo Description
metric

VectorSearchAlgorithmMetric

A métrica de similaridade a ser usada para comparações vetoriais.

FreshnessScoringFunction

Define uma função que aumenta as pontuações com base no valor de um campo de data e hora.

Nome Tipo Description
boost

number (double)

Um multiplicador para a pontuação bruta. Deve ser um número positivo não igual a 1,0.

fieldName

string

O nome do campo usado como entrada para a função de pontuação.

freshness

FreshnessScoringParameters

Valores de parâmetro para a função de pontuação de atualização.

interpolation

ScoringFunctionInterpolation

Um valor que indica como o aumento será interpolado entre as pontuações do documento; o padrão é "Linear".

type string:

freshness

Tipo de Função de Pontuação.

FreshnessScoringParameters

Fornece valores de parâmetro para uma função de pontuação de atualização.

Nome Tipo Description
boostingDuration

string (duration)

O período de expiração após o qual o aumento será interrompido para um documento específico.

HnswAlgorithmConfiguration

Contém opções de configuração específicas para o algoritmo de vizinhos mais próximos aproximados do HNSW usado durante a indexação e a consulta. O algoritmo HNSW oferece uma compensação ajustável entre velocidade e precisão de pesquisa.

Nome Tipo Description
hnswParameters

HnswParameters

Contém os parâmetros específicos do algoritmo HNSW.

kind string:

hnsw

Tipo de AlgoritmoBuscaVectorConfiguração.

name

string

O nome a ser associado a essa configuração específica.

HnswParameters

Contém os parâmetros específicos do algoritmo HNSW.

Nome Tipo Valor padrão Description
efConstruction

integer (int32)

minimum: 100
maximum: 1000
400

O tamanho da lista dinâmica que contém os vizinhos mais próximos, que é usada durante o tempo de indexação. Aumentar esse parâmetro pode melhorar a qualidade do índice, às custas do aumento do tempo de indexação. Em um certo ponto, aumentar esse parâmetro leva a retornos decrescentes.

efSearch

integer (int32)

minimum: 100
maximum: 1000
500

O tamanho da lista dinâmica que contém os vizinhos mais próximos, que é usada durante o tempo de pesquisa. Aumentar esse parâmetro pode melhorar os resultados da pesquisa, às custas de uma pesquisa mais lenta. Em um certo ponto, aumentar esse parâmetro leva a retornos decrescentes.

m

integer (int32)

minimum: 4
maximum: 10
4

O número de vínculos bidirecionais criados para cada novo elemento durante a construção. Aumentar esse valor de parâmetro pode melhorar a recuperação e reduzir os tempos de recuperação para conjuntos de dados com alta dimensionalidade intrínseca às custas do aumento do consumo de memória e maior tempo de indexação.

metric

VectorSearchAlgorithmMetric

A métrica de similaridade a ser usada para comparações vetoriais.

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.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.KeepTokenFilter

O discriminador para tipos derivados.

keepWords

string[]

A lista de palavras a serem mantidas.

keepWordsCase

boolean

False

Um valor que indica se todas as palavras devem ser minúsculas primeiro. O padrão é false.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

KeywordMarkerTokenFilter

Marca termos como palavras-chave. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.KeywordMarkerTokenFilter

O discriminador para tipos derivados.

ignoreCase

boolean

False

Um valor que indica se deve ignorar maiúsculas e minúsculas. Se for true, todas as palavras serão convertidas em letras minúsculas primeiro. O padrão é false.

keywords

string[]

Uma lista de palavras para marcar como palavras-chave.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

KeywordTokenizer

Emite a entrada inteira como um único token. Esse tokenizador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.KeywordTokenizer

O discriminador para tipos derivados.

bufferSize

integer (int32)

256

O tamanho do buffer de leitura em bytes. O padrão é 256.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

KeywordTokenizerV2

Emite a entrada inteira como um único token. Esse tokenizador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.KeywordTokenizerV2

O discriminador para tipos derivados.

maxTokenLength

integer (int32)

maximum: 300
256

O comprimento máximo do token. O padrão é 256. Tokens mais longos do que o comprimento máximo são divididos. O comprimento máximo do token que pode ser usado é de 300 caracteres.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

LengthTokenFilter

Remove palavras muito longas ou muito curtas. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.LengthTokenFilter

O discriminador para tipos derivados.

max

integer (int32)

maximum: 300
300

O comprimento máximo em caracteres. O padrão e o máximo é 300.

min

integer (int32)

maximum: 300
0

O comprimento mínimo em caracteres. O padrão é 0. O máximo é 300. Deve ser menor que o valor máximo.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

LexicalAnalyzerName

Define os nomes de todos os analisadores de texto suportados pelo mecanismo de pesquisa.

Valor Description
ar.microsoft

Analisador Microsoft para árabe.

ar.lucene

Analisador Lucene para árabe.

hy.lucene

Analisador Lucene para armênio.

bn.microsoft

Analisador Microsoft para Bangla.

eu.lucene

Analisador Lucene para basco.

bg.microsoft

Analisador Microsoft para búlgaro.

bg.lucene

Analisador de Lucene para búlgaro.

ca.microsoft

Analisador Microsoft para catalão.

ca.lucene

Analisador Lucene para catalão.

zh-Hans.microsoft

Analisador Microsoft para chinês (Simplificado).

zh-Hans.lucene

Analisador Lucene para chinês (simplificado).

zh-Hant.microsoft

Analisador Microsoft para chinês (tradicional).

zh-Hant.lucene

Analisador de Lucene para chinês (tradicional).

hr.microsoft

Analisador Microsoft para croata.

cs.microsoft

Analisador Microsoft para tcheco.

cs.lucene

Analisador de Lucene para o checo.

da.microsoft

Analisador Microsoft para dinamarquês.

da.lucene

Analisador de Lucene para dinamarquês.

nl.microsoft

Analisador Microsoft para holandês.

nl.lucene

Analisador Lucene para holandês.

en.microsoft

Analisador Microsoft para inglês.

en.lucene

Analisador Lucene para inglês.

et.microsoft

Analisador Microsoft para estoniano.

fi.microsoft

Analisador Microsoft para finlandês.

fi.lucene

Analisador de Lucene para finlandês.

fr.microsoft

Analisador Microsoft para francês.

fr.lucene

Analisador de Lucene para francês.

gl.lucene

Analisador Lucene para galego.

de.microsoft

Analisador Microsoft para alemão.

de.lucene

Analisador Lucene para alemão.

el.microsoft

Analisador Microsoft para grego.

el.lucene

Analisador de Lucene para grego.

gu.microsoft

Analisador Microsoft para Gujarati.

he.microsoft

Analisador Microsoft para hebraico.

hi.microsoft

Analisador Microsoft para hindi.

hi.lucene

Analisador de Lucene para Hindi.

hu.microsoft

Analisador Microsoft para húngaro.

hu.lucene

Analisador Lucene para húngaro.

is.microsoft

Analisador Microsoft para islandês.

id.microsoft

Analisador Microsoft para indonésio (Bahasa).

id.lucene

Analisador de Lucene para indonésio.

ga.lucene

Analisador Lucene para irlandês.

it.microsoft

Analisador Microsoft para italiano.

it.lucene

Analisador de Lucene para italiano.

ja.microsoft

Analisador Microsoft para japonês.

ja.lucene

Analisador Lucene para japonês.

kn.microsoft

Analisador Microsoft para canarês.

ko.microsoft

Analisador Microsoft para coreano.

ko.lucene

Analisador de Lucene para coreano.

lv.microsoft

Analisador Microsoft para letão.

lv.lucene

Analisador de Lucene para letão.

lt.microsoft

Analisador Microsoft para lituano.

ml.microsoft

Analisador Microsoft para malaiala.

ms.microsoft

Analisador Microsoft para malaio (latim).

mr.microsoft

Analisador Microsoft para marata.

nb.microsoft

Microsoft analyzer for Norwegian (Bokmål).

no.lucene

Analisador de Lucene para norueguês.

fa.lucene

Analisador de Lucene para persa.

pl.microsoft

Analisador Microsoft para polonês.

pl.lucene

Analisador Lucene para polonês.

pt-BR.microsoft

Analisador Microsoft para português (Brasil).

pt-BR.lucene

Analisador Lucene para português (Brasil).

pt-PT.microsoft

Analisador Microsoft para português (Portugal).

pt-PT.lucene

Analisador Lucene para português (Portugal).

pa.microsoft

Analisador Microsoft para Punjabi.

ro.microsoft

Analisador Microsoft para romeno.

ro.lucene

Analisador de Lucene para romeno.

ru.microsoft

Analisador Microsoft para russo.

ru.lucene

Analisador de Lucene para o russo.

sr-cyrillic.microsoft

Analisador Microsoft para sérvio (cirílico).

sr-latin.microsoft

Analisador Microsoft para sérvio (latim).

sk.microsoft

Analisador Microsoft para eslovaco.

sl.microsoft

Analisador Microsoft para esloveno.

es.microsoft

Analisador Microsoft para espanhol.

es.lucene

Analisador Lucene para espanhol.

sv.microsoft

Analisador Microsoft para sueco.

sv.lucene

Analisador Lucene para sueco.

ta.microsoft

Analisador Microsoft para tâmil.

te.microsoft

Analisador Microsoft para Telugu.

th.microsoft

Analisador Microsoft para tailandês.

th.lucene

Analisador Lucene para tailandês.

tr.microsoft

Analisador Microsoft para turco.

tr.lucene

Analisador Lucene para turco.

uk.microsoft

Analisador Microsoft para ucraniano.

ur.microsoft

Analisador Microsoft para urdu.

vi.microsoft

Analisador Microsoft para vietnamita.

standard.lucene

Analisador Lucene padrão.

standardasciifolding.lucene

Analisador de Lucene Dobrável ASCII padrão. Consulte https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers

keyword

Trata todo o conteúdo de um campo como um único token. Isso é útil para dados como cep, IDs e alguns nomes de produto. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html

pattern

Separa texto em termos de forma flexível por meio de um padrão de expressão regular. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html

simple

Divide o texto em partes nos pontos onde não há letras e converte o texto resultante para minúsculas. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html

stop

Divide o texto em letras não letras; Aplica os filtros de token de letras minúsculas e palavras irrelevantes. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html

whitespace

Um analisador que usa o tokenizador de espaço em branco. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html

LexicalNormalizerName

Define os nomes de todos os normalizadores de texto suportados pelo mecanismo de pesquisa.

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

elision

Remove elisões. Por exemplo, "l'avion" (o plano) será convertido em "avion" (plano). Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html

lowercase

Normaliza o texto do token para minúsculas. Consulte https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html

standard

Normalizador padrão, que consiste em letras minúsculas e dobras ascii. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html

uppercase

Normaliza o texto do token para maiúsculas. Consulte https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html

LexicalTokenizerName

Define os nomes de todos os tokenizadores suportados pelo mecanismo de pesquisa.

Valor Description
classic

Tokenizador baseado em gramática adequado para processar a maioria dos documentos em idioma europeu. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html

edgeNGram

Tokeniza a entrada de uma borda em n-gramas dos tamanhos fornecidos. Consulte https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html

keyword_v2

Emite a entrada inteira como um único token. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html

letter

Dividir o texto em pontos onde não há letras. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html

lowercase

Divide o texto em partes nos pontos onde não há letras e converte o texto resultante para minúsculas. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html

microsoft_language_tokenizer

Divide o texto usando regras específicas de idioma.

microsoft_language_stemming_tokenizer

Divide o texto usando regras específicas de idioma e reduz palavras às suas formas base.

nGram

Tokeniza a entrada em n-gramas dos tamanhos fornecidos. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html

path_hierarchy_v2

Tokenizador para hierarquias semelhantes a caminhos. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html

pattern

Tokenizer que usa a correspondência de padrões regex para construir tokens distintos. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html

standard_v2

Analisador Lucene Padrão; Composto pelo tokenizador padrão, filtro em letras minúsculas e filtro de parada. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html

uax_url_email

Tokeniza URLs e e-mails como um único token. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html

whitespace

Divide o texto em espaços em branco. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html

LimitTokenFilter

Limita o número de tokens durante a indexação. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.LimitTokenFilter

O discriminador para tipos derivados.

consumeAllTokens

boolean

False

Um valor que indica se todos os tokens da entrada devem ser consumidos mesmo se maxTokenCount for atingido. O padrão é false.

maxTokenCount

integer (int32)

1

O número máximo de tokens a serem produzidos. O padrão é 1.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

LuceneStandardAnalyzer

Analisador standard do Apache Lucene; Composto pelo tokenizador padrão, filtro em letras minúsculas e filtro de parada.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.StandardAnalyzer

O discriminador para tipos derivados.

maxTokenLength

integer (int32)

maximum: 300
255

O comprimento máximo do token. O padrão é 255. Tokens mais longos do que o comprimento máximo são divididos. O comprimento máximo do token que pode ser usado é de 300 caracteres.

name

string

O nome do analisador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

stopwords

string[]

Uma lista de palavras irrelevantes.

LuceneStandardTokenizer

Quebra o texto seguindo as regras de Segmentação de Texto Unicode. Esse tokenizador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.StandardTokenizer

O discriminador para tipos derivados.

maxTokenLength

integer (int32)

255

O comprimento máximo do token. O padrão é 255. Tokens mais longos do que o comprimento máximo são divididos.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

LuceneStandardTokenizerV2

Quebra o texto seguindo as regras de Segmentação de Texto Unicode. Esse tokenizador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.StandardTokenizerV2

O discriminador para tipos derivados.

maxTokenLength

integer (int32)

maximum: 300
255

O comprimento máximo do token. O padrão é 255. Tokens mais longos do que o comprimento máximo são divididos. O comprimento máximo do token que pode ser usado é de 300 caracteres.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

MagnitudeScoringFunction

Define uma função que aumenta as pontuações com base na magnitude de um campo numérico.

Nome Tipo Description
boost

number (double)

Um multiplicador para a pontuação bruta. Deve ser um número positivo não igual a 1,0.

fieldName

string

O nome do campo usado como entrada para a função de pontuação.

interpolation

ScoringFunctionInterpolation

Um valor que indica como o aumento será interpolado entre as pontuações do documento; o padrão é "Linear".

magnitude

MagnitudeScoringParameters

Valores de parâmetro para a função de pontuação de magnitude.

type string:

magnitude

Tipo de Função de Pontuação.

MagnitudeScoringParameters

Fornece valores de parâmetro para uma função de pontuação de magnitude.

Nome Tipo Description
boostingRangeEnd

number (double)

O valor de campo no qual o aumento termina.

boostingRangeStart

number (double)

O valor de campo no qual o aumento começa.

constantBoostBeyondRange

boolean

Um valor que indica se deve ser aplicado um aumento constante para valores de campo além do valor final do intervalo; default é false.

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 é permitida como a cadeia de caracteres vazia. Esse filtro de caractere é implementado usando o Apache Lucene.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.MappingCharFilter

O discriminador para tipos derivados.

mappings

string[]

Uma lista de mapeamentos do seguinte formato: "a=>b" (todas as ocorrências do caractere "a" serão substituídas pelo caractere "b").

name

string

O nome do filtro de caracteres. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

MicrosoftLanguageStemmingTokenizer

Divide o texto usando regras específicas de idioma e reduz palavras às suas formas base.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer

O discriminador para tipos derivados.

isSearchTokenizer

boolean

False

Um valor que indica como o tokenizador é usado. Defina como true se usado como o tokenizador de pesquisa, definido como false se usado como o tokenizador de indexação. O padrão é false.

language

MicrosoftStemmingTokenizerLanguage

O idioma a ser usado. O padrão é inglês.

maxTokenLength

integer (int32)

maximum: 300
255

O comprimento máximo do token. Tokens mais longos do que o comprimento máximo são divididos. O comprimento máximo do token que pode ser usado é de 300 caracteres. Tokens com mais de 300 caracteres são divididos primeiro em tokens de comprimento 300 e, em seguida, cada um desses tokens é dividido com base no conjunto de comprimento máximo do token. O padrão é 255.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

MicrosoftLanguageTokenizer

Divide o texto usando regras específicas de idioma.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.MicrosoftLanguageTokenizer

O discriminador para tipos derivados.

isSearchTokenizer

boolean

False

Um valor que indica como o tokenizador é usado. Defina como true se usado como o tokenizador de pesquisa, definido como false se usado como o tokenizador de indexação. O padrão é false.

language

MicrosoftTokenizerLanguage

O idioma a ser usado. O padrão é inglês.

maxTokenLength

integer (int32)

maximum: 300
255

O comprimento máximo do token. Tokens mais longos do que o comprimento máximo são divididos. O comprimento máximo do token que pode ser usado é de 300 caracteres. Tokens com mais de 300 caracteres são divididos primeiro em tokens de comprimento 300 e, em seguida, cada um desses tokens é dividido com base no conjunto de comprimento máximo do token. O padrão é 255.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

MicrosoftStemmingTokenizerLanguage

Lista as linguagens suportadas pelo tokenizador de stemming da Microsoft.

Valor Description
arabic

Seleciona o tokenizador stemming da Microsoft para árabe.

bangla

Seleciona o tokenizador stemming da Microsoft para o Bangla.

bulgarian

Seleciona o tokenizador stemming da Microsoft para búlgaro.

catalan

Seleciona o tokenizador stemming da Microsoft para catalão.

croatian

Seleciona o tokenizador stemming da Microsoft para croata.

czech

Seleciona o tokenizador de stemming da Microsoft para tcheco.

danish

Seleciona o tokenizador stemming da Microsoft para dinamarquês.

dutch

Seleciona o tokenizador stemming da Microsoft para holandês.

english

Seleciona o tokenizador stemming da Microsoft para o inglês.

estonian

Seleciona o tokenizador stemming da Microsoft para o estoniano.

finnish

Seleciona o tokenizador stemming da Microsoft para finlandês.

french

Seleciona o tokenizador stemming da Microsoft para o francês.

german

Seleciona o tokenizador stemming da Microsoft para alemão.

greek

Seleciona o tokenizador stemming da Microsoft para o grego.

gujarati

Seleciona o tokenizador stemming da Microsoft para Gujarati.

hebrew

Seleciona o tokenizador stemming da Microsoft para hebraico.

hindi

Seleciona o tokenizador stemming da Microsoft para hindi.

hungarian

Seleciona o tokenizador stemming da Microsoft para húngaro.

icelandic

Seleciona o tokenizador de stemming da Microsoft para islandês.

indonesian

Seleciona o tokenizador stemming da Microsoft para indonésio.

italian

Seleciona o tokenizador stemming da Microsoft para italiano.

kannada

Seleciona o tokenizador stemming da Microsoft para canarês.

latvian

Seleciona o tokenizador stemming da Microsoft para o letão.

lithuanian

Seleciona o tokenizador stemming da Microsoft para lituano.

malay

Seleciona o tokenizador stemming da Microsoft para o malaio.

malayalam

Seleciona o tokenizador stemming da Microsoft para malaiala.

marathi

Seleciona o tokenizador stemming da Microsoft para o marata.

norwegianBokmaal

Seleciona o tokenizer stemming Microsoft para norueguês (Bokmål).

polish

Seleciona o tokenizador stemming da Microsoft para polonês.

portuguese

Seleciona o tokenizador stemming da Microsoft para português.

portugueseBrazilian

Seleciona o tokenizador stemming da Microsoft para português (Brasil).

punjabi

Seleciona o tokenizador stemming da Microsoft para Punjabi.

romanian

Seleciona o tokenizador stemming da Microsoft para romeno.

russian

Seleciona o tokenizador stemming da Microsoft para russo.

serbianCyrillic

Seleciona o tokenizador stemming da Microsoft para sérvio (cirílico).

serbianLatin

Seleciona o tokenizador stemming da Microsoft para sérvio (latim).

slovak

Seleciona o tokenizador stemming da Microsoft para eslovaco.

slovenian

Seleciona o tokenizador stemming da Microsoft para o esloveno.

spanish

Seleciona o tokenizador stemming da Microsoft para espanhol.

swedish

Seleciona o tokenizador stemming da Microsoft para sueco.

tamil

Seleciona o tokenizador stemming da Microsoft para tâmil.

telugu

Seleciona o tokenizador stemming da Microsoft para Telugu.

turkish

Seleciona o tokenizador stemming da Microsoft para turco.

ukrainian

Seleciona o tokenizador stemming da Microsoft para ucraniano.

urdu

Seleciona o tokenizador stemming da Microsoft para urdu.

MicrosoftTokenizerLanguage

Lista as linguagens suportadas pelo tokenizador de idiomas da Microsoft.

Valor Description
bangla

Seleciona o tokenizador da Microsoft para o bengali.

bulgarian

Seleciona o tokenizador Microsoft para búlgaro.

catalan

Seleciona o tokenizador da Microsoft para catalão.

chineseSimplified

Seleciona o tokenizador Microsoft para chinês (Simplificado).

chineseTraditional

Seleciona o tokenizador Microsoft para chinês (Tradicional).

croatian

Seleciona o tokenizador da Microsoft para croata.

czech

Seleciona o tokenizador da Microsoft para tcheco.

danish

Seleciona o tokenizador da Microsoft para dinamarquês.

dutch

Seleciona o tokenizador da Microsoft para holandês.

english

Seleciona o tokenizador da Microsoft para o inglês.

french

Seleciona o tokenizador da Microsoft para francês.

german

Seleciona o tokenizador da Microsoft para alemão.

greek

Seleciona o tokenizador da Microsoft para o grego.

gujarati

Seleciona o tokenizador da Microsoft para Gujarati.

hindi

Seleciona o tokenizador da Microsoft para hindi.

icelandic

Seleciona o tokenizador da Microsoft para islandês.

indonesian

Seleciona o tokenizador da Microsoft para indonésio.

italian

Seleciona o tokenizador da Microsoft para italiano.

japanese

Seleciona o tokenizador da Microsoft para japonês.

kannada

Seleciona o tokenizador da Microsoft para canarês.

korean

Seleciona o tokenizador da Microsoft para coreano.

malay

Seleciona o tokenizador da Microsoft para malaio.

malayalam

Seleciona o tokenizador da Microsoft para malaiala.

marathi

Seleciona o tokenizador da Microsoft para o marata.

norwegianBokmaal

Seleciona o tokenizador Microsoft para norueguês (Bokmål).

polish

Seleciona o tokenizador da Microsoft para polonês.

portuguese

Seleciona o tokenizador da Microsoft para português.

portugueseBrazilian

Seleciona o tokenizador da Microsoft para português (Brasil).

punjabi

Seleciona o tokenizador da Microsoft para Punjabi.

romanian

Seleciona o tokenizador da Microsoft para romeno.

russian

Seleciona o tokenizador da Microsoft para russo.

serbianCyrillic

Seleciona o tokenizador da Microsoft para sérvio (cirílico).

serbianLatin

Seleciona o tokenizador Microsoft para sérvio (latim).

slovenian

Seleciona o tokenizador da Microsoft para o esloveno.

spanish

Seleciona o tokenizador da Microsoft para espanhol.

swedish

Seleciona o tokenizador da Microsoft para sueco.

tamil

Seleciona o tokenizador da Microsoft para tâmil.

telugu

Seleciona o tokenizador da Microsoft para Telugu.

thai

Seleciona o tokenizador da Microsoft para o tailandês.

ukrainian

Seleciona o tokenizador da Microsoft para ucraniano.

urdu

Seleciona o tokenizador da Microsoft para urdu.

vietnamese

Seleciona o tokenizador da Microsoft para vietnamita.

NGramTokenFilter

Gera n-gramas dos tamanhos determinados. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.NGramTokenFilter

O discriminador para tipos derivados.

maxGram

integer (int32)

2

O comprimento máximo de n-grama. O padrão é 2.

minGram

integer (int32)

1

O comprimento mínimo de n-grama. O padrão é 1. Deve ser menor que o valor de maxGram.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

NGramTokenFilterV2

Gera n-gramas dos tamanhos determinados. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.NGramTokenFilterV2

O discriminador para tipos derivados.

maxGram

integer (int32)

maximum: 300
2

O comprimento máximo de n-grama. O padrão é 2. O máximo é 300.

minGram

integer (int32)

maximum: 300
1

O comprimento mínimo de n-grama. O padrão é 1. O máximo é 300. Deve ser menor que o valor de maxGram.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

NGramTokenizer

Tokeniza a entrada em n-gramas dos tamanhos fornecidos. Esse tokenizador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.NGramTokenizer

O discriminador para tipos derivados.

maxGram

integer (int32)

maximum: 300
2

O comprimento máximo de n-grama. O padrão é 2. O máximo é 300.

minGram

integer (int32)

maximum: 300
1

O comprimento mínimo de n-grama. O padrão é 1. O máximo é 300. Deve ser menor que o valor de maxGram.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

tokenChars

TokenCharacterKind[]

Classes de caractere a serem mantidas nos tokens.

PathHierarchyTokenizerV2

Tokenizador para hierarquias semelhantes a caminhos. Esse tokenizador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.PathHierarchyTokenizerV2

O discriminador para tipos derivados.

delimiter

string

maxLength: 1
/

O caractere delimitador a ser usado. O padrão é "/".

maxTokenLength

integer (int32)

maximum: 300
300

O comprimento máximo do token. O padrão e o máximo é 300.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

replacement

string

maxLength: 1
/

Um valor que, se definido, substitui o caractere delimitador. O padrão é "/".

reverse

boolean

False

Um valor que indica se os tokens devem ser gerados em ordem inversa. O padrão é false.

skip

integer (int32)

0

O número de tokens iniciais a serem ignoradas. O padrão é 0.

PatternAnalyzer

Separa texto em termos de forma flexível por meio de um padrão de expressão regular. Esse analisador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.PatternAnalyzer

O discriminador para tipos derivados.

flags

string

Flags de expressão regular, especificados como uma sequência separada de valores RegexFlags por '|'.

lowercase

boolean

True

Um valor que indica se os termos devem ser minúsculos. O padrão é true.

name

string

O nome do analisador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

pattern

string

\W+

Um padrão de expressão regular para corresponder a separadores de token. Padrão é uma expressão que corresponde a um ou mais caracteres que não são palavras.

stopwords

string[]

Uma lista de palavras irrelevantes.

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.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.PatternCaptureTokenFilter

O discriminador para tipos derivados.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

patterns

string[]

Uma lista de padrões a serem correspondentes a cada token.

preserveOriginal

boolean

True

Um valor que indica se o token original deve ser retornado mesmo se um dos padrões corresponder. O padrão é true.

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 para substituir. 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.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.PatternReplaceCharFilter

O discriminador para tipos derivados.

name

string

O nome do filtro de caracteres. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

pattern

string

Um padrão de expressão regular.

replacement

string

O texto de substituição.

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 para substituir. 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.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.PatternReplaceTokenFilter

O discriminador para tipos derivados.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

pattern

string

Um padrão de expressão regular.

replacement

string

O texto de substituição.

PatternTokenizer

Tokenizer que usa a correspondência de padrões regex para construir tokens distintos. Esse tokenizador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.PatternTokenizer

O discriminador para tipos derivados.

flags

string

Flags de expressão regular, especificados como uma sequência separada de valores RegexFlags por '|'.

group

integer (int32)

-1

O ordinal baseado em zero do grupo correspondente no padrão de expressão regular a ser extraído em tokens. Use -1 se quiser usar todo o padrão para dividir a entrada em tokens, independentemente dos grupos correspondentes. O padrão é -1.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

pattern

string

\W+

Um padrão de expressão regular para corresponder a separadores de token. Padrão é uma expressão que corresponde a um ou mais caracteres que não são palavras.

PhoneticEncoder

Identifica o tipo de codificador fonético a ser usado com um PhoneticTokenFilter.

Valor Description
metaphone

Codifica um token em um valor Metaphone.

doubleMetaphone

Codifica um token em um valor de metafone duplo.

soundex

Codifica um token em um valor Soundex.

refinedSoundex

Codifica um token em um valor Soundex refinado.

caverphone1

Codifica um token em um valor Caverphone 1.0.

caverphone2

Codifica um token em um valor Caverphone 2.0.

cologne

Codifica um token em um valor fonético de Colônia.

nysiis

Codifica um token em um valor NYSIIS.

koelnerPhonetik

Codifica um token usando o algoritmo Kölner Phonetik.

haasePhonetik

Codifica um token usando o refinamento Haase do algoritmo Kölner Phonetik.

beiderMorse

Codifica um token em um valor Beider-Morse.

PhoneticTokenFilter

Crie tokens para correspondências fonéticas. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.PhoneticTokenFilter

O discriminador para tipos derivados.

encoder

PhoneticEncoder

metaphone

O codificador fonético a ser usado. O padrão é "metafone".

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

replace

boolean

True

Um valor que indica se os tokens codificados devem substituir os tokens originais. Se false, os tokens codificados serão adicionados como sinônimos. O padrão é true.

RankingOrder

Representa a pontuação a ser usada para a ordem de classificação dos documentos.

Valor Description
BoostedRerankerScore

Define a ordem de classificação como BoostedRerankerScore

RerankerScore

Define a ordem de classificação como ReRankerScore

RescoringOptions

Contém as opções de recortação.

Nome Tipo Valor padrão Description
defaultOversampling

number (double)

Fator de sobrecarga padrão. A sobreamostragem recupera um conjunto maior de documentos potenciais para compensar a perda de resolução devido à quantização. Isso aumenta o conjunto de resultados que serão remarcados em vetores de precisão total. O valor mínimo é 1, o que significa que não há sobrecarga (1x). Este parâmetro só pode ser definido quando 'enableRescoring' for verdadeiro. Valores mais altos melhoram o recall em detrimento da latência.

enableRescoring

boolean

True

Se definido como true, após a pesquisa inicial nos vetores compactados, as pontuações de similaridade serão recalculadas usando os vetores de precisão total. Isso melhorará o recall em detrimento da latência.

rescoreStorageMethod enum:
  • discardOriginals
  • preserveOriginals
preserveOriginals

Controla o método de armazenamento para vetores originais. Essa configuração é imutável.

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.

Nome Tipo Description
kind string:

scalarQuantization

Tipo de BuscaVectorCompressão.

name

string

O nome a ser associado a essa configuração específica.

rescoringOptions

RescoringOptions

Contém as opções de recortação.

scalarQuantizationParameters

ScalarQuantizationParameters

Contém os parâmetros específicos para a Quantização Escalar.

truncationDimension

integer (int32)

O número de dimensões para as qual truncar os vetores. Truncar os vetores reduz o tamanho dos vetores e a quantidade de dados que precisam ser transferidos durante a pesquisa. Isso pode economizar o custo de armazenamento e melhorar o desempenho da pesquisa em detrimento do recall. Ele deve ser usado apenas para inserções treinadas com o MRL (Matryoshka Representation Learning), como OpenAI text-embedding-3-large (pequeno). O valor padrão é nulo, o que significa que não há truncamento.

ScalarQuantizationParameters

Contém os parâmetros específicos para a Quantização Escalar.

Nome Tipo Description
quantizedDataType

VectorSearchCompressionTarget

O tipo de dados quantizados de valores vetoriais compactados.

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.

Valor Description
sum

Aumente as pontuações pela soma de todos os resultados da função de pontuação.

average

Aumente as pontuações pela média de todos os resultados da função de pontuação.

minimum

Aumente as pontuações pelo mínimo de todos os resultados da função de pontuação.

maximum

Aumente as pontuações no máximo de todos os resultados da função de pontuação.

firstMatching

Aumente as pontuações usando a primeira função de pontuação aplicável no perfil de pontuação.

product

Aumente as pontuações pelo produto de todos os resultados da função de pontuação.

ScoringFunctionInterpolation

Define a função usada para interpolar o aumento de pontuação em um intervalo de documentos.

Valor Description
linear

Aumenta as pontuações em uma quantidade linearmente decrescente. Essa é a interpolação padrão para funções de pontuação.

constant

Aumenta as pontuações por um fator constante.

quadratic

Aumenta as pontuações em um valor que diminui quadraticamente. Os reforços diminuem lentamente para pontuações mais altas e mais rapidamente à medida que as pontuações diminuem. Essa opção de interpolação não é permitida em funções de pontuação de tag.

logarithmic

Aumenta as pontuações em uma quantidade que diminui logaritmicamente. Os reforços diminuem rapidamente para pontuações mais altas e mais lentamente à medida que as pontuações diminuem. Essa opção de interpolação não é permitida em funções de pontuação de tag.

ScoringProfile

Define parâmetros para um índice de pesquisa que influenciam a pontuação em consultas de pesquisa.

Nome Tipo Description
functionAggregation

ScoringFunctionAggregation

Um valor que indica como os resultados das funções de pontuação individuais devem ser combinados. O padrão é "Soma". Ignorado se não houver funções de pontuação.

functions ScoringFunction[]:

A coleção de funções que influenciam a pontuação de documentos.

name

string

O nome do perfil de pontuação.

text

TextWeights

Parâmetros que aumentam a pontuação com base em correspondências de texto em determinados campos de índice.

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.

Nome Tipo Description
analyzer

LexicalAnalyzerName

O nome do analisador a ser usado para o campo. Essa opção pode ser usada apenas com campos pesquisáveis e não pode ser definida em conjunto com searchAnalyzer ou indexAnalyzer. Depois que o analisador for escolhido, ele não poderá ser alterado para o campo. Deve ser nulo para campos complexos.

dimensions

integer (int32)

minimum: 2
maximum: 4096

A dimensionalidade do campo de vetor.

facetable

boolean

Um valor que indica se o campo deve ser referenciado em consultas de faceta. Normalmente usado em uma apresentação de resultados de pesquisa que inclui contagem de ocorrências por categoria (por exemplo, pesquise câmeras digitais e veja ocorrências por marca, por megapixels, por preço e assim por diante). Essa propriedade deve ser nula para campos complexos. Campos do tipo Edm.GeographyPoint ou Collection(Edm.GeographyPoint) não podem ser facetas. O padrão é true para todos os outros campos simples.

fields

SearchField[]

Uma lista de subcampos se este for um campo do tipo Edm.ComplexType ou Collection(Edm.ComplexType). Deve ser nulo ou vazio para campos simples.

filterable

boolean

Um valor que indica se o campo deve ser referenciado em consultas $filter. filterable difere do pesquisável em como as cadeias de caracteres são tratadas. Os campos do tipo Edm.String ou Collection(Edm.String) que são filtrados não passam por quebra de palavras, portanto, as comparações são apenas para correspondências exatas. Por exemplo, se você definir esse campo f como "dia ensolarado", $filter=f eq 'sunny' não encontrará correspondências, mas $filter=f eq 'sunny day' irá. Essa propriedade deve ser nula para campos complexos. O padrão é true para campos simples e null para campos complexos.

indexAnalyzer

LexicalAnalyzerName

O nome do analisador usado no momento da indexação do campo. Essa opção só pode ser usada com campos pesquisáveis. Ele deve ser definido junto com searchAnalyzer e não pode ser definido junto com a opção analisador. Essa propriedade não pode ser definida como o nome de um analisador de idiomas; use a propriedade do analisador se precisar de um analisador de idiomas. Depois que o analisador for escolhido, ele não poderá ser alterado para o campo. Deve ser nulo para campos complexos.

key

boolean

Um valor que indica se o campo identifica exclusivamente documentos no índice. Exatamente um campo de nível superior em cada índice deve ser escolhido como o campo de chave e deve ser do tipo Edm.String. Os campos-chave podem ser usados para pesquisar documentos diretamente e atualizar ou excluir documentos específicos. O padrão é false para campos simples e null para campos complexos.

name

string

O nome do campo, que deve ser exclusivo na coleção de campos do índice ou do campo pai.

normalizer

LexicalNormalizerName

O nome do normalizador a ser usado para o campo. Essa opção pode ser usada somente com campos com filtrável, classificável ou facetável ativado. Uma vez escolhido o normalizador, ele não pode ser alterado para o campo. Deve ser nulo para campos complexos.

retrievable

boolean

Um valor que indica se o campo pode ser retornado em um resultado de pesquisa. Você poderá desabilitar essa opção se quiser usar um campo (por exemplo, margem) como um filtro, classificação ou mecanismo de pontuação, mas não quiser que o campo fique visível para o usuário final. Essa propriedade deve ser true para campos-chave e deve ser nula para campos complexos. Essa propriedade pode ser alterada em campos existentes. Habilitar essa propriedade não causa nenhum aumento nos requisitos de armazenamento de índice. O padrão é true para campos simples, false para campos vetoriais e null para campos complexos.

searchAnalyzer

LexicalAnalyzerName

O nome do analisador usado no tempo de pesquisa do campo. Essa opção só pode ser usada com campos pesquisáveis. Ele deve ser definido junto com indexAnalyzer e não pode ser definido junto com a opção analyzer. Essa propriedade não pode ser definida como o nome de um analisador de idiomas; use a propriedade do analisador se precisar de um analisador de idiomas. Esse analisador pode ser atualizado em um campo existente. Deve ser nulo para campos complexos.

searchable

boolean

Um valor que indica se o campo é pesquisável por texto completo. Isso significa que ele passará por análises como quebra de palavras durante a indexação. Se você definir um campo pesquisável para um valor como "dia ensolarado", internamente ele será dividido nos tokens individuais "ensolarado" e "dia". Isso permite pesquisas de texto completo para esses termos. Campos do tipo Edm.String ou Collection(Edm.String) são pesquisáveis por padrão. Essa propriedade deve ser false para campos simples de outros tipos de dados que não sejam de cadeia de caracteres e deve ser nula para campos complexos. Observação: os campos pesquisáveis consomem espaço extra em seu índice para acomodar versões tokenizadas adicionais do valor do campo para pesquisas de texto completo. Se você quiser economizar espaço em seu índice e não precisar que um campo seja incluído nas pesquisas, defina pesquisável como false.

sortable

boolean

Um valor que indica se o campo deve ser referenciado em expressões $orderby. Por padrão, o mecanismo de pesquisa classifica os resultados por pontuação, mas em muitas experiências os usuários desejarão classificar por campos nos documentos. Um campo simples só poderá ser classificado se for de valor único (ele tem um único valor no escopo do documento pai). Campos de coleção simples não podem ser classificados, pois são de vários valores. Sub-campos simples de coleções complexas também são de vários valores e, portanto, não podem ser classificados. Isso é verdade se é um campo pai imediato, ou um campo ancestral, que é a coleção complexa. Os campos complexos não podem ser classificáveis e a propriedade classificável deve ser nula para esses campos. O padrão para classificável é true para campos simples de valor único, false para campos simples de vários valores e null para campos complexos.

stored

boolean

Um valor imutável que indica se o campo será mantido separadamente no disco a ser retornado em um resultado de pesquisa. Você poderá desabilitar essa opção se não planeja retornar o conteúdo do campo em uma resposta de pesquisa para economizar na sobrecarga de armazenamento. Isso só pode ser definido durante a criação do índice e somente para campos de vetor. Essa propriedade não pode ser alterada para campos existentes ou definida como false para novos campos. Se essa propriedade for definida como false, a propriedade 'retrievable' também deverá ser definida como false. Essa propriedade deve ser verdadeira ou não configurada para campos de chave, para novos campos e para campos não vetoriais, e deve ser nula para campos complexos. Desabilitar essa propriedade reduzirá os requisitos de armazenamento de índice. O padrão é verdadeiro para campos de vetor.

synonymMaps

string[]

Uma lista dos nomes dos mapas de sinônimos a serem associados a esse campo. Essa opção só pode ser usada com campos pesquisáveis. Atualmente, há suporte para apenas um mapa de sinônimos por campo. Atribuir um mapa de sinônimos a um campo garante que os termos de consulta direcionados a esse campo sejam expandidos em tempo de consulta usando as regras no mapa de sinônimos. Esse atributo pode ser alterado em campos existentes. Deve ser nulo ou uma coleção vazia para campos complexos.

type

SearchFieldDataType

O tipo de dados do campo.

vectorEncoding

VectorEncodingFormat

O formato de codificação para interpretar o conteúdo do campo.

vectorSearchProfile

string

O nome do perfil de pesquisa de vetor que especifica o algoritmo e o vetor a ser usado ao pesquisar o campo de vetor.

SearchFieldDataType

Define o tipo de dados de um campo em um índice de pesquisa.

Valor Description
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 (true ou false).

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 com 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 com Collection(Edm.Half).

Edm.Int16

Indica que um campo contém um inteiro com sinal de 16 bits. Isso só é válido quando usado com Collection(Edm.Int16).

Edm.SByte

Indica que um campo contém um inteiro com sinal de 8 bits. Isso só é válido quando usado com Collection(Edm.SByte).

Edm.Byte

Indica que um campo contém um inteiro sem sinal de 8 bits. Isso só é válido quando usado com Collection(Edm.Byte).

SearchIndex

Representa uma definição de índice de pesquisa, que descreve os campos e o comportamento de pesquisa de um índice.

Nome Tipo Description
@odata.etag

string

A ETag do índice.

analyzers LexicalAnalyzer[]:

Os analisadores do índice.

charFilters CharFilter[]:

Os filtros de caractere para o índice.

corsOptions

CorsOptions

Opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para o índice.

defaultScoringProfile

string

O nome do perfil de pontuação a ser usado se nenhum for especificado na consulta. Se essa propriedade não estiver definida e nenhum perfil de pontuação for especificado na consulta, a pontuação padrão (tf-idf) será usada.

description

string

A descrição do índice.

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para seus dados quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografar seus dados. Depois de criptografar seus dados, eles sempre permanecerão criptografados. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Seus dados não serão afetados. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.

fields

SearchField[]

Os campos do índice.

name

string

O nome do índice.

normalizers LexicalNormalizer[]:

CustomNormalizer[]

Os normalizadores do índice.

scoringProfiles

ScoringProfile[]

Os perfis de pontuação do índice.

semantic

SemanticSearch

Define parâmetros para um índice de pesquisa que influenciam as funcionalidades semânticas.

similarity SimilarityAlgorithm:

O tipo de algoritmo de similaridade a ser usado ao pontuar e classificar os documentos correspondentes a uma consulta de pesquisa. O algoritmo de similaridade só pode ser definido no momento da criação do índice e não pode ser modificado em índices existentes. Se nulo, o algoritmo ClassicSimilarity será usado.

suggesters

SearchSuggester[]

Os sugestores para o índice.

tokenFilters TokenFilter[]:

Os filtros de token para o índice.

tokenizers LexicalTokenizer[]:

Os tokenizadores do índice.

vectorSearch

VectorSearch

Contém opções de configuração relacionadas à pesquisa de vetor.

SearchIndexerDataNoneIdentity

Limpa a propriedade de identidade de uma fonte de dados.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Um fragmento de URI especificando o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

Especifica a identidade de uma fonte de dados a ser usada.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Um fragmento de URI especificando o tipo de identidade.

userAssignedIdentity

string

A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída pelo usuário normalmente no formato "/subscriptions/12345678-1234-1234-12334-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa.

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, como índices e mapas de sinônimos.

Nome Tipo Description
accessCredentials.applicationId

string

Uma ID de aplicativo do AAD que recebeu as permissões de acesso necessárias para o Azure Key Vault que deve ser usada ao criptografar seus dados em repouso. A ID do aplicativo não deve ser confundida com a ID do objeto para seu aplicativo do AAD.

accessCredentials.applicationSecret

string

A chave de autenticação do aplicativo AAD especificado.

identity SearchIndexerDataIdentity:

Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída pelo sistema será usada. Ao atualizar para o recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "nenhum" for especificado, o valor dessa propriedade será limpo.

keyVaultKeyName

string

O nome da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.

keyVaultKeyVersion

string

A versão da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.

keyVaultUri

string

O URI do Azure Key Vault, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um URI de exemplo pode ser https://my-keyvault-name.vault.azure.net.

SearchSuggester

Define como a API de Sugestão deve se aplicar a um grupo de campos no índice.

Nome Tipo Description
name

string

O nome do sugestor.

searchMode enum:

analyzingInfixMatching

Um valor que indica os recursos do sugestor.

sourceFields

string[]

A lista de nomes de campo aos quais o sugestor se aplica. Cada campo deve ser pesquisável.

SemanticConfiguration

Define uma configuração específica a ser usada no contexto de funcionalidades semânticas.

Nome Tipo Description
name

string

O nome da configuração semântica.

prioritizedFields

SemanticPrioritizedFields

Descreve os campos de título, conteúdo e palavra-chave a serem usados para classificação semântica, legendas, realces e respostas. Pelo menos uma das três sub propriedades (titleField, prioritizedKeywordsFields e prioritizedContentFields) precisa ser definida.

rankingOrder

RankingOrder

Especifica o tipo de pontuação a ser usado para a ordem de classificação dos resultados da pesquisa.

SemanticField

Um campo usado como parte da configuração semântica.

Nome Tipo Description
fieldName

string

Nome do arquivo

SemanticPrioritizedFields

Descreve os campos de título, conteúdo e palavras-chave a serem usados para classificação semântica, legendas, realces e respostas.

Nome Tipo Description
prioritizedContentFields

SemanticField[]

Define os campos de conteúdo a serem usados para classificação semântica, legendas, realces e respostas. Para obter o melhor resultado, os campos selecionados devem conter texto em linguagem natural. A ordem dos campos na matriz representa sua prioridade. Os campos com prioridade mais baixa podem ficar truncados se o conteúdo for longo.

prioritizedKeywordsFields

SemanticField[]

Define os campos de palavra-chave a serem usados para classificação semântica, legendas, realces e respostas. Para obter o melhor resultado, os campos selecionados devem conter uma lista de palavras-chave. A ordem dos campos na matriz representa sua prioridade. Os campos com prioridade mais baixa podem ficar truncados se o conteúdo for longo.

titleField

SemanticField

Define o campo de título a ser usado para classificação semântica, legendas, realces e respostas. Se você não tiver um campo de título no índice, deixe em branco.

SemanticSearch

Define parâmetros para um índice de pesquisa que influenciam as funcionalidades semânticas.

Nome Tipo Description
configurations

SemanticConfiguration[]

As configurações semânticas do índice.

defaultConfiguration

string

Permite definir o nome de uma configuração semântica padrão em seu índice, tornando opcional passá-lo como um parâmetro de consulta todas as vezes.

ShingleTokenFilter

Cria combinações de tokens como um único token. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.ShingleTokenFilter

O discriminador para tipos derivados.

filterToken

string

_

A cadeia de caracteres a ser inserida para cada posição na qual não há nenhum token. O padrão é um sublinhado ("_").

maxShingleSize

integer (int32)

minimum: 2
2

O tamanho máximo da telha. O valor padrão e mínimo é 2.

minShingleSize

integer (int32)

minimum: 2
2

O tamanho mínimo da telha. O valor padrão e mínimo é 2. Deve ser menor que o valor de maxShingleSize.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

outputUnigrams

boolean

True

Um valor que indica se o fluxo de saída conterá os tokens de entrada (unigramas), bem como as telhas. O padrão é true.

outputUnigramsIfNoShingles

boolean

False

Um valor que indica se os unigramas devem ser gerados para aqueles momentos em que nenhuma telha está disponível. Essa propriedade tem precedência quando outputUnigrams é definido como false. O padrão é false.

tokenSeparator

string

A cadeia de caracteres a ser usada ao unir tokens adjacentes para formar uma telha. O padrão é um único espaço (" ").

SnowballTokenFilter

Um filtro que resulta em palavras usando um lematizador gerado por Bola de Neve. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.SnowballTokenFilter

O discriminador para tipos derivados.

language

SnowballTokenFilterLanguage

O idioma a ser usado.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

SnowballTokenFilterLanguage

O idioma a ser usado para um filtro de token do Snowball.

Valor Description
armenian

Seleciona o tokenizador de lematização Lucene Snowball para armênio.

basque

Seleciona o tokenizador de lematização Lucene Snowball para basco.

catalan

Seleciona o tokenizador de lematização Lucene Snowball para catalão.

danish

Seleciona o tokenizador de lematização Lucene Snowball para dinamarquês.

dutch

Seleciona o tokenizador de lematização Lucene Snowball para holandês.

english

Seleciona o tokenizador de lematização Lucene Snowball para inglês.

finnish

Seleciona o tokenizador de lematização Lucene Snowball para finlandês.

french

Seleciona o tokenizador de lematização Lucene Snowball para francês.

german

Seleciona o tokenizador de lematização Lucene Snowball para alemão.

german2

Seleciona o tokenizador de lematização Lucene Snowball que usa o algoritmo de variante alemão.

hungarian

Seleciona o tokenizador de lematização Lucene Snowball para húngaro.

italian

Seleciona o tokenizador de lematização Lucene Snowball para italiano.

kp

Seleciona o tokenizador de lematização Lucene Snowball para holandês que usa o algoritmo de lematização Kraaij-Pohlmann.

lovins

Seleciona o tokenizador de lematização Lucene Snowball para inglês que usa o algoritmo de lematização de Lovins.

norwegian

Seleciona o tokenizador de lematização Lucene Snowball para norueguês.

porter

Seleciona o tokenizador de lematização Lucene Snowball para inglês que usa o algoritmo de lematização de Porter.

portuguese

Seleciona o tokenizador de lematização Lucene Snowball para português.

romanian

Seleciona o tokenizador de lematização Lucene Snowball para romeno.

russian

Seleciona o tokenizador de lematização Lucene Snowball para russo.

spanish

Seleciona o tokenizador de lematização Lucene Snowball para espanhol.

swedish

Seleciona o tokenizador de lematização Lucene Snowball para sueco.

turkish

Seleciona o tokenizador de lematização Lucene Snowball para turco.

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 lematizaçã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

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.StemmerOverrideTokenFilter

O discriminador para tipos derivados.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

rules

string[]

Uma lista de regras de contenção no seguinte formato: "word => stem", por exemplo: "ran => run".

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

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.StemmerTokenFilter

O discriminador para tipos derivados.

language

StemmerTokenFilterLanguage

O idioma a ser usado.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

StemmerTokenFilterLanguage

O idioma a ser usado para um filtro de token de lematizador.

Valor Description
arabic

Seleciona o tokenizador de lematização Lucene para árabe.

armenian

Seleciona o tokenizador de lematização Lucene para armênio.

basque

Seleciona o tokenizer de derivação Lucene para basco.

brazilian

Seleciona o tokenizador de derivação Lucene para português (Brasil).

bulgarian

Seleciona o tokenizador de lematização Lucene para búlgaro.

catalan

Seleciona o tokenizador de lematização Lucene para catalão.

czech

Seleciona o tokenizer de lematização Lucene para tcheco.

danish

Seleciona o tokenizador de lematização Lucene para dinamarquês.

dutch

Seleciona o tokenizador de lematização Lucene para holandês.

dutchKp

Seleciona o tokenizador de lematização Lucene para holandês que usa o algoritmo de lematização Kraaij-Pohlmann.

english

Seleciona o tokenizador de lematização Lucene para inglês.

lightEnglish

Seleciona o tokenizer de lematização Lucene para inglês que faz lematização leve.

minimalEnglish

Seleciona o tokenizador de lematização Lucene para inglês que faz a lematização mínima.

possessiveEnglish

Seleciona o tokenizador de derivação Lucene para inglês que remove possessivos à direita das palavras.

porter2

Seleciona o tokenizador de lematização Lucene para inglês que usa o algoritmo de lematização Porter2.

lovins

Seleciona o tokenizador de lematização Lucene para inglês que usa o algoritmo de lematização de Lovins.

finnish

Seleciona o tokenizador de derivação Lucene para finlandês.

lightFinnish

Seleciona o tokenizador de lematização Lucene para finlandês que faz lematização leve.

french

Seleciona o tokenizador de lematização Lucene para francês.

lightFrench

Seleciona o tokenizer de lematização Lucene para francês que faz lematização leve.

minimalFrench

Seleciona o tokenizador de lematização Lucene para francês que faz a lematização mínima.

galician

Seleciona o tokenizador de lematização Lucene para galego.

minimalGalician

Seleciona o tokenizador de lematização Lucene para galego que faz a lematização mínima.

german

Seleciona o tokenizador de lematização Lucene para alemão.

german2

Seleciona o tokenizador de lematização Lucene que usa o algoritmo de variante alemão.

lightGerman

Seleciona o tokenizador de lematização Lucene para alemão que faz lematização leve.

minimalGerman

Seleciona o tokenizador de lematização Lucene para alemão que faz lematização mínima.

greek

Seleciona o tokenizador de lematização Lucene para grego.

hindi

Seleciona o tokenizador de lematização Lucene para hindi.

hungarian

Seleciona o tokenizador de lematização Lucene para húngaro.

lightHungarian

Seleciona o tokenizer de derivação Lucene para húngaro que faz a derivação leve.

indonesian

Seleciona o tokenizador de lematização Lucene para indonésio.

irish

Seleciona o tokenizador de derivação Lucene para irlandês.

italian

Seleciona o tokenizador de lematização Lucene para italiano.

lightItalian

Seleciona o tokenizador de lematização Lucene para italiano que faz lematização leve.

sorani

Seleciona o tokenizador de lematização Lucene para Sorani.

latvian

Seleciona o tokenizer de lematização Lucene para letão.

norwegian

Seleciona o tokenizador de stemming Lucene para norueguês (Bokmål).

lightNorwegian

Seleciona o tokenizador de stemming Lucene para norueguês (Bokmål) que faz light stemming.

minimalNorwegian

Seleciona o tokenizador de stemming Lucene para norueguês (Bokmål) que faz stemming mínimo.

lightNynorsk

Seleciona o tokenizer de lematização Lucene para norueguês (Nynorsk) que faz lematização leve.

minimalNynorsk

Seleciona o tokenizador de lematização Lucene para norueguês (Nynorsk) que faz a lematização mínima.

portuguese

Seleciona o tokenizador de lematização Lucene para português.

lightPortuguese

Seleciona o tokenizer de lematização Lucene para português que faz lematização leve.

minimalPortuguese

Seleciona o tokenizador de lematização Lucene para português que faz a lematização mínima.

portugueseRslp

Seleciona o tokenizador de lematização Lucene para português que usa o algoritmo de lematização RSLP.

romanian

Seleciona o tokenizador de lematização Lucene para romeno.

russian

Seleciona o tokenizador de derivação Lucene para russo.

lightRussian

Seleciona o tokenizador de derivação Lucene para russo que faz lematização leve.

spanish

Seleciona o tokenizador de lematização Lucene para espanhol.

lightSpanish

Seleciona o tokenizador de lematização Lucene para espanhol que faz lematização leve.

swedish

Seleciona o tokenizador de derivação Lucene para sueco.

lightSwedish

Seleciona o tokenizador de lematização Lucene para sueco que faz lematização leve.

turkish

Seleciona o tokenizer de lematização Lucene para turco.

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.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.StopAnalyzer

O discriminador para tipos derivados.

name

string

O nome do analisador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

stopwords

string[]

Uma lista de palavras irrelevantes.

StopwordsList

Identifica uma lista predefinida de palavras irrelevantes específicas do idioma.

Valor Description
arabic

Seleciona a lista de palavras irrelevantes para árabe.

armenian

Seleciona a lista de palavras irrelevantes para armênio.

basque

Seleciona a lista de palavras irrelevantes para basco.

brazilian

Seleciona a lista de palavras irrelevantes para Português (Brasil).

bulgarian

Seleciona a lista de palavras irrelevantes para búlgaro.

catalan

Seleciona a lista de palavras irrelevantes para catalão.

czech

Seleciona a lista de palavras irrelevantes para tcheco.

danish

Seleciona a lista de palavras irrelevantes para dinamarquês.

dutch

Seleciona a lista de palavras irrelevantes para holandês.

english

Seleciona a lista de palavras irrelevantes para inglês.

finnish

Seleciona a lista de palavras irrelevantes para finlandês.

french

Seleciona a lista de palavras irrelevantes para francês.

galician

Seleciona a lista de palavras irrelevantes para galego.

german

Seleciona a lista de palavras irrelevantes para alemão.

greek

Seleciona a lista de palavras irrelevantes para grego.

hindi

Seleciona a lista de palavras irrelevantes para hindi.

hungarian

Seleciona a lista de palavras irrelevantes para húngaro.

indonesian

Seleciona a lista de palavras irrelevantes para indonésio.

irish

Seleciona a lista de palavras irrelevantes para irlandês.

italian

Seleciona a lista de palavras irrelevantes para italiano.

latvian

Seleciona a lista de palavras irrelevantes para letão.

norwegian

Seleciona a lista de palavras irrelevantes para norueguês.

persian

Seleciona a lista de palavras irrelevantes para persa.

portuguese

Seleciona a lista de palavras irrelevantes para o português.

romanian

Seleciona a lista de palavras irrelevantes para romeno.

russian

Seleciona a lista de palavras irrelevantes para russo.

sorani

Seleciona a lista de palavras irrelevantes para Sorani.

spanish

Seleciona a lista de palavras irrelevantes para espanhol.

swedish

Seleciona a lista de palavras irrelevantes para sueco.

thai

Seleciona a lista de palavras irrelevantes para tailandês.

turkish

Seleciona a lista de palavras irrelevantes para turco.

StopwordsTokenFilter

Remove palavras irrelevantes de um fluxo de tokens. 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

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.StopwordsTokenFilter

O discriminador para tipos derivados.

ignoreCase

boolean

False

Um valor que indica se deve ignorar maiúsculas e minúsculas. Se for true, todas as palavras serão convertidas em letras minúsculas primeiro. O padrão é false.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

removeTrailing

boolean

True

Um valor que indica se o último termo de pesquisa deve ser ignorado se for uma palavra irrelevante. O padrão é true.

stopwords

string[]

A lista de palavras irrelevantes. Essa propriedade e a propriedade de lista de palavras irrelevantes não podem ser definidas.

stopwordsList

StopwordsList

english

Uma lista predefinida de palavras irrelevantes a serem usadas. Essa propriedade e a propriedade stopwords não podem ser definidas. O padrão é inglês.

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.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.SynonymTokenFilter

O discriminador para tipos derivados.

expand

boolean

True

Um valor que indica se todas as palavras na lista de sinônimos (se => notação não for usada) serão mapeadas umas para as outras. Se for true, todas as palavras na lista de sinônimos (se => notação não for usada) serão mapeadas umas para as outras. A seguinte lista: incrível, inacreditável, fabuloso, incrível é equivalente a: incrível, inacreditável, fabuloso, incrível => incrível, inacreditável, fabuloso, incrível. Se false, a seguinte lista: incrível, inacreditável, fabuloso, incrível será equivalente a: incrível, inacreditável, fabuloso, incrível => incrível. O padrão é true.

ignoreCase

boolean

False

Um valor que indica se a entrada de dobra de maiúsculas e minúsculas deve ser dobrada para correspondência. O padrão é false.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

synonyms

string[]

Uma lista de sinônimos no seguinte um dos dois formatos: 1. incrível, inacreditável, fabuloso => incrível - todos os termos no lado esquerdo de => símbolo serão substituídos por todos os termos no lado direito; 2. incrível, inacreditável, fabuloso, incrível - lista separada por vírgulas de palavras equivalentes. Defina a opção de expansão para alterar como essa lista é interpretada.

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.

Nome Tipo Description
boost

number (double)

Um multiplicador para a pontuação bruta. Deve ser um número positivo não igual a 1,0.

fieldName

string

O nome do campo usado como entrada para a função de pontuação.

interpolation

ScoringFunctionInterpolation

Um valor que indica como o aumento será interpolado entre as pontuações do documento; o padrão é "Linear".

tag

TagScoringParameters

Valores de parâmetro para a função de pontuação de marca.

type string:

tag

Tipo de Função de Pontuação.

TagScoringParameters

Fornece valores de parâmetro para uma função de pontuação de marca.

Nome Tipo Description
tagsParameter

string

O nome do parâmetro passado em consultas de pesquisa para especificar a lista de tags a serem comparadas com o campo de destino.

TextWeights

Define os pesos nos campos de índice para os quais as correspondências devem aumentar a pontuação em consultas de pesquisa.

Nome Tipo Description
weights

object

O dicionário de pesos por campo para aumentar a pontuação do documento. As chaves são nomes de campo e os valores são os pesos de cada campo.

TokenCharacterKind

Representa classes de caracteres nas quais um filtro de token pode operar.

Valor Description
letter

Mantém as letras em fichas.

digit

Mantém dígitos em tokens.

whitespace

Mantém o espaço em branco em tokens.

punctuation

Mantém a pontuação em tokens.

symbol

Mantém os símbolos em tokens.

TokenFilterName

Define os nomes de todos os filtros de token suportados pelo mecanismo de pesquisa.

Valor Description
arabic_normalization

Um filtro de token que aplica o normalizador em árabe para normalizar a ortografia. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html

apostrophe

Remove todos os caracteres após um apóstrofo (incluindo o próprio apóstrofo). Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html

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

cjk_bigram

Forma bigrams de termos CJK gerados a partir do tokenizador padrão. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html

cjk_width

Normaliza as diferenças de largura CJK. Dobra variantes ASCII de largura total no equivalente latim básico, e variantes Katakana de meia largura no Kana equivalente. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html

classic

Remove possessivos em inglês e de acrônimos. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html

common_grams

Construa bigramas para termos que ocorrem com frequência durante a indexação. Termos únicos ainda são indexados também, com bigramas sobrepostos. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html

edgeNGram_v2

Gera n-gramas dos tamanhos fornecidos a partir da frente ou da parte traseira de um token de entrada. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html

elision

Remove elisões. Por exemplo, "l'avion" (o plano) será convertido em "avion" (plano). Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html

german_normalization

Normaliza os caracteres alemães de acordo com a heurística do algoritmo de bola de neve alemão2. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html

hindi_normalization

Normaliza o texto em hindi para remover algumas diferenças nas variações ortográficas. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html

indic_normalization

Normaliza a representação Unicode do texto nos idiomas indianos. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html

keyword_repeat

Emite cada token de entrada duas vezes, uma como palavra-chave e uma vez como palavra-chave. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html

kstem

Um filtro kstem de alto desempenho para inglês. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html

length

Remove palavras muito longas ou muito curtas. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html

limit

Limita o número de tokens durante a indexação. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html

lowercase

Normaliza o texto do token para letras minúsculas. Consulte https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html

nGram_v2

Gera n-gramas dos tamanhos determinados. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html

persian_normalization

Aplica a normalização para o persa. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html

phonetic

Crie tokens para correspondências fonéticas. Consulte https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html

porter_stem

Usa o algoritmo porter para transformar o fluxo de token. Consulte http://tartarus.org/~martin/PorterStemmer

reverse

Inverte a cadeia de caracteres do token. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html

scandinavian_normalization

Normaliza o uso de caracteres escandinavos intercambiáveis. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html

scandinavian_folding

Dobra caracteres escandinavos Ã¥ã... ã¤Ã¦Ã"Æ-a> e öÖà ̧à ̃-o>. Também discrimina o uso de vogais duplas aa, ae, ao, oe e oo, deixando apenas a primeira. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html

shingle

Cria combinações de tokens como um único token. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html

snowball

Um filtro que resulta em palavras usando um lematizador gerado por Bola de Neve. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html

sorani_normalization

Normaliza a representação Unicode do texto Sorani. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html

stemmer

Filtro de lematização específico da linguagem. Consulte https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters

stopwords

Remove palavras irrelevantes de um fluxo de tokens. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html

trim

Corta o espaço em branco à esquerda e à direita de uma cadeia de tokens. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html

truncate

Trunca os termos para um comprimento específico. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html

unique

Filtra os tokens com o mesmo texto como o token anterior. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html

uppercase

Normaliza o texto do token para letras maiúsculas. Consulte https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html

word_delimiter

Divide as palavras em subpalavras e realiza transformações opcionais em grupos de subpalavras.

TruncateTokenFilter

Trunca os termos para um comprimento específico. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.TruncateTokenFilter

O discriminador para tipos derivados.

length

integer (int32)

maximum: 300
300

O comprimento em que os termos serão truncados. O padrão e o máximo é 300.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

UaxUrlEmailTokenizer

Tokeniza URLs e e-mails como um único token. Esse tokenizador é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.UaxUrlEmailTokenizer

O discriminador para tipos derivados.

maxTokenLength

integer (int32)

maximum: 300
255

O comprimento máximo do token. O padrão é 255. Tokens mais longos do que o comprimento máximo são divididos. O comprimento máximo do token que pode ser usado é de 300 caracteres.

name

string

O nome do tokenizador. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

UniqueTokenFilter

Filtra os tokens com o mesmo texto como o token anterior. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.UniqueTokenFilter

O discriminador para tipos derivados.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

onlyOnSamePosition

boolean

False

Um valor que indica se as duplicatas devem ser removidas apenas na mesma posição. O padrão é false.

VectorEncodingFormat

O formato de codificação para interpretar o conteúdo do campo vetorial.

Valor Description
packedBit

Formato de codificação que representa bits empacotados em um tipo de dados mais amplo.

VectorSearch

Contém opções de configuração relacionadas à pesquisa de vetor.

Nome Tipo Description
algorithms VectorSearchAlgorithmConfiguration[]:

Contém opções de configuração específicas para o algoritmo usado durante a indexação ou consulta.

compressions VectorSearchCompression[]:

Contém opções de configuração específicas para o método de compactação usado durante a indexação ou consulta.

profiles

VectorSearchProfile[]

Define combinações de configurações a serem usadas com a pesquisa de vetor.

vectorizers VectorSearchVectorizer[]:

Contém opções de configuração sobre como vetorizar consultas de vetor de texto.

VectorSearchAlgorithmKind

O algoritmo usado para indexação e consulta.

Valor Description
hnsw

HNSW (Mundo Pequeno Navegável Hierárquico), um tipo de algoritmo aproximado de vizinhos mais próximos.

exhaustiveKnn

Algoritmo KNN exaustivo que executará a pesquisa de força bruta.

VectorSearchAlgorithmMetric

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.

Valor Description
cosine

Mede o ângulo entre vetores para quantificar sua similaridade, desconsiderando a magnitude. Quanto menor o ângulo, mais próxima a semelhança.

euclidean

Calcula a distância de linha reta entre vetores em um espaço multidimensional. Quanto menor a distância, mais próxima a similaridade.

dotProduct

Calcula a soma de produtos em termos de elemento para medir o alinhamento e a similaridade de magnitude. Quanto maior e mais positiva, mais próxima a semelhança.

hamming

Aplicável somente a tipos de dados binários com bits. Determina a diferenciação contando posições diferentes em vetores binários. Quanto menos diferenças, mais próxima a semelhança.

VectorSearchCompressionKind

O método de compactação usado para indexação e consulta.

Valor Description
scalarQuantization

Quantização 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.

binaryQuantization

Quantização Binária, um tipo de método de compactação. Na quantização binária, os valores de vetores originais são compactados para o tipo binário mais estreito discretizando e representando cada componente de um vetor usando valores binários, reduzindo assim o tamanho geral dos dados.

VectorSearchCompressionTarget

O tipo de dados quantizados de valores vetoriais compactados.

Valor Description
int8

Inteiro com sinal de 8 bits.

VectorSearchProfile

Define uma combinação de configurações a serem usadas com a pesquisa de vetor.

Nome Tipo Description
algorithm

string

O nome da configuração do algoritmo de pesquisa vetorial que especifica o algoritmo e os parâmetros opcionais.

compression

string

O nome da configuração do método de compactação que especifica o método de compactação e os parâmetros opcionais.

name

string

O nome a ser associado a esse perfil de pesquisa vetorial específico.

vectorizer

string

O nome da vetorização que está sendo configurada para uso com a pesquisa vetorial.

VectorSearchVectorizerKind

O método de vetorização a ser usado durante o tempo de consulta.

Valor Description
azureOpenAI

Gere inserções usando um recurso do Azure OpenAI no momento da consulta.

customWebApi

Gere inserções usando um ponto de extremidade da Web personalizado no momento da consulta.

aiServicesVision

Gere inserções para uma entrada de imagem ou texto no momento da consulta usando a API de Vetorização da Visão dos Serviços de IA do Azure.

aml

Gere inserções usando um ponto de extremidade do Azure Machine Learning implantado por meio do Catálogo de Modelos do Fábrica de IA do Azure no momento da consulta.

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.

Nome Tipo Description
customWebApiParameters

WebApiVectorizerParameters

Especifica as propriedades do vetorizador definido pelo usuário.

kind string:

customWebApi

Tipo de VetorizadorBusca.

name

string

O nome a ser associado a esse método de vetorização específico.

WebApiVectorizerParameters

Especifica as propriedades para se conectar a um vetor definido pelo usuário.

Nome Tipo Description
authIdentity SearchIndexerDataIdentity:

A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída pelo sistema será usada. Em atualizações para o indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo.

authResourceId

string

Aplica-se a endpoints personalizados que se conectam a código externo em uma função do Azure ou em algum outro aplicativo que forneça as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ela foi registrada no Azure Active Directory. Quando especificada, a vetorização se conecta à função ou ao aplicativo usando uma ID gerenciada (atribuída pelo sistema ou pelo usuário) do serviço de pesquisa e o token de acesso da função ou do aplicativo, usando esse valor como a ID do recurso para criar o escopo do token de acesso.

httpHeaders

object

Os cabeçalhos necessários para fazer a solicitação HTTP.

httpMethod

string

O método para a solicitação HTTP.

timeout

string (duration)

O tempo limite desejado para a solicitação. O padrão é 30 segundos.

uri

string (uri)

O URI da API Web que fornece o vetorizador.

WordDelimiterTokenFilter

Divide as palavras em subpalavras e realiza transformações opcionais em grupos de subpalavras. Esse filtro de token é implementado usando o Apache Lucene.

Nome Tipo Valor padrão Description
@odata.type string:

#Microsoft.Azure.Search.WordDelimiterTokenFilter

O discriminador para tipos derivados.

catenateAll

boolean

False

Um valor que indica se todas as partes da sub palavra serão categorizadas. Por exemplo, se isso for definido como true, "Azure-Search-1" se tornará "AzureSearch1". O padrão é false.

catenateNumbers

boolean

False

Um valor que indica se as execuções máximas de partes numéricas serão categorizadas. Por exemplo, se isso for definido como true, "1-2" se tornará "12". O padrão é false.

catenateWords

boolean

False

Um valor que indica se as execuções máximas de partes de palavra serão categorizadas. Por exemplo, se isso for definido como true, "Azure-Search" se tornará "AzureSearch". O padrão é false.

generateNumberParts

boolean

True

Um valor que indica se as sub palavras numéricas devem ser geradas. O padrão é true.

generateWordParts

boolean

True

Um valor que indica se as palavras de parte devem ser geradas. Se definido, faz com que partes de palavras sejam geradas; por exemplo, "AzureSearch" torna-se "Azure" "Search". O padrão é true.

name

string

O nome do filtro de token. Ele deve conter apenas letras, dígitos, espaços, traços ou sublinhados, só pode iniciar e terminar com caracteres alfanuméricos e é limitado a 128 caracteres.

preserveOriginal

boolean

False

Um valor que indica se as palavras originais serão preservadas e adicionadas à lista de sub palavras. O padrão é false.

protectedWords

string[]

Uma lista de tokens a serem protegidos contra serem delimitados.

splitOnCaseChange

boolean

True

Um valor que indica se as palavras devem ser divididas em caseChange. Por exemplo, se isso for definido como true, "AzureSearch" se tornará "Azure" "Search". O padrão é true.

splitOnNumerics

boolean

True

Um valor que indica se os números devem ser divididos. Por exemplo, se isso for definido como true, "Azure1Search" se tornará "Azure" "1" "Search". O padrão é true.

stemEnglishPossessive

boolean

True

Um valor que indica se é necessário remover "'s" à direita para cada sub palavra. O padrão é true.