SearchService interface

Pakiet:

@azure/arm-search

Opisuje usługę Wyszukiwanie AI platformy Azure oraz jej obecny stan.

Rozszerzenie

TrackedResource

Właściwości

authOptions	Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli parametr "disableLocalAuth" ma wartość true.
computeType	Skonfiguruj tę właściwość tak, aby wspierała usługę wyszukiwania za pomocą Default Compute lub Azure Confidential Compute.
dataExfiltrationProtections	Lista scenariuszy eksfiltracji danych, które są jawnie niedozwolone dla usługi wyszukiwania. Obecnie jedyną obsługiwaną wartością jest "Wszystkie", aby wyłączyć wszystkie możliwe scenariusze eksportu danych z bardziej precyzyjnymi kontrolkami zaplanowanymi na przyszłość.
disableLocalAuth	Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły korzystać z kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions".
encryptionWithCmk	Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania.
endpoint	Punkt końcowy usługi Wyszukiwanie AI platformy Azure.
eTag	Właściwość wygenerowana przez system reprezentująca element etag usługi, który może być przeznaczony do optymistycznej kontroli współbieżności podczas aktualizacji.
hostingMode	Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które zezwalają na maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU standard3 wartość to "Default" lub "HighDensity". W przypadku wszystkich innych jednostek SKU ta wartość musi mieć wartość "Domyślna".
identity	Tożsamość zasobu.
knowledgeRetrieval	Określa plan rozliczeń dla wyszukiwania agentycznego w usłudze Wyszukiwanie AI platformy Azure. Ta konfiguracja jest dostępna tylko dla określonych poziomów cenowych w określonych regionach.
networkRuleSet	Zasady specyficzne dla sieci, które określają, jak można dotrzeć do usługi Wyszukiwanie AI platformy Azure.
partitionCount	Liczba partycji w dedykowanej usłudze wyszukiwania; jeśli jest to określone, może to być 1, 2, 3, 4, 6 lub 12. Wartości większe niż 1 są prawidłowe tylko dla standardowych jednostek SKU. W przypadku usług "standard3" z hostMode ustawionym na wartość "highDensity" dozwolone wartości to od 1 do 3.
privateEndpointConnections	Lista prywatnych połączeń końcowych z usługą Wyszukiwanie AI platformy Azure.
provisioningState	Stan ostatniej operacji aprowizacji wykonanej w usłudze wyszukiwania. Aprowizowanie jest stanem pośrednim, który występuje podczas ustanawiania pojemności usługi. Po skonfigurowaniu pojemności provisioningState zmieni się na "Powodzenie" lub "Niepowodzenie". Aplikacje klienckie mogą sondować stan aprowizacji (zalecany interwał sondowania wynosi od 30 sekund do jednej minuty) przy użyciu operacji Pobierz usługę wyszukiwania, aby sprawdzić, kiedy operacja zostanie ukończona. Jeśli używasz bezpłatnej usługi, ta wartość ma tendencję do powrotu jako "Powodzenie" bezpośrednio w wywołaniu do tworzenia usługi wyszukiwania. Dzieje się tak, ponieważ bezpłatna usługa używa już skonfigurowanej pojemności.
publicNetworkAccess	Tę wartość można ustawić na wartość "Włączone", aby uniknąć zmian powodujących niezgodność w istniejących zasobach i szablonach klienta. W przypadku ustawienia opcji "Wyłączone" ruch przez interfejs publiczny nie jest dozwolony, a połączenia z prywatnymi punktami końcowymi będą wyłączną metodą dostępu.
replicaCount	Liczba replik w dedykowanej usłudze wyszukiwania. W przypadku określenia musi to być wartość z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU.
semanticSearch	Określa dostępność i plan rozliczeń dla wyszukiwania semantycznego w usłudze Wyszukiwanie AI platformy Azure. Ta konfiguracja jest dostępna tylko dla określonych poziomów cenowych w określonych regionach.
serviceUpgradedAt	Data i godzina ostatniego uaktualnienia usługi wyszukiwania. To pole będzie mieć wartość null, dopóki usługa nie zostanie uaktualniona po raz pierwszy.
sharedPrivateLinkResources	Lista współdzielonych zasobów prywatnych linków zarządzanych przez usługę Wyszukiwanie AI platformy Azure.
sku	Jednostka SKU usługi wyszukiwania, która określa warstwę cenową i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania.
status	Stan usługi wyszukiwania. Możliwe wartości obejmują: "uruchomiono": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "provisioning": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": obniżona wydajność usługi wyszukiwania. Taka sytuacja może wystąpić, gdy bazowe jednostki wyszukiwania nie są w dobrej kondycji. Usługa wyszukiwania najprawdopodobniej działa, ale wydajność może być niska, a niektóre żądania mogą zostać usunięte. "disabled": usługa wyszukiwania jest wyłączona. W tym stanie usługa odrzuci wszystkie żądania interfejsu API. "błąd": usługa wyszukiwania jest w stanie błędu. "Zatrzymano": usługa wyszukiwania znajduje się w subskrypcji, która jest wyłączona. Jeśli Twoja usługa znajduje się w stanie degradacji, wyłączenia lub błędu, oznacza to, że zespół Wyszukiwanie AI platformy Azure aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych jednostek wyszukiwania.
statusDetails	Szczegóły stanu usługi wyszukiwania.
upgradeAvailable	Wskazuje, czy usługa wyszukiwania ma dostępne uaktualnienie.

