@azure/search-documents/dist/react-native/serviceUtils.d.ts

Azure client library to use AI Search for node.js and browser.

import type { SearchResult as GeneratedSearchResult, SuggestDocumentsResult as GeneratedSuggestDocumentsResult, IndexAction, IndexActionType, FacetResult as GeneratedFacetResult, QueryAnswerResult as GeneratedQueryAnswerResult, QueryCaptionResult as GeneratedQueryCaptionResult } from "./models/azure/search/documents/index.js";
import type { CognitiveServicesAccountUnion, DataChangeDetectionPolicyUnion, DataDeletionDetectionPolicyUnion, KnowledgeBase as GeneratedKnowledgeBase, KnowledgeSourceUnion as GeneratedKnowledgeSource, SearchField as GeneratedSearchField, SearchIndex as GeneratedSearchIndex, SearchIndexer as GeneratedSearchIndexer, SearchIndexerDataSourceConnection as GeneratedSearchIndexerDataSourceConnection, SearchIndexerSkillset as GeneratedSearchIndexerSkillset, SynonymMap as GeneratedSynonymMap, VectorSearch as GeneratedVectorSearch, VectorSearchAlgorithmConfigurationUnion as GeneratedVectorSearchAlgorithmConfiguration, VectorSearchVectorizerUnion as GeneratedVectorSearchVectorizer, SearchIndexerDataIdentityUnion, SearchIndexerSkillUnion, SimilarityAlgorithmUnion as SimilarityUnion, TokenFilterUnion } from "./models/azure/search/documents/indexes/index.js";
import type { SearchResult, SelectFields, SuggestDocumentsResult } from "./indexModels.js";
import type { KnowledgeBase } from "./knowledgeBaseModels.js";
import type { CognitiveServicesAccount, DataChangeDetectionPolicy, DataDeletionDetectionPolicy, FacetResult, KnowledgeSource, KnowledgeSourceVectorizer, QueryAnswerResult, QueryCaptionResult, SearchField, SearchIndex, SearchIndexer, SearchIndexerDataIdentity, SearchIndexerDataSourceConnection, SearchIndexerSkill, SearchIndexerSkillset, SimilarityAlgorithm, SynonymMap, TokenFilter, VectorSearch, VectorSearchAlgorithmConfiguration, VectorSearchVectorizer } from "./serviceModels.js";
import type { PagedAsyncIterableIterator } from "./static-helpers/pagingHelpers.js";
export declare const defaultServiceVersion = "2026-04-01";
export declare function convertSkillsToPublic(skills: SearchIndexerSkillUnion[]): SearchIndexerSkill[];
export declare function convertCognitiveServicesAccountToGenerated(cognitiveServicesAccount?: CognitiveServicesAccount): CognitiveServicesAccountUnion | undefined;
export declare function convertCognitiveServicesAccountToPublic(cognitiveServicesAccount?: CognitiveServicesAccountUnion): CognitiveServicesAccount | undefined;
export declare function convertTokenFiltersToGenerated(tokenFilters?: TokenFilter[]): TokenFilterUnion[] | undefined;
export declare function convertFieldsToPublic(fields?: GeneratedSearchField[]): SearchField[] | undefined;
export declare function convertFieldsToGenerated(fields: SearchField[] | undefined): GeneratedSearchField[] | undefined;
export declare function convertSimilarityToGenerated(similarity?: SimilarityAlgorithm): SimilarityUnion | undefined;
export declare function convertSimilarityToPublic(similarity?: SimilarityUnion): SimilarityAlgorithm | undefined;
export declare function generatedIndexToPublicIndex(generatedIndex: GeneratedSearchIndex): SearchIndex;
export declare function generatedVectorSearchVectorizerToPublicVectorizer(): undefined;
export declare function generatedVectorSearchVectorizerToPublicVectorizer(generatedVectorizer: GeneratedVectorSearchVectorizer): VectorSearchVectorizer;
export declare function generatedKnowledgeSourceVectorizerToPublicVectorizer(): undefined;
export declare function generatedKnowledgeSourceVectorizerToPublicVectorizer(generatedVectorizer: any): KnowledgeSourceVectorizer;
export declare function generatedVectorSearchAlgorithmConfigurationToPublicVectorSearchAlgorithmConfiguration(): undefined;
export declare function generatedVectorSearchAlgorithmConfigurationToPublicVectorSearchAlgorithmConfiguration(generatedAlgorithmConfiguration: GeneratedVectorSearchAlgorithmConfiguration): VectorSearchAlgorithmConfiguration;
export declare function generatedVectorSearchToPublicVectorSearch(vectorSearch?: GeneratedVectorSearch): VectorSearch | undefined;
export declare function generatedSearchResultToPublicSearchResult<TModel extends object, TFields extends SelectFields<TModel>>(results: GeneratedSearchResult[]): SearchResult<TModel, TFields>[];
export declare function generatedSuggestDocumentsResultToPublicSuggestDocumentsResult<TModel extends object, TFields extends SelectFields<TModel>>(searchDocumentsResult: GeneratedSuggestDocumentsResult): SuggestDocumentsResult<TModel, TFields>;
export declare function publicIndexToGeneratedIndex(index: SearchIndex): GeneratedSearchIndex;
export declare function generatedSkillsetToPublicSkillset(generatedSkillset: GeneratedSearchIndexerSkillset): SearchIndexerSkillset;
export declare function publicSkillsetToGeneratedSkillset(skillset: SearchIndexerSkillset): GeneratedSearchIndexerSkillset;
export declare function generatedSynonymMapToPublicSynonymMap(synonymMap: GeneratedSynonymMap): SynonymMap;
export declare function publicSynonymMapToGeneratedSynonymMap(synonymMap: SynonymMap): GeneratedSynonymMap;
export declare function publicSearchIndexerToGeneratedSearchIndexer(indexer: SearchIndexer): GeneratedSearchIndexer;
export declare function generatedSearchIndexerToPublicSearchIndexer(indexer: GeneratedSearchIndexer): SearchIndexer;
export declare function publicDataSourceToGeneratedDataSource(dataSource: SearchIndexerDataSourceConnection): GeneratedSearchIndexerDataSourceConnection;
export declare function generatedDataSourceToPublicDataSource(dataSource: GeneratedSearchIndexerDataSourceConnection): SearchIndexerDataSourceConnection;
export declare function convertSearchIndexerDataIdentityToPublic(searchIndexerDataIdentity?: SearchIndexerDataIdentityUnion): SearchIndexerDataIdentity | undefined;
export declare function convertDataChangeDetectionPolicyToPublic(dataChangeDetectionPolicy?: DataChangeDetectionPolicyUnion): DataChangeDetectionPolicy | undefined;
export declare function convertDataDeletionDetectionPolicyToPublic(dataDeletionDetectionPolicy?: DataDeletionDetectionPolicyUnion): DataDeletionDetectionPolicy | undefined;
export declare function convertKnowledgeBaseToPublic(knowledgeBase: GeneratedKnowledgeBase | undefined): KnowledgeBase;
export declare function convertKnowledgeBaseToGenerated(knowledgeBase: KnowledgeBase | undefined): GeneratedKnowledgeBase | undefined;
export declare function convertKnowledgeSourceToPublic(knowledgeSource: GeneratedKnowledgeSource): KnowledgeSource | undefined;
export declare function convertKnowledgeSourceToGenerated(knowledgeSource: KnowledgeSource | undefined): GeneratedKnowledgeSource | undefined;
export declare function mapPagedAsyncIterable<T, U>(iter: PagedAsyncIterableIterator<T>, mapper: (x: T) => U): PagedAsyncIterableIterator<U>;
/**
 * Converts public IndexDocumentsAction format to generated IndexAction format.
 * The public API uses `__actionType` with document properties spread at the root,
 * while the generated API expects `actionType` with document properties in `additionalProperties`.
 * @internal
 */
