UNPKG

@azure/search-documents

Version:

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

1,719 lines (1,718 loc) 178 kB
/* * Copyright (c) Microsoft Corporation. * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export const SearchIndexerDataSource = { type: { name: "Composite", className: "SearchIndexerDataSource", modelProperties: { name: { serializedName: "name", required: true, type: { name: "String", }, }, description: { serializedName: "description", type: { name: "String", }, }, type: { serializedName: "type", required: true, type: { name: "String", }, }, credentials: { serializedName: "credentials", type: { name: "Composite", className: "DataSourceCredentials", }, }, container: { serializedName: "container", type: { name: "Composite", className: "SearchIndexerDataContainer", }, }, dataChangeDetectionPolicy: { serializedName: "dataChangeDetectionPolicy", type: { name: "Composite", className: "DataChangeDetectionPolicy", }, }, dataDeletionDetectionPolicy: { serializedName: "dataDeletionDetectionPolicy", type: { name: "Composite", className: "DataDeletionDetectionPolicy", }, }, etag: { serializedName: "@odata\\.etag", type: { name: "String", }, }, encryptionKey: { serializedName: "encryptionKey", type: { name: "Composite", className: "SearchResourceEncryptionKey", }, }, }, }, }; export const DataSourceCredentials = { type: { name: "Composite", className: "DataSourceCredentials", modelProperties: { connectionString: { serializedName: "connectionString", type: { name: "String", }, }, }, }, }; export const SearchIndexerDataContainer = { type: { name: "Composite", className: "SearchIndexerDataContainer", modelProperties: { name: { serializedName: "name", required: true, type: { name: "String", }, }, query: { serializedName: "query", type: { name: "String", }, }, }, }, }; export const DataChangeDetectionPolicy = { type: { name: "Composite", className: "DataChangeDetectionPolicy", uberParent: "DataChangeDetectionPolicy", polymorphicDiscriminator: { serializedName: "@odata\\.type", clientName: "odatatype", }, modelProperties: { odatatype: { serializedName: "@odata\\.type", required: true, type: { name: "String", }, }, }, }, }; export const DataDeletionDetectionPolicy = { type: { name: "Composite", className: "DataDeletionDetectionPolicy", uberParent: "DataDeletionDetectionPolicy", polymorphicDiscriminator: { serializedName: "@odata\\.type", clientName: "odatatype", }, modelProperties: { odatatype: { serializedName: "@odata\\.type", required: true, type: { name: "String", }, }, }, }, }; export const SearchResourceEncryptionKey = { type: { name: "Composite", className: "SearchResourceEncryptionKey", modelProperties: { keyName: { serializedName: "keyVaultKeyName", required: true, type: { name: "String", }, }, keyVersion: { serializedName: "keyVaultKeyVersion", required: true, type: { name: "String", }, }, vaultUri: { serializedName: "keyVaultUri", required: true, type: { name: "String", }, }, accessCredentials: { serializedName: "accessCredentials", type: { name: "Composite", className: "AzureActiveDirectoryApplicationCredentials", }, }, }, }, }; export const AzureActiveDirectoryApplicationCredentials = { type: { name: "Composite", className: "AzureActiveDirectoryApplicationCredentials", modelProperties: { applicationId: { serializedName: "applicationId", required: true, type: { name: "String", }, }, applicationSecret: { serializedName: "applicationSecret", type: { name: "String", }, }, }, }, }; export const ErrorResponse = { type: { name: "Composite", className: "ErrorResponse", modelProperties: { error: { serializedName: "error", type: { name: "Composite", className: "ErrorDetail", }, }, }, }, }; export const ErrorDetail = { type: { name: "Composite", className: "ErrorDetail", modelProperties: { code: { serializedName: "code", readOnly: true, type: { name: "String", }, }, message: { serializedName: "message", readOnly: true, type: { name: "String", }, }, target: { serializedName: "target", readOnly: true, type: { name: "String", }, }, details: { serializedName: "details", readOnly: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "ErrorDetail", }, }, }, }, additionalInfo: { serializedName: "additionalInfo", readOnly: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "ErrorAdditionalInfo", }, }, }, }, }, }, }; export const ErrorAdditionalInfo = { type: { name: "Composite", className: "ErrorAdditionalInfo", modelProperties: { type: { serializedName: "type", readOnly: true, type: { name: "String", }, }, info: { serializedName: "info", readOnly: true, type: { name: "Dictionary", value: { type: { name: "any" } }, }, }, }, }, }; export const ListDataSourcesResult = { type: { name: "Composite", className: "ListDataSourcesResult", modelProperties: { dataSources: { serializedName: "value", required: true, readOnly: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexerDataSource", }, }, }, }, }, }, }; export const SearchIndexer = { type: { name: "Composite", className: "SearchIndexer", modelProperties: { name: { serializedName: "name", required: true, type: { name: "String", }, }, description: { serializedName: "description", type: { name: "String", }, }, dataSourceName: { serializedName: "dataSourceName", required: true, type: { name: "String", }, }, skillsetName: { serializedName: "skillsetName", type: { name: "String", }, }, targetIndexName: { serializedName: "targetIndexName", required: true, type: { name: "String", }, }, schedule: { serializedName: "schedule", type: { name: "Composite", className: "IndexingSchedule", }, }, parameters: { serializedName: "parameters", type: { name: "Composite", className: "IndexingParameters", }, }, fieldMappings: { serializedName: "fieldMappings", type: { name: "Sequence", element: { type: { name: "Composite", className: "FieldMapping", }, }, }, }, outputFieldMappings: { serializedName: "outputFieldMappings", type: { name: "Sequence", element: { type: { name: "Composite", className: "FieldMapping", }, }, }, }, isDisabled: { defaultValue: false, serializedName: "disabled", nullable: true, type: { name: "Boolean", }, }, etag: { serializedName: "@odata\\.etag", type: { name: "String", }, }, encryptionKey: { serializedName: "encryptionKey", type: { name: "Composite", className: "SearchResourceEncryptionKey", }, }, }, }, }; export const IndexingSchedule = { type: { name: "Composite", className: "IndexingSchedule", modelProperties: { interval: { serializedName: "interval", required: true, type: { name: "TimeSpan", }, }, startTime: { serializedName: "startTime", type: { name: "DateTime", }, }, }, }, }; export const IndexingParameters = { type: { name: "Composite", className: "IndexingParameters", modelProperties: { batchSize: { serializedName: "batchSize", nullable: true, type: { name: "Number", }, }, maxFailedItems: { defaultValue: 0, serializedName: "maxFailedItems", nullable: true, type: { name: "Number", }, }, maxFailedItemsPerBatch: { defaultValue: 0, serializedName: "maxFailedItemsPerBatch", nullable: true, type: { name: "Number", }, }, configuration: { serializedName: "configuration", type: { name: "Composite", className: "IndexingParametersConfiguration", }, }, }, }, }; export const IndexingParametersConfiguration = { type: { name: "Composite", className: "IndexingParametersConfiguration", additionalProperties: { type: { name: "Object" } }, modelProperties: { parsingMode: { defaultValue: "default", serializedName: "parsingMode", type: { name: "String", }, }, excludedFileNameExtensions: { defaultValue: "", serializedName: "excludedFileNameExtensions", type: { name: "String", }, }, indexedFileNameExtensions: { defaultValue: "", serializedName: "indexedFileNameExtensions", type: { name: "String", }, }, failOnUnsupportedContentType: { defaultValue: false, serializedName: "failOnUnsupportedContentType", type: { name: "Boolean", }, }, failOnUnprocessableDocument: { defaultValue: false, serializedName: "failOnUnprocessableDocument", type: { name: "Boolean", }, }, indexStorageMetadataOnlyForOversizedDocuments: { defaultValue: false, serializedName: "indexStorageMetadataOnlyForOversizedDocuments", type: { name: "Boolean", }, }, delimitedTextHeaders: { serializedName: "delimitedTextHeaders", type: { name: "String", }, }, delimitedTextDelimiter: { serializedName: "delimitedTextDelimiter", type: { name: "String", }, }, firstLineContainsHeaders: { defaultValue: true, serializedName: "firstLineContainsHeaders", type: { name: "Boolean", }, }, documentRoot: { serializedName: "documentRoot", type: { name: "String", }, }, dataToExtract: { defaultValue: "contentAndMetadata", serializedName: "dataToExtract", type: { name: "String", }, }, imageAction: { defaultValue: "none", serializedName: "imageAction", type: { name: "String", }, }, allowSkillsetToReadFileData: { defaultValue: false, serializedName: "allowSkillsetToReadFileData", type: { name: "Boolean", }, }, pdfTextRotationAlgorithm: { defaultValue: "none", serializedName: "pdfTextRotationAlgorithm", type: { name: "String", }, }, executionEnvironment: { defaultValue: "standard", serializedName: "executionEnvironment", type: { name: "String", }, }, queryTimeout: { defaultValue: "00:05:00", serializedName: "queryTimeout", type: { name: "String", }, }, }, }, }; export const FieldMapping = { type: { name: "Composite", className: "FieldMapping", modelProperties: { sourceFieldName: { serializedName: "sourceFieldName", required: true, type: { name: "String", }, }, targetFieldName: { serializedName: "targetFieldName", type: { name: "String", }, }, mappingFunction: { serializedName: "mappingFunction", type: { name: "Composite", className: "FieldMappingFunction", }, }, }, }, }; export const FieldMappingFunction = { type: { name: "Composite", className: "FieldMappingFunction", modelProperties: { name: { serializedName: "name", required: true, type: { name: "String", }, }, parameters: { serializedName: "parameters", nullable: true, type: { name: "Dictionary", value: { type: { name: "any" } }, }, }, }, }, }; export const ListIndexersResult = { type: { name: "Composite", className: "ListIndexersResult", modelProperties: { indexers: { serializedName: "value", required: true, readOnly: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexer", }, }, }, }, }, }, }; export const SearchIndexerStatus = { type: { name: "Composite", className: "SearchIndexerStatus", modelProperties: { status: { serializedName: "status", required: true, readOnly: true, type: { name: "Enum", allowedValues: ["unknown", "error", "running"], }, }, lastResult: { serializedName: "lastResult", type: { name: "Composite", className: "IndexerExecutionResult", }, }, executionHistory: { serializedName: "executionHistory", required: true, readOnly: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "IndexerExecutionResult", }, }, }, }, limits: { serializedName: "limits", type: { name: "Composite", className: "SearchIndexerLimits", }, }, }, }, }; export const IndexerExecutionResult = { type: { name: "Composite", className: "IndexerExecutionResult", modelProperties: { status: { serializedName: "status", required: true, readOnly: true, type: { name: "Enum", allowedValues: ["transientFailure", "success", "inProgress", "reset"], }, }, errorMessage: { serializedName: "errorMessage", readOnly: true, type: { name: "String", }, }, startTime: { serializedName: "startTime", readOnly: true, type: { name: "DateTime", }, }, endTime: { serializedName: "endTime", readOnly: true, nullable: true, type: { name: "DateTime", }, }, errors: { serializedName: "errors", required: true, readOnly: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexerError", }, }, }, }, warnings: { serializedName: "warnings", required: true, readOnly: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexerWarning", }, }, }, }, itemCount: { serializedName: "itemsProcessed", required: true, readOnly: true, type: { name: "Number", }, }, failedItemCount: { serializedName: "itemsFailed", required: true, readOnly: true, type: { name: "Number", }, }, initialTrackingState: { serializedName: "initialTrackingState", readOnly: true, type: { name: "String", }, }, finalTrackingState: { serializedName: "finalTrackingState", readOnly: true, type: { name: "String", }, }, }, }, }; export const SearchIndexerError = { type: { name: "Composite", className: "SearchIndexerError", modelProperties: { key: { serializedName: "key", readOnly: true, type: { name: "String", }, }, errorMessage: { serializedName: "errorMessage", required: true, readOnly: true, type: { name: "String", }, }, statusCode: { serializedName: "statusCode", required: true, readOnly: true, type: { name: "Number", }, }, name: { serializedName: "name", readOnly: true, type: { name: "String", }, }, details: { serializedName: "details", readOnly: true, type: { name: "String", }, }, documentationLink: { serializedName: "documentationLink", readOnly: true, type: { name: "String", }, }, }, }, }; export const SearchIndexerWarning = { type: { name: "Composite", className: "SearchIndexerWarning", modelProperties: { key: { serializedName: "key", readOnly: true, type: { name: "String", }, }, message: { serializedName: "message", required: true, readOnly: true, type: { name: "String", }, }, name: { serializedName: "name", readOnly: true, type: { name: "String", }, }, details: { serializedName: "details", readOnly: true, type: { name: "String", }, }, documentationLink: { serializedName: "documentationLink", readOnly: true, type: { name: "String", }, }, }, }, }; export const SearchIndexerLimits = { type: { name: "Composite", className: "SearchIndexerLimits", modelProperties: { maxRunTime: { serializedName: "maxRunTime", readOnly: true, type: { name: "TimeSpan", }, }, maxDocumentExtractionSize: { serializedName: "maxDocumentExtractionSize", readOnly: true, type: { name: "Number", }, }, maxDocumentContentCharactersToExtract: { serializedName: "maxDocumentContentCharactersToExtract", readOnly: true, type: { name: "Number", }, }, }, }, }; export const SearchIndexerSkillset = { type: { name: "Composite", className: "SearchIndexerSkillset", modelProperties: { name: { serializedName: "name", required: true, type: { name: "String", }, }, description: { serializedName: "description", type: { name: "String", }, }, skills: { serializedName: "skills", required: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexerSkill", }, }, }, }, cognitiveServicesAccount: { serializedName: "cognitiveServices", type: { name: "Composite", className: "CognitiveServicesAccount", }, }, knowledgeStore: { serializedName: "knowledgeStore", type: { name: "Composite", className: "SearchIndexerKnowledgeStore", }, }, indexProjection: { serializedName: "indexProjections", type: { name: "Composite", className: "SearchIndexerIndexProjection", }, }, etag: { serializedName: "@odata\\.etag", type: { name: "String", }, }, encryptionKey: { serializedName: "encryptionKey", type: { name: "Composite", className: "SearchResourceEncryptionKey", }, }, }, }, }; export const SearchIndexerSkill = { type: { name: "Composite", className: "SearchIndexerSkill", uberParent: "SearchIndexerSkill", polymorphicDiscriminator: { serializedName: "@odata\\.type", clientName: "odatatype", }, modelProperties: { odatatype: { serializedName: "@odata\\.type", required: true, type: { name: "String", }, }, name: { serializedName: "name", type: { name: "String", }, }, description: { serializedName: "description", type: { name: "String", }, }, context: { serializedName: "context", type: { name: "String", }, }, inputs: { serializedName: "inputs", required: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "InputFieldMappingEntry", }, }, }, }, outputs: { serializedName: "outputs", required: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "OutputFieldMappingEntry", }, }, }, }, }, }, }; export const InputFieldMappingEntry = { type: { name: "Composite", className: "InputFieldMappingEntry", modelProperties: { name: { serializedName: "name", required: true, type: { name: "String", }, }, source: { serializedName: "source", type: { name: "String", }, }, sourceContext: { serializedName: "sourceContext", type: { name: "String", }, }, inputs: { serializedName: "inputs", type: { name: "Sequence", element: { type: { name: "Composite", className: "InputFieldMappingEntry", }, }, }, }, }, }, }; export const OutputFieldMappingEntry = { type: { name: "Composite", className: "OutputFieldMappingEntry", modelProperties: { name: { serializedName: "name", required: true, type: { name: "String", }, }, targetName: { serializedName: "targetName", type: { name: "String", }, }, }, }, }; export const CognitiveServicesAccount = { type: { name: "Composite", className: "CognitiveServicesAccount", uberParent: "CognitiveServicesAccount", polymorphicDiscriminator: { serializedName: "@odata\\.type", clientName: "odatatype", }, modelProperties: { odatatype: { serializedName: "@odata\\.type", required: true, type: { name: "String", }, }, description: { serializedName: "description", type: { name: "String", }, }, }, }, }; export const SearchIndexerKnowledgeStore = { type: { name: "Composite", className: "SearchIndexerKnowledgeStore", modelProperties: { storageConnectionString: { serializedName: "storageConnectionString", required: true, type: { name: "String", }, }, projections: { serializedName: "projections", required: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexerKnowledgeStoreProjection", }, }, }, }, }, }, }; export const SearchIndexerKnowledgeStoreProjection = { type: { name: "Composite", className: "SearchIndexerKnowledgeStoreProjection", modelProperties: { tables: { serializedName: "tables", type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexerKnowledgeStoreTableProjectionSelector", }, }, }, }, objects: { serializedName: "objects", type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexerKnowledgeStoreObjectProjectionSelector", }, }, }, }, files: { serializedName: "files", type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexerKnowledgeStoreFileProjectionSelector", }, }, }, }, }, }, }; export const SearchIndexerKnowledgeStoreProjectionSelector = { type: { name: "Composite", className: "SearchIndexerKnowledgeStoreProjectionSelector", modelProperties: { referenceKeyName: { serializedName: "referenceKeyName", type: { name: "String", }, }, generatedKeyName: { serializedName: "generatedKeyName", type: { name: "String", }, }, source: { serializedName: "source", type: { name: "String", }, }, sourceContext: { serializedName: "sourceContext", type: { name: "String", }, }, inputs: { serializedName: "inputs", type: { name: "Sequence", element: { type: { name: "Composite", className: "InputFieldMappingEntry", }, }, }, }, }, }, }; export const SearchIndexerIndexProjection = { type: { name: "Composite", className: "SearchIndexerIndexProjection", modelProperties: { selectors: { serializedName: "selectors", required: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexerIndexProjectionSelector", }, }, }, }, parameters: { serializedName: "parameters", type: { name: "Composite", className: "SearchIndexerIndexProjectionParameters", }, }, }, }, }; export const SearchIndexerIndexProjectionSelector = { type: { name: "Composite", className: "SearchIndexerIndexProjectionSelector", modelProperties: { targetIndexName: { serializedName: "targetIndexName", required: true, type: { name: "String", }, }, parentKeyFieldName: { serializedName: "parentKeyFieldName", required: true, type: { name: "String", }, }, sourceContext: { serializedName: "sourceContext", required: true, type: { name: "String", }, }, mappings: { serializedName: "mappings", required: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "InputFieldMappingEntry", }, }, }, }, }, }, }; export const SearchIndexerIndexProjectionParameters = { type: { name: "Composite", className: "SearchIndexerIndexProjectionParameters", additionalProperties: { type: { name: "Object" } }, modelProperties: { projectionMode: { serializedName: "projectionMode", type: { name: "String", }, }, }, }, }; export const ListSkillsetsResult = { type: { name: "Composite", className: "ListSkillsetsResult", modelProperties: { skillsets: { serializedName: "value", required: true, readOnly: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchIndexerSkillset", }, }, }, }, }, }, }; export const SynonymMap = { type: { name: "Composite", className: "SynonymMap", modelProperties: { name: { serializedName: "name", required: true, type: { name: "String", }, }, format: { defaultValue: "solr", isConstant: true, serializedName: "format", type: { name: "String", }, }, synonyms: { serializedName: "synonyms", required: true, type: { name: "String", }, }, encryptionKey: { serializedName: "encryptionKey", type: { name: "Composite", className: "SearchResourceEncryptionKey", }, }, etag: { serializedName: "@odata\\.etag", type: { name: "String", }, }, }, }, }; export const ListSynonymMapsResult = { type: { name: "Composite", className: "ListSynonymMapsResult", modelProperties: { synonymMaps: { serializedName: "value", required: true, readOnly: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "SynonymMap", }, }, }, }, }, }, }; export const SearchIndex = { type: { name: "Composite", className: "SearchIndex", modelProperties: { name: { serializedName: "name", required: true, type: { name: "String", }, }, fields: { serializedName: "fields", required: true, type: { name: "Sequence", element: { type: { name: "Composite", className: "SearchField", }, }, }, }, scoringProfiles: { serializedName: "scoringProfiles", type: { name: "Sequence", element: { type: { name: "Composite", className: "ScoringProfile", }, }, }, }, defaultScoringProfile: { serializedName: "defaultScoringProfile", type: { name: "String", }, }, corsOptions: { serializedName: "corsOptions", type: { name: "Composite", className: "CorsOptions", }, }, suggesters: { serializedName: "suggesters", type: { name: "Sequence", element: { type: { name: "Composite", className: "Suggester", }, }, }, }, analyzers: { serializedName: "analyzers", type: { name: "Sequence", element: { type: { name: "Composite", className: "LexicalAnalyzer", }, }, }, }, tokenizers: { serializedName: "tokenizers", type: { name: "Sequence", element: { type: { name: "Composite", className: "LexicalTokenizer", }, }, }, }, tokenFilters: { serializedName: "tokenFilters", type: { name: "Sequence", element: { type: { name: "Composite", className: "TokenFilter", }, }, }, }, charFilters: { serializedName: "charFilters", type: { name: "Sequence", element: { type: { name: "Composite", className: "CharFilter", }, }, }, }, encryptionKey: { serializedName: "encryptionKey", type: { name: "Composite", className: "SearchResourceEncryptionKey", }, }, similarity: { serializedName: "similarity", type: { name: "Composite", className: "Similarity", }, }, semanticSearch: { serializedName: "semantic", type: { name: "Composite", className: "SemanticSearch", }, }, vectorSearch: { serializedName: "vectorSearch", type: { name: "Composite", className: "VectorSearch", }, }, etag: { serializedName: "@odata\\.etag", type: { name: "String", }, }, }, }, }; export const SearchField = { type: { name: "Composite", className: "SearchField", modelProperties: { name: { serializedName: "name", required: true, type: { name: "String", }, }, type: { serializedName: "type", required: true, type: { name: "String", }, }, key: { serializedName: "key", type: { name: "Boolean", }, }, retrievable: { serializedName: "retrievable", type: { name: "Boolean", }, }, stored: { serializedName: "stored", type: { name: "Boolean", }, }, searchable: { serializedName: "searchable", type: { name: "Boolean", }, }, filterable: { serializedName: "filterable", type: { name: "Boolean", }, }, sortable: { serializedName: "sortable", type: { name: "Boolean", }, }, facetable: { serializedName: "facetable", type: { name: "Boolean", }, }, analyzer: { serializedName: "analyzer", nullable: true, type: { name: "String", }, }, searchAnalyzer: { serializedName: "searchAnalyzer", nullable: true, type: { name: "String", }, }, indexAnalyzer: { serializedName: "indexAnalyzer", nullable: true, type: { name: "String", }, }, vectorSearchDimensions: { constraints: { InclusiveMaximum: 2048, InclusiveMinimum: 2, }, serializedName: "dimensions", nullable: true, type: { name: "Number", }, }, vectorSearchProfileName: { serializedName: "vectorSearchProfile", nullable: true, type: { name: "String", }, }, vectorEncodingFormat: { serializedName: "vectorEncoding", nullable: true, type: { name: "String", }, }, synonymMaps: { serializedName: "synonymMaps", type: { name: "Sequence", element: { type: { name: "String", }, }, }, }, fields: { serializedName: "fields", type: { name: "Sequence", element: { type: { name: "Composite",