Właściwości dziedziczone

id	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	Lokalizacja geograficzna, w której znajduje się zasób
name	Nazwa zasobu
systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	Tagi zasobów.
type	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

Szczegóły właściwości

authOptions

Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli parametr "disableLocalAuth" ma wartość true.

authOptions?: DataPlaneAuthOptions

Wartość właściwości

DataPlaneAuthOptions

computeType

Skonfiguruj tę właściwość tak, aby wspierała usługę wyszukiwania za pomocą Default Compute lub Azure Confidential Compute.

computeType?: string

Wartość właściwości

string

dataExfiltrationProtections

Lista scenariuszy eksfiltracji danych, które są jawnie niedozwolone dla usługi wyszukiwania. Obecnie jedyną obsługiwaną wartością jest "Wszystkie", aby wyłączyć wszystkie możliwe scenariusze eksportu danych z bardziej precyzyjnymi kontrolkami zaplanowanymi na przyszłość.

dataExfiltrationProtections?: string[]

Wartość właściwości

string[]

disableLocalAuth

Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły korzystać z kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions".

disableLocalAuth?: boolean

Wartość właściwości

boolean

encryptionWithCmk

Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania.

encryptionWithCmk?: EncryptionWithCmk

Wartość właściwości

EncryptionWithCmk

endpoint

Punkt końcowy usługi Wyszukiwanie AI platformy Azure.

endpoint?: string

Wartość właściwości

string

eTag

Właściwość wygenerowana przez system reprezentująca element etag usługi, który może być przeznaczony do optymistycznej kontroli współbieżności podczas aktualizacji.

eTag?: string

Wartość właściwości

string

hostingMode

Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które zezwalają na maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU standard3 wartość to "Default" lub "HighDensity". W przypadku wszystkich innych jednostek SKU ta wartość musi mieć wartość "Domyślna".

hostingMode?: HostingMode

Wartość właściwości

HostingMode

identity

Tożsamość zasobu.

identity?: Identity

Wartość właściwości

Identity

knowledgeRetrieval

Określa plan rozliczeń dla wyszukiwania agentycznego w usłudze Wyszukiwanie AI platformy Azure. Ta konfiguracja jest dostępna tylko dla określonych poziomów cenowych w określonych regionach.

knowledgeRetrieval?: string

Wartość właściwości

string

networkRuleSet

Zasady specyficzne dla sieci, które określają, jak można dotrzeć do usługi Wyszukiwanie AI platformy Azure.

networkRuleSet?: NetworkRuleSet

Wartość właściwości

NetworkRuleSet

partitionCount

Liczba partycji w dedykowanej usłudze wyszukiwania; jeśli jest to określone, może to być 1, 2, 3, 4, 6 lub 12. Wartości większe niż 1 są prawidłowe tylko dla standardowych jednostek SKU. W przypadku usług "standard3" z hostMode ustawionym na wartość "highDensity" dozwolone wartości to od 1 do 3.

partitionCount?: number

Wartość właściwości

number

privateEndpointConnections

Lista prywatnych połączeń końcowych z usługą Wyszukiwanie AI platformy Azure.

privateEndpointConnections?: PrivateEndpointConnection[]

Wartość właściwości

PrivateEndpointConnection[]

provisioningState

