SearchServiceLimits Class

Represents various service level limits.

Constructor

SearchServiceLimits(*args: Any, **kwargs: Any)

Variables

Name	Description
max_fields_per_index	int The maximum allowed fields per index.
max_field_nesting_depth_per_index	int The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3.
max_complex_collection_fields_per_index	int The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index.
max_complex_objects_in_collections_per_document	int The maximum number of objects in complex collections allowed per document.
max_storage_per_index_in_bytes	int The maximum amount of storage in bytes allowed per index.
max_cumulative_indexer_runtime_seconds	int The maximum cumulative indexer runtime in seconds allowed for the service.
max_vector_index_size_per_index_in_bytes	int The maximum vector index size (vector memory quota) allowed per index in bytes.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from the dictionary.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.
setdefault	Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
update	Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on the mapping's values

Attributes

max_complex_collection_fields_per_index

The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index.

max_complex_collection_fields_per_index: int | None

max_complex_objects_in_collections_per_document

The maximum number of objects in complex collections allowed per document.

max_complex_objects_in_collections_per_document: int | None

max_cumulative_indexer_runtime_seconds

The maximum cumulative indexer runtime in seconds allowed for the service.

max_cumulative_indexer_runtime_seconds: int | None

max_field_nesting_depth_per_index

The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3.

max_field_nesting_depth_per_index: int | None

max_fields_per_index

The maximum allowed fields per index.

max_fields_per_index: int | None

max_storage_per_index_in_bytes

The maximum amount of storage in bytes allowed per index.

max_storage_per_index_in_bytes: int | None

max_vector_index_size_per_index_in_bytes

The maximum vector index size (vector memory quota) allowed per index in bytes.

max_vector_index_size_per_index_in_bytes: int | None

Feedback

Was this page helpful?