export declare function convertPublicActionsToGeneratedActions<TModel extends {
    __actionType: IndexActionType;
}>(actions: Array<TModel>): IndexAction[];
/**
 * Converts a generated FacetResult to a public FacetResult with additionalProperties spread
 * onto the object for backward compatibility.
 * @internal
 */
export declare function convertGeneratedFacetResultToPublic(facetResult: GeneratedFacetResult): FacetResult;
/**
 * Converts a record of FacetResult arrays from generated to public format.
 * @internal
 */
export declare function convertGeneratedFacetsToPublic(facets: Record<string, GeneratedFacetResult[]> | undefined): Record<string, FacetResult[]> | undefined;
/**
 * Converts a generated QueryAnswerResult to a public QueryAnswerResult with additionalProperties spread
 * onto the object for backward compatibility.
 * @internal
 */
export declare function convertGeneratedQueryAnswerResultToPublic(answerResult: GeneratedQueryAnswerResult): QueryAnswerResult;
/**
 * Converts an array of QueryAnswerResult from generated to public format.
 * @internal
 */
export declare function convertGeneratedAnswersToPublic(answers: GeneratedQueryAnswerResult[] | undefined): QueryAnswerResult[] | undefined;
/**
 * Converts a generated QueryCaptionResult to a public QueryCaptionResult with additionalProperties spread
 * onto the object for backward compatibility.
 * @internal
 */
export declare function convertGeneratedQueryCaptionResultToPublic(captionResult: GeneratedQueryCaptionResult): QueryCaptionResult;
/**
 * Converts an array of QueryCaptionResult from generated to public format.
 * @internal
 */
export declare function convertGeneratedCaptionsToPublic(captions: GeneratedQueryCaptionResult[] | undefined): QueryCaptionResult[] | undefined;
//# sourceMappingURL=serviceUtils.d.ts.map