Stan ostatniej operacji aprowizacji wykonanej w usłudze wyszukiwania. Aprowizowanie jest stanem pośrednim, który występuje podczas ustanawiania pojemności usługi. Po skonfigurowaniu pojemności provisioningState zmieni się na "Powodzenie" lub "Niepowodzenie". Aplikacje klienckie mogą sondować stan aprowizacji (zalecany interwał sondowania wynosi od 30 sekund do jednej minuty) przy użyciu operacji Pobierz usługę wyszukiwania, aby sprawdzić, kiedy operacja zostanie ukończona. Jeśli używasz bezpłatnej usługi, ta wartość ma tendencję do powrotu jako "Powodzenie" bezpośrednio w wywołaniu do tworzenia usługi wyszukiwania. Dzieje się tak, ponieważ bezpłatna usługa używa już skonfigurowanej pojemności.

provisioningState?: ProvisioningState

Wartość właściwości

ProvisioningState

publicNetworkAccess

Tę wartość można ustawić na wartość "Włączone", aby uniknąć zmian powodujących niezgodność w istniejących zasobach i szablonach klienta. W przypadku ustawienia opcji "Wyłączone" ruch przez interfejs publiczny nie jest dozwolony, a połączenia z prywatnymi punktami końcowymi będą wyłączną metodą dostępu.

publicNetworkAccess?: string

Wartość właściwości

string

replicaCount

Liczba replik w dedykowanej usłudze wyszukiwania. W przypadku określenia musi to być wartość z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU.

replicaCount?: number

Wartość właściwości

number

semanticSearch

Określa dostępność i plan rozliczeń dla wyszukiwania semantycznego w usłudze Wyszukiwanie AI platformy Azure. Ta konfiguracja jest dostępna tylko dla określonych poziomów cenowych w określonych regionach.

semanticSearch?: string

Wartość właściwości

string

serviceUpgradedAt

Data i godzina ostatniego uaktualnienia usługi wyszukiwania. To pole będzie mieć wartość null, dopóki usługa nie zostanie uaktualniona po raz pierwszy.

serviceUpgradedAt?: Date

Wartość właściwości

Date

sharedPrivateLinkResources

Lista współdzielonych zasobów prywatnych linków zarządzanych przez usługę Wyszukiwanie AI platformy Azure.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Wartość właściwości

SharedPrivateLinkResource[]

sku

Jednostka SKU usługi wyszukiwania, która określa warstwę cenową i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania.

sku?: Sku

Wartość właściwości

Sku

status

Stan usługi wyszukiwania. Możliwe wartości obejmują: "uruchomiono": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "provisioning": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": obniżona wydajność usługi wyszukiwania. Taka sytuacja może wystąpić, gdy bazowe jednostki wyszukiwania nie są w dobrej kondycji. Usługa wyszukiwania najprawdopodobniej działa, ale wydajność może być niska, a niektóre żądania mogą zostać usunięte. "disabled": usługa wyszukiwania jest wyłączona. W tym stanie usługa odrzuci wszystkie żądania interfejsu API. "błąd": usługa wyszukiwania jest w stanie błędu. "Zatrzymano": usługa wyszukiwania znajduje się w subskrypcji, która jest wyłączona. Jeśli Twoja usługa znajduje się w stanie degradacji, wyłączenia lub błędu, oznacza to, że zespół Wyszukiwanie AI platformy Azure aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych jednostek wyszukiwania.

status?: SearchServiceStatus

Wartość właściwości

SearchServiceStatus

statusDetails

Szczegóły stanu usługi wyszukiwania.

statusDetails?: string

Wartość właściwości

string

upgradeAvailable

Wskazuje, czy usługa wyszukiwania ma dostępne uaktualnienie.

upgradeAvailable?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

id

W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Wartość właściwości

string

dziedziczone zTrackedResource.id

location

Lokalizacja geograficzna, w której znajduje się zasób

location: string

Wartość właściwości

string

dziedziczone zTrackedResource.location

name

Nazwa zasobu

name?: string

Wartość właściwości

string

dziedziczone zTrackedResource.name

systemData

Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.

systemData?: SystemData

Wartość właściwości

SystemData

dziedziczone zTrackedResource.systemData

tags

Tagi zasobów.

tags?: Record<string, string>

Wartość właściwości

Record<string, string>

dziedziczone zTrackedResource.tags

type

Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

type?: string

Wartość właściwości

string

dziedziczone zTrackedResource.type